Skip to content

Commit 85076c0

Browse files
committed
chore: Update README information
1 parent 82c2dc5 commit 85076c0

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,19 @@
1414

1515
# 📌 ModdedIntegration
1616

17-
A simple Minecraft Plugin that auto-populates the [Essentials](https://www.spigotmc.org/resources/essentialsx.9089/)' [items.csv file](https://github.com/EssentialsX/Essentials/blob/2.x/Essentials/src/main/resources/items.csv) with [Forge](http://files.minecraftforge.net/) items and blocks.
17+
A simple Minecraft Plugin that auto-populates the [Essentials](https://www.spigotmc.org/resources/essentialsx.9089/)' items file with modded items and blocks.
1818

1919
# ✅ Requirements
2020
This Plugin needs some dependencies in order to work.
2121
* [Mohist](https://mohistmc.com), [Arclight](https://github.com/IzzelAliz/Arclight), Magma _(abandoned)_ or any other hybrid server implementation.
2222
* [EssentialsX](https://www.spigotmc.org/resources/essentialsx.9089/)
2323

24+
> [!NOTE]
25+
> Currently only **1.12**, **1.16**, and **1.18 to 1.21** implementations have been tested and confirmed to work.
26+
2427
# 🔮 How do I use it?
2528
Put the [plugin jar](https://github.com/UknownGino/ModdedIntegration/releases/latest/download/ModdedIntegration.jar) in your plugins folder and start your server.
26-
Now the [Essentials](https://www.spigotmc.org/resources/essentialsx.9089/)' [items.csv file](https://github.com/EssentialsX/Essentials/blob/2.x/Essentials/src/main/resources/items.csv) is populated.
29+
Now the [Essentials](https://www.spigotmc.org/resources/essentialsx.9089/)' items file is populated.
2730

2831
To use modded materials with essentials you need to follow the following scheme: `<modID>_<itemID>`
2932

@@ -42,10 +45,10 @@ There are different sub-commands for the command:
4245
| `/moddedintegration reload` | Reloads the config | _moddedintegration.command.moddedintegration_ |
4346

4447
# ⚙ Configuration
45-
The only thing that can be modified in the **config.yml file** is the `reload-delay` _(default: **10 ticks**)_. The reload delay is the **amount of ticks** between the **items.csv saving** and the **EssentialsX reloading**.
48+
The only thing that can be modified in the **config.yml file** is the `reload-delay` _(default: **10 ticks**)_. The reload delay is the **amount of ticks** between the **items file saving** and the **EssentialsX reloading**.
4649

4750
# ❓ How it works?
48-
The plugin gets all the modded materials (blocks and items) and puts them into the essentials' [items.csv](https://github.com/EssentialsX/Essentials/blob/2.x/Essentials/src/main/resources/items.csv) file.
51+
The plugin gets all the modded materials (blocks and items) and puts them into the essentials' [items.csv](https://github.com/EssentialsX/Essentials/blob/2.x/Essentials/src/main/resources/items.csv)/[items.json](https://github.com/EssentialsX/Essentials/blob/2.x/Essentials/src/main/resources/items.json) file.
4952

5053
# 💡 Original idea
5154
The idea of creating this plugin came to me through [this issue](https://git.magmafoundation.org/magmafoundation/Magma/-/issues/311) opened on the [Magma's GitLab](https://git.magmafoundation.org/magmafoundation/Magma).

0 commit comments

Comments
 (0)