Merge pull request #3 from LewMC/ES-1.6.0

Es 1.6.0
LewMC · Jul 1, 2024 · 9f5a313 · 9f5a313
2 parents 6d4a2fd + 4a79445
commit 9f5a313
Show file tree

Hide file tree

Showing 8 changed files with 85 additions and 17 deletions.
diff --git a/Writerside/LewMCWiki.tree b/Writerside/LewMCWiki.tree
@@ -15,8 +15,9 @@
                 <toc-element topic="ES-Permissions.md"/>
                 <toc-element topic="ES-Disabling-Commands.md"/>
             </toc-element>
-            <toc-element topic="ES-System-Requirements.md"/>
-            <toc-element topic="ES-Language-Files.md"/>
+            <toc-element topic="ES-System-Requirements.md">
+                <toc-element topic="ES-Language-Files.md"/>
+            </toc-element>
             <toc-element topic="ES-Teams.md"/>
             <toc-element topic="ES-Kits.md"/>
             <toc-element topic="ES-MOTD.md"/>

diff --git a/Writerside/images/en-gb-old.yml.png b/Writerside/images/en-gb-old.yml.png
diff --git a/Writerside/images/en-gb.yml.png b/Writerside/images/en-gb.yml.png
diff --git a/Writerside/topics/ES-Changelogs.md b/Writerside/topics/ES-Changelogs.md
@@ -4,6 +4,15 @@
 <strong>You should always run the latest version of all software!</strong> That includes Essence! Updating keeps your server free from bugs, exploits, and other potential issues. When you see the message - update!
 </warning>
 
