Merge pull request #3 from Weesli/master

RGuilds information

astro.config.mjs

@@ -77,6 +77,35 @@ export default defineConfig({
             },
           ],
         },
+        {
+          label: "RGuilds",
+          badge: { text: "New Version", variant: "success" },
+          items: [
+            {
+              slug: "rguilds/info",
+              badge: { text: "?", variant: "default" },
+            },
+            {
+              label: "Features",
+              translations: {
+                tr: "Özellikler",
+              },
+              badge: { text: "⭐", variant: "tip" },
+              collapsed: true,
+              autogenerate: { directory: "rguilds/features" },
+            },
+            {
+              label: "Modules",
+              translations: {
+                tr: "Modüller",
+              },
+              badge: { text: "⭐", variant: "tip" },
+              collapsed: true,
+              autogenerate: { directory: "rguilds/modules"
+              },
+            },
+          ],
+        },
       ],
     }),
   ],

src/content/docs/rguilds/features/gui.md

@@ -0,0 +1,26 @@
+---
+title: GUI
+---
+
+### Guild plugin gui designs
+
+**Images**
+
+
+![new_gui_1](../../../../assets/rguilds/gui/new_gui_1.png)
+![new_gui_2](../../../../assets/rguilds/gui/new_gui_2.png)
+![new_gui_3](../../../../assets/rguilds/gui/new_gui_3.png)
+![new_gui_4](../../../../assets/rguilds/gui/new_gui_4.png)
+![new_gui_5](../../../../assets/rguilds/gui/new_gui_5.png)
+![new_gui_6](../../../../assets/rguilds/gui/new_gui_6.png)
+![new_gui_7](../../../../assets/rguilds/gui/new_gui_7.png)
+![new_gui_8](../../../../assets/rguilds/gui/new_gui_8.png)
+![new_gui_9](../../../../assets/rguilds/gui/new_gui_9.png)
+![new_gui_10](../../../../assets/rguilds/gui/new_gui_10.png)
+![new_gui_11](../../../../assets/rguilds/gui/new_gui_11.png)
+![new_gui_12](../../../../assets/rguilds/gui/new_gui_12.png)
+![new_gui_13](../../../../assets/rguilds/gui/new_gui_13.png)
+![new_gui_14](../../../../assets/rguilds/gui/new_gui_14.png)
+![new_gui_15](../../../../assets/rguilds/gui/new_gui_15.png)
+![new_gui_16](../../../../assets/rguilds/gui/new_gui_16.png)
+![new_gui_17](../../../../assets/rguilds/gui/new_gui_17.png)

src/content/docs/rguilds/features/webhook.md

@@ -0,0 +1,16 @@
+---
+title: 'Discord webhook'
+---
+
+### Webhook system
+
+
+**Details**
+
+- Webhook is in JSON format. Fully customizable.
+
+
+**Images**
+
+![webhook_1](../../../../assets/rguilds/webhooks/webhook_1.png)
+![webhook_2](../../../../assets/rguilds/webhooks/webhook_2.png)

src/content/docs/rguilds/info.md

