ModMenu Badges Lib

<!-- Suppress IDEA Warnings --> <!--suppress ALL --> <a name="readme-top"></a> ] ] ] ] ] ] ] ] <br /> <div align="center"> <h3 align="center">ModMenu Badges Lib</h3> <p align="center"> More badge!!! <br /> <a href="https://discord.gg/pbwnMwnUD6">Support</a> · <a href="https://github.com/syorito-hatsuki/modmenu-badges-lib/issues">Report Bug</a> · <a href="https://github.com/syorito-hatsuki/modmenu-badges-lib/issues">Request Feature</a> </p> </div> <details> <summary>Table of Contents</summary> <ol> <li><a href="#about-the-project">About The Project</a></li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> </ol> </details> ## About The Project ! Just a simple library for adding your own badges to ModMenu. For example, (https://github.com/Tschipcraft) uses it for the Data Pack badge in (https://github.com/Tschipcraft/dynamiclights) <p align="right">(<a href="#readme-top">back to top</a>)</p> ## Usage <details> <summary>Mod Developers</summary> 1. Add Gradle dependency into `build.gradle` or `build.gradle.kts` ```gradle repositories { maven("https://api.modrinth.com/maven") } dependencies { // Option 1: Include ModMenu Badges Lib to project for it available within your own jar (additional ~5kb) include(modImplementation("maven.modrinth", "modmenu-badges-libb", "<version>")) // Option 2: Depend on ModMenu Badges Lib, but require that users install it manually modImplementation("maven.modrinth", "modmenu-badges-lib", "<version>") } ``` 2. Add the dependency recommend in your fabric.mod.json ```json "recommends": { "modmenu-badges-lib": "*" } ``` 3. Open (https://syorito-hatsuki.github.io/modmenu-badges-lib/) add copy result to our `fabric.mod.json`. > Alternative color code generator: https://argb-int-calculator.netlify.app ```json5 { ... "custom": { "mcb": }, ... } ``` </details> <details> <summary>Modpack developers</summary> 1. Create `modmenu-extra-badges.json` file in root of your modpack instance (.minecraft folder or else depend on launcher ) 2. Use example below to edit all how you want Color values generating tool https://syorito-hatsuki.github.io/modmenu-badges-lib/ ```json5 { // Mod ID "modmenu-badges-lib": { // Sort badges by alphabet "sort": true, // Overwrite all badges with new, aka delete all "overwrite": true, // List of modmenu-badges-lib badges "badges": }, // Deleting default Minecraft Badge "minecraft": { "badges": } } ``` </details> ## Roadmap - Search by badge - Own online badge editor with real-time preview See the (https://github.com/syorito-hatsuki/modmenu-badges-lib/issues) for a full list of proposed features (and known issues). <p align="right">(<a href="#readme-top">back to top</a>)</p> ## Contributing Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again! 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request <p align="right">(<a href="#readme-top">back to top</a>)</p> ## License Distributed under the MIT License. See `LICENSE.txt` for more information. <p align="right">(<a href="#readme-top">b