+## 1.6.0
+_2024-07-XX_ - Essence 1.6.0 adds a whole host of new features including Vault integration.
+
+| Added   | Essence can now be used as an economy provider for other plugins when [Vault](https://www.spigotmc.org/resources/vault.34315/) is installed. - Added /es reload, /msg, /reply, /rules, /seen, and /info commands. - Added Simplified Chinese (zh-CN) translation, very limited French (fr-FR) translation. |
+|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Removed | Nothing was removed in this update.                                                                                                                                                                                                                                                                        |
+| Changed | /broadcast now appears in /es help.                                                                                                                                                                                                                                                                        |
+| Fixed   | essence.* wildcard was not working correctly. - Fixed some aliases being incorrect.                                                                                                                                                                                                                        |
+
 ## 1.5.3
 _2024-06-25_ - Essence 1.5.3 changes how the /home command is handled, and provides additional quality-of-life fixes and improvements.
 
@@ -13,7 +22,6 @@ _2024-06-25_ - Essence 1.5.3 changes how the /home command is handled, and provi
 | Changed | /home will now list homes if there is no home named "home", instead of telling you it's missing.                                                                                                                                                      |
 | Fixed   | /homes, /warps, and /thomes will now tell you if there's no homes set instead of displaying a blank list when homes/warps have been created in the past. - Fixes a bug where players would be occasionally teleported into the ground when they died. |
 
-
 ## 1.5.2
 _2024-06-20_ - Essence 1.5.2 fixes exceptions in the /team command, teleportation not working as expected, and more.
 
@@ -23,7 +31,6 @@ _2024-06-20_ - Essence 1.5.2 fixes exceptions in the /team command, teleportatio
 | Changed | Teleportation can now handle more types of teleportation.                                                                                                                                                     |
 | Fixed   | Exception when /team is ran by the console is now handled correctly. - Teleporting a player to a coordinate will now teleport that player instead of you. - Debug code left in accidentally has been removed. |
 
-
 ## 1.5.1
 _2024-06-18_ - Essence 1.5.1 fixes players not respawning correctly and the /world command failing on non-vanilla generated worlds.
 

diff --git a/Writerside/topics/ES-Commands.md b/Writerside/topics/ES-Commands.md
@@ -1,5 +1,7 @@
 # Commands
 
+> See also: [Permissions](ES-Permissions.md)
+
 ## Main Command
 This is the full list of commands included in the most recent version of Essence. Commands [can be disabled](ES-Disabling-Commands.md) by server administrators.
 
@@ -117,9 +119,11 @@ Wildcard permission: essence.stats.* and essence.stats.other.*
 ## Chat Commands
 Wildcard permission: essence.chat.*
 
-| Command              | Permission Required    | Description                          | Usage                                    | Console can run? |
-|----------------------|------------------------|--------------------------------------|------------------------------------------|------------------|
-| /broadcast <message> | essence.chat.broadcast | Send a message to the entire server. | /broadcast This is an example broadcast. | Yes              |
+| Command                       | Permission Required    | Description                                            | Usage                                    | Console can run? |
+|-------------------------------|------------------------|--------------------------------------------------------|------------------------------------------|------------------|
+| /broadcast <message>          | essence.chat.broadcast | Send a message to the entire server.                   | /broadcast This is an example broadcast. | Yes              |
+| /msg <name> <message>         | essence.chat.msg       | Send a message to a specific user.                     | /msg Notch Hello there!                  | Yes              |
+| /reply <message> /r <message> | essence.chat.reply     | Reply to the last user who sent you a private message. | /r Hey back to you!                      | Yes              |
 
 ## Economy Commands
 Wildcard permission: essence.economy.*
@@ -153,6 +157,22 @@ Wildcard permission: essence.team.*
 | /team rule <rule> <value>                | essence.team.manage        | Set the value of a team rule.                   |                                    | No               |
 | Team home commands                       | See home commands section. |                                                 |                                    |                  |
 
+## Administration Commands
+Wildcard permission: essence.admin.*
+
+| Command                    | Permission Required  | Description                                     | Usage                    | Console can run? |
+|----------------------------|----------------------|-------------------------------------------------|--------------------------|------------------|
+| /seen <name>               | essence.admin.seen   | Displays the player's last login date and time. | /seen Notch              | Yes              |
+| /info <name> /pinfo <name> | essence.admin.info   | Displays information about the player.          | /info Notch /pinfo Notch | Yes              |
+| /es reload                 | essence.admin.reload | Reloads Essence's configuration.                | /es reload               | Yes              |
+
+## Miscellaneous Commands
+Wildcard permission: None
+
+| Command                    | Permission Required  | Description            | Usage  | Console can run? |
+|----------------------------|----------------------|------------------------|--------|------------------|
+| /rules                     | essence.rules        | View the server rules. | /rules | Yes              |
+
 <seealso>
     <category ref="es-commands">
         <a href="ES-Teams.md">Teams</a>

diff --git a/Writerside/topics/ES-Language-Files.md b/Writerside/topics/ES-Language-Files.md
@@ -1,15 +1,34 @@
-# Language Files
+# Supported Languages
 
-Language files are used in Essence to serve messages to players
+| Language             | Code  | Supported                                        | Since |
+|----------------------|-------|--------------------------------------------------|-------|
+| Bengali              | bn-BD | ❌ File exists but is not enabled, not translated | 1.6.0 |
+| British English      | en-GB | ✅ Fully                                          | 1.0.0 |
+| Chinese (Simplified) | zn-CN | ✅ Fully                                          | 1.6.0 |
+| French               | fr-FR | ⚠ Limited support                                | 1.6.0 |
+| German               | de-DE | ❌ File exists but is not enabled, not translated | 1.6.0 |
+| Hindi                | hi-IN | ❌ File exists but is not enabled, not translated | 1.6.0 |
+| Japanese             | ja-JP | ❌ File exists but is not enabled, not translated | 1.6.0 |
+| Korean               | ko-KR | ❌ File exists but is not enabled, not translated | 1.6.0 |
+| Portuguese           | pt-PT | ❌ File exists but is not enabled, not translated | 1.6.0 |
+| Spanish              | es-ES | ❌ File exists but is not enabled, not translated | 1.6.0 |
+| Turkish              | tr-TR | ❌ File exists but is not enabled, not translated | 1.6.0 |
+| Vietnamese           | vi-VN | ❌ File exists but is not enabled, not translated | 1.6.0 |
 
-These are automatically updated whenever you update your plugin.
+## Translate Essence
+We use Crowdin to provide translations for Essence, it automatically synchronises to our GitHub repository so any changes are automatically pushed with the next Essence update.
+
+Translate to Crowdin: [https://crowdin.com/project/lewmc-essence](https://crowdin.com/project/lewmc-essence)
 
-We currently only support en-gb, you can see a [template here](https://github.com/lewmilburn/Essence/blob/main/src/main/resources/language/en-gb.yml) if you'd like to create a translation. If you have created a translation and would like to add it to Essence please open an issue on our [GitHub](https://github.com/lewmc/essence), thank you.
+## Language Files
 
-## Creating a new language file.
-> Essence may require restarting after changing the file it uses to grab messages, if you're editing a file that is already set as active in config, no restart is required.
+Language files are used in Essence to serve messages to players
+
+These are automatically updated whenever you update your plugin.
 
+### Creating a new Language File
+> Please consider translating essence to [Crowdin](https://crowdin.com/project/lewmc-essence) so that others can use the language too!
 1. Create a new .yml file in the /plugins/essence/languages folder. You should give it a unique name such as custom.yml
-2. Copy the contents of en-gb.yml to this file.
+2. Copy the contents of ![en-gb.yml](en-gb.yml.png) to this file.
 3. Customise any messages you wish to.
 4. Change the language option in config.yml to the name of your file without the yml ending (e.g. "custom").
diff --git a/Writerside/topics/ES-Permissions.md b/Writerside/topics/ES-Permissions.md
@@ -6,11 +6,19 @@ Permissions are listed in the tables on the [commands page](ES-Commands.md).
 
 ## Wildcards vs Granular
 Essence uses Wildcard permissions for some commands. The wildcard permission can be used if you'd like to give users access to all commands in that section, it makes writing permissions a whole lot faster! Wildcard permissions are shows at the top of each section. They look like this:
-essence.gamemode.*
+`essence.gamemode.*`
 If you use wildcard permissions, you don't need to give players other permissions from that section. For example if you use essence.gamemode.* you don't need to also use essence.gamemode.survival as that permission is included in the wildcard.
 
 Alternatively, you can use granular permissions if there are only certain commands in a section you'd like players to be able to use. They look like this:
-essence.gamemode.survival
+`essence.gamemode.survival`
+
+### Administrator Wildcard
+
+`essence.*` provides access to all standard Essence commands, this is useful for administrators.
+
+`essence.admin.*` provides access to all Essence administrator commands, this is useful for administrators.
+
+Administrators who require access to _everything_ should be given both these permissions.
 
 ## Warp and Home Creation Limits
 By default, users can create as many warps and homes as they'd like. You can limit this by using permissions.

diff --git a/Writerside/topics/ES-Troubleshooting.md b/Writerside/topics/ES-Troubleshooting.md
@@ -4,4 +4,17 @@
 This error can sometime occur when a non-vanilla loaded world is set as the main-world if always-spawn is also enabled.
 We recommend setting the main-world to a vanilla loaded world (the world set in server.properties) if you also use always-spawn.
 
-If this is not causing the issue please [open an issue](https://github.com/lewmc/essence/issues).
+If this is not causing the issue please [open an issue](https://github.com/lewmc/essence/issues).
+
+## Unable to send message to player.
+
+### 1.6.0 and above.
+Please check your plugins/Essence/language folder. If it contains "![Old en-gb.yml](en-gb-old.yml.png)", please delete this file and restart your server.
+
+The English language file should be "![en-gb.yml](en-gb.yml.png)", it appears that your server was unable to migrate the file to the new format correctly which may be causing your issue.
+
+If this is not causing the issue please [open an issue](https://github.com/lewmc/essence/issues).
+
+### Pre-1.6.0
+Please delete your en-gb.yml file and restart your server.
+Please note that earlier versions are no longer supported for bug-fixes, and we recommend updating Essence.