alexcrea/CustomAnvil
1
0
Fork 0
mirror of https://github.com/alexcrea/CustomAnvil.git synced 2026-06-23 08:14:00 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Initial Home page

alexcrea 2024-07-11 19:55:07 +02:00
commit 290c7fd618
1 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
Home.md Normal file

@ -0,0 +1,19 @@
Welcome to the CustomAnvil wiki!
Plugin installation: \
Just drop the plugin jar to `/plugin` on a spigot or fork of spigot server, restart, and it should work.
***
Custom enchantment developers: \
If you like to make your custom enchantment plugin compatible with Custom Anvil, the rest of the documentation will help you with that.
Here are the general step to make your plugin compatible with Custom Anvil:
* Add CustomAnvil as softdepend or depend
* On startup, if CustomAnvil is present, listen to the necessary event.
* On event trigger, register enchantments and config if needed.
* (Optional) Also register bulk operation for optimization if possible.
You can also register Custom anvil recipe if you like to.
Right now, documentation is incomplete and more page will be provided later.