Skip to content

Commit

Permalink
Add kits & motd.
Browse files Browse the repository at this point in the history
  • Loading branch information
lewmilburn committed Jun 8, 2024
1 parent 9522384 commit d72c27d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
10 changes: 5 additions & 5 deletions Writerside/topics/ES-Kits.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Kits are sets of items that can be given to players via commands. The command to access Kits is /kit.

# kits.yml
## kits.yml
Kits are stored in the kits.yml file which can be found in Essence's data folder (/plugins/essence/data).

## Example
### Example
The default example kits are as follows:
```
kits:
Expand All @@ -17,21 +17,21 @@ kits:
```
These example kits come pre-installed with Essence. If you've accidentally deleted them and would like to get them back, you can delete the kits.yml file and restart your server. The file will be re-generated.

## Parameters
### Parameters
| Parameter | Description | Required? | Example |
|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|------------------------------------------------------------------|
| Kit name (root-level) | The name of your Kit - can be any string | Yes | wooden-tools |
| items | List of items you'd like the player to receive from this kit - must be a list of strings (Each string must be a valid [Material](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html)) | Yes | `["WOODEN_AXE","WOODEN_PICKAXE","WOODEN_SHOVEL","WOODEN_SWORD"]` |
| permission | <strong>Optional</strong> - See the "Permissions" section below. | No | essence.kits.god |

# Permissions
## Permissions
Kits require users to have a set of permissions to access them.

You can set the permission to whatever you want, or remove it if you'd like any players to be able to get the kit.

Players with the "essence.kits.all" permission can access all kits regardless of this value.

# Spawn Kits
## Spawn Kits
You can set it so that players are given kits when they first join the server. Please note that this is based on if they have joined the server in the past, not if they have received the kit or not.

Players must have the required permissions to access the kit.
Expand Down
13 changes: 12 additions & 1 deletion Writerside/topics/ES-MOTD.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# MOTD

Start typing here...
The MOTD ("Message of the Day") is a message that appears when a player logs into your server. It can be toggled and managed in the [Configuration](ES-Configuration.md).

## Tags
Tags are used to replace text with pre-generated values set by Essence. You can use these tags to set values that may change often such as versions.

| Tag | Description | Example |
|-------------------------|--------------------------------------------------------------|---------------------|
| `{{essence-version}}` | Get's the version of Essence the server is running. | 1.4.0 |
| `{{minecraft-version}}` | Get's the version of Minecraft the server is running. | 1.20.6 |
| `{{time}}` | Gets the current time in format HH:MM:SS | 13:45:56 |
| `{{date}}` | Gets the current date in format YYYY-MM-DD | 2024-05-19 |
| `{{datetime}}` | Gets the current date and time in format YYYY-MM-DD HH:MM:SS | 2024-05-19 13:45:56 |

0 comments on commit d72c27d

Please sign in to comment.