Skip to content

Commit

Permalink
Merge pull request #1 from LewMC/es-1.5.0
Browse files Browse the repository at this point in the history
Es 1.5.0
  • Loading branch information
lewmilburn committed Jun 18, 2024
2 parents 7c1f279 + 3fea21f commit acfc8c6
Show file tree
Hide file tree
Showing 5 changed files with 116 additions and 33 deletions.
9 changes: 9 additions & 0 deletions Writerside/topics/ES-Changelogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.5.0
_2024-06-18_ - Essence 1.5.0 adds team homes and tpr support.

| Added | Re-added random teleportation - Added [team homes](ES-Teams.md) |
|---------|---------------------------------------------------------------------------|
| Removed | Nothing was removed in this update. |
| Changed | Nothing was changed in this update. |
| Fixed | Fixed an issue where sometimes team files would not be created correctly. |

## 1.4.0
_2024-06-07_ - Essence 1.4.0 adds spawn, repair, kit, and teleportation request commands alongside support for Folia-based servers.

Expand Down
47 changes: 26 additions & 21 deletions Writerside/topics/ES-Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,16 @@ Wildcard permission: essence.warp.*
### Home Commands
Wildcard permission: essence.home.*

| Command | Permission Required | Description | Usage | Console can run? |
|-----------------|---------------------|---------------------|------------------|------------------|
| /home | essence.home.list | Get a list of homes | /home | No |
| /home <name> | essence.home.use | Teleport to a home. | /home MyHouse | No |
| /sethome <name> | essence.home.create | Create a home. | /sethome MyHouse | No |
| /delhome <name> | essence.home.delete | Delete a home. | /delhome MyHouse | No |

| Command | Permission Required | Description | Usage | Console can run? |
|------------------|--------------------------|--------------------------|------------------|------------------|
| /homes | essence.home.list | Get a list of homes | /homes | No |
| /home <name> | essence.home.use | Teleport to a home. | /home MyHouse | No |
| /sethome <name> | essence.home.create | Create a home. | /sethome MyHouse | No |
| /delhome <name> | essence.home.delete | Delete a home. | /delhome MyHouse | No |
| /thomes | essence.home.team.list | Get a list of team homes | /thomes | No |
| /thome <name> | essence.home.team.use | Teleport to a team home. | /thome Base | No |
| /setthome <name> | essence.home.team.create | Create a team home. | /setthome Base | No |
| /delthome <name> | essence.home.team.delete | Delete a team home. | /delthome Base | No |

### Spawn commands
Wildcard permission: essence.spawn.*
Expand Down Expand Up @@ -127,20 +130,22 @@ Wildcard permission: essence.team.*

> To use /team requests, accept, decline, kick, rule, and changeleader the player must have the permission to do so AND be the team leader.
| Command | Permission Required | Description | Usage | Console can run? |
|----------------------------------------|---------------------|-------------------------------------------------|----------------------------------|------------------|
| /team /group | essence.team.list | Get a list of teams. | /team /group | No |
| /team <name> /group <name> | essence.team.list | Get information of a specific team. | /team Red /group Red | No |
| /team join <name> /group join <name> | essence.team.join | Join a team. | /team join Red /group join Red | No |
| /team leave <name> /group leave <name> | essence.team.join | Leave a team. | /team leave Red /group leave Red | No |
| /team requests | essence.team.manage | View pending membership requests for your team. | /team requests | No |
| /team accept <name> | essence.team.manage | Accept a player's membership request. | /team accept Notch | No |
| /team decline <name> | essence.team.manage | Decline a player's membership request. | /team decline Notch | No |
| /team kick <name> | essence.team.manage | Kick (remove) a player from your team. | /team kick Notch | No |
| /team changeleader <name> | essence.team.manage | Transfer leadership to another member. | /team changeleader Notch | No |
| /team disband | essence.team.manage | Disband your team (delete it). | /team disband | No |
| /team rule <rule> | essence.team.manage | View the value of a team rule. | /team rule | No |
| /team rule <rule> <value> | essence.team.manage | Set the value of a team rule. | | No |
| Command | Permission Required | Description | Usage | Console can run? |
|------------------------------------------|----------------------------|-------------------------------------------------|------------------------------------|------------------|
| /team /group | essence.team.list | Get a list of teams. | /team /group | No |
| /team <name> /group <name> | essence.team.list | Get information of a specific team. | /team Red /group Red | No |
| /team create <name> /group create <name> | essence.team.create | Create a team. | /team create Red /group create Red | No |
| /team join <name> /group join <name> | essence.team.join | Join a team. | /team join Red /group join Red | No |
| /team leave <name> /group leave <name> | essence.team.join | Leave a team. | /team leave Red /group leave Red | No |
| /team requests | essence.team.manage | View pending membership requests for your team. | /team requests | No |
| /team accept <name> | essence.team.manage | Accept a player's membership request. | /team accept Notch | No |
| /team decline <name> | essence.team.manage | Decline a player's membership request. | /team decline Notch | No |
| /team kick <name> | essence.team.manage | Kick (remove) a player from your team. | /team kick Notch | No |
| /team changeleader <name> | essence.team.manage | Transfer leadership to another member. | /team changeleader Notch | No |
| /team disband | essence.team.manage | Disband your team (delete it). | /team disband | No |
| /team rule <rule> | essence.team.manage | View the value of a team rule. | /team rule | No |
| /team rule <rule> <value> | essence.team.manage | Set the value of a team rule. | | No |
| Team home commands | See home commands section. | | | |

<seealso>
<category ref="es-commands">
Expand Down
31 changes: 27 additions & 4 deletions Writerside/topics/ES-System-Requirements.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,29 @@
# System Requirements

