diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1c8de9b --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 NichtStudioCode + +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/README.md b/README.md index 4c1922d..5306621 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ -# InvUI +![Logo](https://i.imgur.com/bFqCsuj.png) -An unfinished Spigot Inventory API +[![HitCount](http://hits.dwyl.com/NichtStudioCode/InvUI.svg)](http://hits.dwyl.com/NichtStudioCode/InvUI) +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/446b3c9356744523b409a6a6d281e772)](https://www.codacy.com/gh/NichtStudioCode/InvUI/dashboard?utm_source=github.com&utm_medium=referral&utm_content=NichtStudioCode/InvUI&utm_campaign=Badge_Grade) +[![Stars](https://img.shields.io/github/stars/NichtStudioCode/InvUI?color=ffa200)](https://github.com/NichtStudioCode/InvUI/stargazers) +![GitHub issues](https://img.shields.io/github/issues/NichtStudioCode/InvUI) +![License](https://img.shields.io/github/license/NichtStudioCode/InvUI) + +# InvUI +An Inventory API for Minecraft Spigot servers. + +Supports all versions from 1.14 to 1.16. + +[Wiki](https://github.com/NichtStudioCode/InvUI/wiki) + +## Features +* Different types of inventories (Chest, Anvil, Dropper...) +* Different GUI types (Normal, Paged, Tab) +* Nested GUIs (For example use another PagedGUI as a page) +* Easily customizeable (Create your own GUI types and Items) +* Easy way to add localization using the built-in ItemBuilder +* Supports custom textures (Forced ResourcePack) +* Uncloseable inventories +* GUI Builder + +## Examples +![1](https://i.imgur.com/uaqjHSS.gif) +![2](https://i.imgur.com/rvE7VK5.gif)