@@ -0,0 +1,111 @@
+---
+title: "information"
+---
+
+## RGuilds - Advanced Guild Plugin
+
+- Add a unique twist to your server by giving players the chance to create their own guilds!
+
+### Features
+- Fully customizable settings and messages.
+- Set a fee for creating a guild:
+  - Supports Vault, PlayerPoints, or even free options.
+- PlaceholderAPI Support:
+  - Includes a wide variety of placeholders within the plugin!
+- Guild Ranking System:
+  - Three ranks available within a guild: Leader, Moderator, and Member.
+- Cross Server Support:
+  - Fully supports multi-server setups with Redis!
+  - Players can invite each other, send messages across servers, and more.
+- Module Support:
+  - Optional (paid or free) modules available within the plugin.
+- GUI Support:
+  - Many aspects of the plugin are integrated with GUI interfaces.
+  - Offer your players a visually appealing and user-friendly experience.
+  - Supports custom-model-data!
+- Storage:
+  - Supports both SQLite and MySQL.
+- Guild Name Change:
+  - Supports Turkish characters and spaces.
+  - Automatically blocks special characters and punctuation marks.
+- Guild PvP System:
+  - Members can engage in PvP within the guild if the leader permits it.
+- Guild War System:
+  - Guild leaders can declare war on each other, and players can see which guilds are enemies.
+- Guild Level System:
+  - Includes a leveling and XP system within the guild. Unlimited levels can be set.
+  - You can customize how many points are awarded for killing any entity or player.
+  - Set member limits for each level.
+- Guild Banner System:
+  - Guild leaders can choose a banner for their guild, which enemies can see.
+- Discord Webhook Support:
+  - Send a Discord webhook when a guild war is started or ended.
+- Participation with code
+  - The guild leader can create a code for his guild and allow players to join with this code.
+- Customizable Moderator powers
+  - The guild leader can authorize the guild moderators as they wish (invitation, pvp, war, etc.)
+
+
+## GUI design preview
+
+[Preview Video](https://www.youtube.com/watch?v=hsbzZDGteXI)
+
+### Dependencies
+
+- RozsLib - A mandatory library required for the plugin to function!
+- Vault - The main plugin for economy (optional).
+- PlaceholderAPI - Required for RozsLib and the placeholder system within the plugin.
+
+### Commands
+
+**Player Commands**
+
+`/guild create <name>` - Creates a guild.  
+`/guild accept <player>` - Joins the guild of the player who sent the invite.  
+`/guild invite <player>` - Sends an invite to a player.  
+`/guild leave` - Leaves the current guild.  
+`/guild kick <player>` - Kicks a player from the guild.  
+`/guild message <message>` - Sends a message to all guild members.  
+`/guild rename <name>` - Updates the guild's name.  
+`/guild war start/end <name>` - Starts or ends a war with another guild.  
+`/guildwar banner` - Sets the held banner as the guild's banner.
+`/guildwar join <code>` - Join a guild with the specified code.
+
+**Admin Commands**
+
+`/adminclaim delete <guildname>` - Deletes a guild.  
+`/adminclaim show <guildname>` - Displays guild information.  
+`/adminclaim forceleave <player>` - Forces a player to leave their guild.  
+`/adminclaim list` - Displays a list of all guilds.  
+`/adminclaim level set <level> <guild>` - Sets the level of a guild.  
+`/adminguild exp give <amount> <guild>` - Gives XP to a guild.  
+`/adminguild exp take <amount> <guild>` - Takes XP from a guild.
+
+### Permissions
+
+`rguilds.admin` - Basic admin permission.  
+`rguilds.admin.delete` - Required to delete a guild.  
+`rguilds.admin.show` - Required to view guild information.  
+`rguilds.admin.forceleave` - Required to force a player out of a guild.  
+`rguilds.admin.list` - Required to view the list of guilds.  
+`rguilds.admin.level` - Required for guild level commands.  
+`rguilds.admin.exp` - Required for guild XP commands.
+
+### PlaceholderAPI
+
+`%rguilds_formatted_name%` - Guild name (colored and starred)  
+`%rguilds_unformatted_name%` - Guild name (colored and unstarred)  
+`%rguilds_formatted_name_no_color%` - Guild name (no color, but starred)  
+`%rguilds_unformatted_name_no_color%` - Guild name (no color, no stars)  
+`%rguilds_kill_count%` - Guild kill count  
+`%rguilds_level%` - Guild level display name  
+`%rguilds_xp%` - Guild experience points  
+`%rguilds_next_xp%` - Experience points needed for the next level  
+`%rguilds_next_level_unformatted%` - Unformatted next level name  
+`%rguilds_next_level_formatted%` - Display name for the next level  
+`%rguilds_top_xp_<number>_<name/point>%` - Guilds ranked by XP  
+`%rguilds_top_kill_<number>_<name/point>%` - Guilds ranked by kills  
+`%rguilds_kill_count_<guild>%` - Shows a guild's kill count  
+`%rguilds_xp_<guild>%` - Shows a guild's experience points  
+`%rguilds_level_<guild>%` - Shows the display name of a guild's level  
+`%rguilds_level_unformatted_<guild>%` - Shows the unformatted name of a guild's level  

src/content/docs/rguilds/modules/bank.md

@@ -0,0 +1,37 @@
+---
+title: Bank - Guild Bank Module
+---
+
+## Guild Bank Module
+
+### What is it?
+
+- The Guild Bank Module allows guild members to deposit money into a shared guild vault and withdraw funds, effectively creating a common guild bank.
+
+### Features
+
+- The guild leader can set which ranks have permission to withdraw money from the guild bank.
+- The names of members who deposit or withdraw money from the guild bank are visible.
+- PlaceholderAPI support.
+
+### Commands
+
+#### Player Commands
+
+- `/guildbank deposit <amount>` - Deposits a specified amount of money into the guild bank.
+- `/guildbank withdraw <amount>` - Withdraws a specified amount of money from the guild bank.
+- `/guildbank rank <rank>` - Allows the guild leader to set the rank required to withdraw money from the guild bank.
+
+#### Admin Commands
+
+- `/adminguild deletebank <name>` - Deletes the bank of a specified guild.
+- `/adminguild showbalance <name>` - Views the total bank balance of a specified guild.
+
+### PlaceholderAPI
+
+- `%rguilds_balance%` - Displays the balance of the guild bank for the player’s affiliated guild.
+
+### Images
+
+![bank_1](../../../../assets/rguilds/modules/bank/bank_1.png)
+![bank_2](../../../../assets/rguilds/modules/bank/bank_2.png)

src/content/docs/rguilds/modules/guildwar.md

@@ -0,0 +1,39 @@
+---
+title: GuildWar
+---
+
+# GuildWar - Guild Battle
+
+## What is it?
+
+**GuildWar** is an exciting arena battle between two guilds. This system allows guild leaders to face off, increasing competition between guilds.
+
+## Features
+
+- **Unlimited Arena Creation:** Create as many arenas as you need.
+- **Customizable GUI:** Fully customize the user interface.
+- **Command Blocker:** Prevents the use of certain commands during the battle.
+- **Phases:** Systematic battle experience with Preparation, Battle, and End phases.
+- **Glow Effect:** During a guild war, enemy guild players glow red.
+
+## Commands
+
+### Player Commands
+
+- `/guildwar` - Opens the menu for guild battles.
+- `/guildwar join` - Allows players to join the battle after it has started.
+- `/guildwar accept <name>` - Accepts an incoming invitation.
+
+### Admin Commands
+
+- `/adminguildwar setspawn` - Sets the spawn point where players will return after the battle.
+- `/adminguildwar setarenaspawn <arena_id> <attacker/victim>` - Creates an arena and sets the spawn points.
+
+## PlaceholderAPI
+
+- `%rguilds_war_point%` - Shows the battle win score for the guild the player is affiliated with.
+
+## Images
+
+![guildwar_1](../../../../assets/rguilds/modules/guildwar/guildwar_1.png)
+![guildwar_2](../../../../assets/rguilds/modules/guildwar/guildwar_2.png)

src/content/docs/rguilds/modules/setup.md

@@ -0,0 +1,15 @@
+---
+title: "Setup"
+---
+
+
+### Information about module installation
+
+**What is the module ?**
+
+- Modules are completely optional systems that can be added or removed, with the exception of add-ons.
+
+**How to install it?**
+
+- Modules you have purchased or downloaded for free
+drop it into the plugins/RGuilds/modules folder. Then restart the server

src/content/docs/rguilds/modules/storage.md

@@ -0,0 +1,34 @@
+---
+title: Storage - Guild Storage
+---
+
+## Guild Storage Module
+
+### What is it?
+
+- The Guild Storage Module allows guild members to use a shared storage system. Players can securely store their items in the guild's shared storage.
+
+### Features
+
+- Set the usage fee for the guild storage.
+- Create guild storage levels, set the storage size and fee (maximum 54 slots).
+- Determine which players can withdraw items from the guild storage.
+
+### Commands
+
+#### Player Commands
+
+- `/guildstorage` - Opens the guild storage.
+- `/guildstorage upgrade` - Opens the purchase/upgrade menu for the guild storage.
+- `/guildstorage rank <rank>` - Sets who can access the guild storage.
+
+#### Admin Commands
+
+- `/adminguild delete <name>` - Deletes the specified guild's storage.
+- `/adminguild show <name>` - Opens the specified guild
+
+**Images**
+
+![gui_14](../../../../assets/rguilds/modules/storage/gui_14.png)
+![gui_15](../../../../assets/rguilds/modules/storage/gui_15.png)
+![gui_16](../../../../assets/rguilds/modules/storage/gui_16.png)

src/content/docs/tr/rguilds/features/gui.md

@@ -0,0 +1,26 @@
+---
+title: GUI
+---
+
+### Lonca eklentisi gui tasarımları
+
+**Görseller**
+
+
+![new_gui_1](../../../../../assets/rguilds/gui/new_gui_1.png)
+![new_gui_2](../../../../../assets/rguilds/gui/new_gui_2.png)
+![new_gui_3](../../../../../assets/rguilds/gui/new_gui_3.png)
+![new_gui_4](../../../../../assets/rguilds/gui/new_gui_4.png)
+![new_gui_5](../../../../../assets/rguilds/gui/new_gui_5.png)
+![new_gui_6](../../../../../assets/rguilds/gui/new_gui_6.png)
+![new_gui_7](../../../../../assets/rguilds/gui/new_gui_7.png)
+![new_gui_8](../../../../../assets/rguilds/gui/new_gui_8.png)
+![new_gui_9](../../../../../assets/rguilds/gui/new_gui_9.png)
+![new_gui_10](../../../../../assets/rguilds/gui/new_gui_10.png)
+![new_gui_11](../../../../../assets/rguilds/gui/new_gui_11.png)
+![new_gui_12](../../../../../assets/rguilds/gui/new_gui_12.png)
+![new_gui_13](../../../../../assets/rguilds/gui/new_gui_13.png)
+![new_gui_14](../../../../../assets/rguilds/gui/new_gui_14.png)
+![new_gui_15](../../../../../assets/rguilds/gui/new_gui_15.png)
+![new_gui_16](../../../../../assets/rguilds/gui/new_gui_16.png)
+![new_gui_17](../../../../../assets/rguilds/gui/new_gui_17.png)

src/content/docs/tr/rguilds/features/webhook.md

@@ -0,0 +1,16 @@
+---
+title: 'Discord webhook'
+---
+
+### Webhook sistemi
+
+
+**Detaylar**
+
+- Webhook JSON formatındadır. Tamamen özelleştirebilir.
+
+
+**Görseller**
+
+![webhook_1](../../../../../assets/rguilds/webhooks/webhook_1.png)
+![webhook_2](../../../../../assets/rguilds/webhooks/webhook_2.png)