From 290c7fd618bd8b5f2dd8c08081093dadc8763d00 Mon Sep 17 00:00:00 2001 From: alexcrea <42614139+alexcrea@users.noreply.github.com> Date: Thu, 11 Jul 2024 19:55:07 +0200 Subject: [PATCH] Initial Home page --- Home.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 Home.md diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..aeae132 --- /dev/null +++ b/Home.md @@ -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.