| Essence Version | Minecraft Versions | Supported Software | Java Version |
|-----------------|--------------------|---------------------------------------------------------------|--------------|
| 1.4.0+ | > 1.20.4 | CraftBukkit, Spigot, Paper, Folia, or a fork of these | 17 |
| 1.0.0 - 1.3.2 | > 1.19.0 | CraftBukkit, Spigot, Paper, or a fork of these (except Folia) | 17 |
<warning>
Some commands do not work on Folia-based servers, please see the section at the bottom of this page for more information.
</warning>

| Essence Version | Minecraft Versions | Supported Software | Java Version | Active Support |
|-----------------|--------------------|---------------------------------------------------------------|--------------|----------------|
| 1.4.0+ | > 1.20.4 | CraftBukkit, Spigot, Paper, Folia, or a fork of these | 17 | Yes |
| 1.0.0 - 1.3.2 | > 1.19.0 | CraftBukkit, Spigot, Paper, or a fork of these (except Folia) | 17 | No |

## Minecraft Version Support
We aim to support as many Minecraft versions as possible, however this may not always be possible.

We generally do not provide bug fixes for older versions of Minecraft if newer versions of Essence no longer support it.
If you're unusure if we'll fix something, ask! [Open an issue on our GitHub](https://github.com/lewmc/essence/issues) and we'll advise there.
If you're running a version of Essence that is still actively supported, we'll fix any and all bugs and issues.

We may drop support for certain Minecraft versions due to technical limitations, vulnerabilities, or other reasons.

## Folia Support
Essence supports Folia-based Minecraft Server Software in versions 1.4.0 and greater.

Unfortunately, due to how the Folia software works, some commands are currently disabled as we're not able to add support for them at this time due to technical reasons.
If you'd like to help us add support for these commands on Folia-based servers, please [open a pull request on our GitHub](https://github.com/lewmc/essence).

| Disabled Command | Since | Reason |
|------------------|-------|----------------------------------------------------------------------------------------------|
| /tprandom | 1.4.0 | Folia generates an exception when running this command due to the way RegionSchedulers work. |
42 changes: 38 additions & 4 deletions Writerside/topics/ES-Teams.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,42 @@
# Teams
<warning>
Users will need to have the <a href="ES-Commands.md">correct permissions</a> to be able to access these features.
</warning>

## Rules
## What is a team?
A team is a group of players that join together to share certain resources. Similarly to factions, teams allow for configurable rulesets and access levels depending on user preference.

### Should I enable teams on my server?
Why not! Even if you don't plan on having much team-based play or functionality, it's a useful and fun system for players to use. It allows players to share homes and avoid hurting each other, so it can be good when playing with friends.

## Team features
### Managing teams
Teams can be created by using the `/team create <name>` command.

You can disband (delete) by using the `/team disband` command.

You can hand the leadership over to another player by using `/team changeleader <name>`

If you want to remove someone from your team you can use `/team kick <name>`.

### Join requests
Joining teams is managed by a request system. To send a join request use the `/team join <name>` command. The team leader can then use `/team requests` to view incoming requests.

To accept pending requests use `/team accept <name>` or `/team decline <name>`.

If you want to remove someone from your team you can use `/team kick <name>`.

### Rules
Rules are a set of values that control gameplay features when players are in teams. You can set these by using `/team rule <rule> <value>` and see what they're currently set as by using `/team rule <rule>`

| Rule | Description | Accepted Values | Default |
|-----------------------|-------------------------------|-----------------|---------|
| `allow-friendly-fire` | Allows PvP between teammates. | true or false | true |
| Rule | Description | Accepted Values | Default |
|-----------------------|-------------------------------------|-----------------|---------|
| `allow-friendly-fire` | Allows PvP between teammates. | true or false | true |
| `allow-team-homes` | Allows the use of joint team homes. | true or false | true |

### Team Homes
Alongside having personal homes, teams can also have joint homes. These are set using the `/thome` commands.

You'll need to give players access to the home command wildcard or the thome command permissions. You can find out more on the [commands page](ES-Commands.md).

Team homes work exactly the same as normal homes, except they're shared amongst team members. Every team member can access every team home.
20 changes: 16 additions & 4 deletions Writerside/topics/KR-System-Requirements.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# System Requirements

| Kryptonite Version | Minecraft Versions | Supported Software | Java Version |
|--------------------|--------------------|---------------------------------------------------------------|--------------|
| 1.3.0+ | > 1.20.6 | CraftBukkit, Spigot, Paper, Folia, or a fork of these | 21 |
| 1.0.0 - 1.2.0 | > 1.20.0 | CraftBukkit, Spigot, Paper, or a fork of these (except Folia) | 21 |
| Kryptonite Version | Minecraft Versions | Supported Software | Java Version | Active Support |
|--------------------|--------------------|---------------------------------------------------------------|--------------|----------------|
| 1.3.0+ | > 1.20.6 | CraftBukkit, Spigot, Paper, Folia, or a fork of these | 21 | Yes |
| 1.0.0 - 1.2.0 | > 1.20.0 | CraftBukkit, Spigot, Paper, or a fork of these (except Folia) | 21 | No |

## Minecraft Version Support
We aim to support as many Minecraft versions as possible, however this may not always be possible.

We generally do not provide bug fixes for older versions of Minecraft if newer versions of Kryptonite no longer support it.
If you're unusure if we'll fix something, ask! [Open an issue on our GitHub](https://github.com/lewmc/kryptonite/issues) and we'll advise there.
If you're running a version of Kryptonite that is still actively supported, we'll fix any and all bugs and issues.

We may drop support for certain Minecraft versions due to technical limitations, vulnerabilities, or other reasons.

## Folia Support
Kryptonite supports Folia-based Minecraft Server Software in versions 1.3.0 and greater.

0 comments on commit acfc8c6

Please sign in to comment.