From 0c4db676e45d8ebdfcae7bf8252cf4bba89eb33f Mon Sep 17 00:00:00 2001 From: Kamron Vaswani Date: Fri, 25 Nov 2022 00:53:22 -0500 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 66d1597..e8dbef2 100644 --- a/README.md +++ b/README.md @@ -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)