Update README.md

This commit is contained in:
Kamron Vaswani authored and GitHub committed 2022-11-25 00:53:22 -05:00
1 parent 989326faae
commit 0c4db676e4
1 file changed
+14
+14
View File
@@ -1,2 +1,16 @@
# CustomNPC-Plus-API
External API for scripting and to allow mods/plugins to hook into CustomNPC+
## How to use in a Mod
Basically just download the api code and include it in your mod.
In your mod you can check if CustomNPC+ is installed with `NpcAPI.IsAvailable()`
To use the events, register your events with `NpcAPI.Instance().events().register(youreventclass)`
## Extra
JavaDocs: https://kamkeel.github.io/CustomNPC-Plus/
[![Discord Badge](https://img.shields.io/badge/KAMKEEL_Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/pQqRTvFeJ5)
[![Download CustomNPC+](https://img.shields.io/badge/CustomNPC+_Download-0081CB?style=for-the-badge&logo=material-ui&logoColor=white)](https://www.curseforge.com/minecraft/mc-mods/customnpc-plus)