From 38b1121cae068ce8e4ac1938481ca422ceace3c7 Mon Sep 17 00:00:00 2001 From: KAMKEEL Date: Fri, 25 Nov 2022 01:41:29 -0500 Subject: [PATCH] Attempt to Add Git Submodule --- .gitmodules | 3 +++ src/api/LICENSE | 21 +++++++++++++++++++++ src/api/README.md | 16 ++++++++++++++++ 3 files changed, 40 insertions(+) create mode 100644 .gitmodules create mode 100644 src/api/LICENSE create mode 100644 src/api/README.md diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 000000000..71e669b34 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "src/api"] + path = src/api + url = https://github.com/KAMKEEL/CustomNPC-Plus-API.git diff --git a/src/api/LICENSE b/src/api/LICENSE new file mode 100644 index 000000000..43f341d5a --- /dev/null +++ b/src/api/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Kamron Vaswani + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/src/api/README.md b/src/api/README.md new file mode 100644 index 000000000..e8dbef2dd --- /dev/null +++ b/src/api/README.md @@ -0,0 +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)