Skip to content

Commit

Permalink
Add Essence wiki.
Browse files Browse the repository at this point in the history
  • Loading branch information
@lewmilburn
lewmilburn committed Jun 8, 2024
1 parent 538218d commit f166924
Show file tree
Hide file tree
Showing 7 changed files with 119 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Writerside/LewMCWiki.tree
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,16 @@

<toc-element topic="LewMCWiki.md"/>
<toc-element topic="Essence.md">
<toc-element topic="ES-Disabling-Commands.md"/>
<toc-element topic="ES-Kits.md"/>
<toc-element topic="ES-Configuration.md"/>
<toc-element topic="ES-System-Requirements.md"/>
<toc-element topic="ES-Language-Files.md"/>
<toc-element topic="ES-MOTD.md"/>
</toc-element>
<toc-element topic="Kryptonite.md">
<toc-element topic="KR-System-Requirements.md"/>
</toc-element>
<toc-element topic="Jailhouse.md"/>
<toc-element topic="LewMC-Services.md"/>
</instance-profile>
98 changes: 98 additions & 0 deletions Writerside/topics/ES-Configuration.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Configuration

## Configuration Values
| Key | Description | Accepted Values | Default Value |
|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|--------------------|
| update-check | This value defines if Essence should check for updates during startup. If this is enabled, the plugin will query [LewMC Services](LewMC-Services.md) to check for updates. The doesn't collect any data about you or your server. | true or false | true |
| console-prefix | This sets the prefix that console logs appear as, just for a bit of customisation! To change the in-game chat prefix please see Essence [Language Files](ES-Language-Files.md). | Anything | Essence |
| motd.enabled | This toggle decides if Essence should display the join message to players in chat when they log in. [More information](ES-MOTD.md). | Multi-line string. | See example below. |
| spawn-kits | A list of kits the player should be given when they first join the server. Set to false to disable. Players must have the required permissions to access the kits. [Learn more about kits](ES-Kits.md). | Any list of valid kits. | See example below. |
| economy.start-money | This is the amount of money players get when they first join the server. It should be a decimal number (e.g. 100.0, 40.99, 0.0) | Any decimal number | 100.0 |
| economy.symbol | This value will be displayed in front of any monetary values shown in chat. Whilst we recommend sticking with standard symbols you can put anything here, such as "Coins" or whatever really. | Anything | $ |
| teleportation.home.wait | The amount of time (in seconds) the player should have to wait for after sending the command before they're teleported. To disable this feature set this value to 0. | Integer | 3 |
| teleportation.home.cooldown | The amount of time (in seconds) the player should have to wait for to teleport since they last teleported. To disable this feature set this value to 0. | Integer | 10 |
| teleportation.warp.wait | The amount of time (in seconds) the player should have to wait for after sending the command before they're teleported. To disable this feature set this value to 0. | Integer | 3 |
| teleportation.warp.cooldown | The amount of time (in seconds) the player should have to wait for to teleport since they last teleported. To disable this feature set this value to 0. | Integer | 10 |
| teleportation.randomtp.cooldown | The amount of time (in seconds) the player should have to wait for to teleport since they last teleported. To disable this feature set this value to 0. | Integer | 10 |
| teleportation.spawn.wait | The amount of time (in seconds) the player should have to wait for after sending the command before they're teleported. To disable this feature set this value to 0. | Integer | 3 |
| teleportation.spawn.cooldown | The amount of time (in seconds) the player should have to wait for to teleport since they last teleported. To disable this feature set this value to 0. | Integer | 10 |
| teleportaion.spawn.main-spawn-world | Sets the world that should be used as the main spawn. Players first joining the server will be placed on this world's spawnpoint. | Any valid world name. | world |
| teleportation.spawn.always-spawn | Should players be sent to the main world's spawnpoint every time they join the server? | true or false | false |
| teleportation.requests.cooldown | The amount of time (in seconds) the player should have to wait for to teleport since they last teleported. To disable this feature set this value to 0. | Integer | 10 |
| teleportation.requests.default-enabled | Should teleportation requests be enabled by default for all users. This can be changed per-user using /tptoggle (permissions required). | true or false | true |
| language | This sets the language file that Essence will use for chat messages. Console log messages are not affected by this and are hard-coded. For more information please see [Language Files](ES-Language-Files.md). | Any valid language code with an existing file. | en-gb |
| disabled-commands | This disables processing of certain commands in Essence, to add commands to the list you should create a new line and follow the format of the example. Please note: this does have limitations - for more information please see [Disabling Commands](ES-Disabling-Commands.md). | List of commands to disable (or blank). | See example below. |
| verbose | Outputs additional information to the console, including file information. You should only enable this if you're having problems. Warning: Creates a LOT of console spam. | true or false | false |
| config-version | Please don't change this! It can mess with Essence's configuration updater, and if we change anything you'll be in for a whole load of red text in your server console. | 1 | 1 |

## Example config.yml

```
# Generated by Essence 1.4.0
# UPDATE CHECKING
# Should Essence query the server to check for updates?
# This does not transfer any data.
update-check: true
# PREFIXES
console-prefix: "Essence"
# MOTD
# This is displayed to users in chat when they join the server.
# You can use § colour codes here!
motd:
enabled: true
message: |-
§2§lWelcome to the server!
§aYou can change this message in Essence's config.yml
# SPAWN KITS
# Players are given these kits when they first join the server.
# Set to "false" to disable this feature.
spawn-kits:
- wooden-tools
# ECONOMY
economy:
start-money: 100.0
symbol: $
# TELEPORTATION
teleportation:
home:
wait: 3
cooldown: 10
warp:
wait: 3
cooldown: 10
randomtp:
cooldown: 60
spawn:
wait: 0
cooldown: 10
main-spawn-world: world
always-spawn: false
requests:
cooldown: 10
default-enabled: true
# LANGUAGE
# The file that will be used to display messages.
# Please ensure the file exists in the 'language' sub-folder before changing this value.
language: en-gb
# DISABLED COMMANDS
# See https://wiki.lewmc.net/index.php/Disabling_Commands for help.
# PLEASE NOTE: This does not currently remove the command from /es help
disabled-commands:
- example
# VERBOSE
# Outputs more information to the console. If you're having issues, enable this.
# Warning: Creates a lot of console spam.
verbose: false
# Do not change this!
config-version: 1
```
3 changes: 3 additions & 0 deletions Writerside/topics/ES-Disabling-Commands.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Disabling Commands

Start typing here...
3 changes: 3 additions & 0 deletions Writerside/topics/ES-Kits.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Kits

Start typing here...
3 changes: 3 additions & 0 deletions Writerside/topics/ES-Language-Files.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Language Files

Start typing here...
3 changes: 3 additions & 0 deletions Writerside/topics/ES-MOTD.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# MOTD

Start typing here...
3 changes: 3 additions & 0 deletions Writerside/topics/LewMC-Services.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# LewMC Services

Start typing here...

0 comments on commit f166924

Please sign in to comment.