Essentials-Folia

A fork of EssentialsX adapted for Folia, using a Git patch system for easy maintenance and upstream updates.

Prerequisites

• Git
• Java Development Kit 21 (JDK)

Download

Compiled JARs are available here: https://github.com/Euphillya/Essentials-Folia/releases

Installation

Clone the repository

git clone https://github.com/Euphillya/Essentials-Folia.git
cd Essentials-Folia

Apply patches

./gradlew applyPatches

This command will:

1. Initialize and clone the EssentialsX submodule.
2. Apply all patches from the patches/ folder onto Essentials-Patched/.

Project Structure

• Essentials/ : Git submodule pointing to upstream EssentialsX.
• Essentials-Patched/ : Working directory generated by applyPatches (Git-ignored).
• patches/ : .patch files containing Folia modifications.

Gradle Tasks

Task	Description
./gradlew applyPatches	Initializes the submodule and applies patches
./gradlew makePatches	Regenerates .patch files from local commits
./gradlew updateSubmodules	Updates the submodule from upstream

Development Workflow

Modifying a patch

# 1. Apply patches
./gradlew applyPatches

# 2. Make your changes in Essentials-Patched/
cd Essentials-Patched
git add .
git commit -m "fix: description of the change"

# 3. Regenerate patches
cd ..
./gradlew makePatches

# 4. Commit the patches
git add patches/
git commit -m "Update patches"
git push

Updating upstream

./gradlew updateSubmodules
./gradlew applyPatches  # resolve conflicts if necessary
./gradlew makePatches
git add Essentials patches/
git commit -m "Update upstream EssentialsX"
git push

Contributing

1. Fork this repository.
2. Create a branch (git checkout -b my-feature).
3. Make your changes in Essentials-Patched/.
4. Regenerate patches with ./gradlew makePatches.
5. Commit and push your patches.
6. Open a Pull Request.

Help

For any questions or issues, feel free to open an issue.

License

This project is licensed under the MIT License. See the LICENSE file for more information.