ClutteredCreative/README.md

103 lines
4.4 KiB
Markdown

<p align="center">
<img alt="Cluttered Creative Icon" height="128px" width="128px" src="https://git.theclashfruit.me/TheClashFruit/ClutteredCreative/raw/branch/main/src/main/resources/assets/cc/icon.png">
</p>
<h1 align="center">Cluttered Creative</h1>
<p align="center">
<img alt="Issues" src="https://img.shields.io/badge/dynamic/json?color=yellow&label=issues&query=%24.open_issues_count&url=https%3A%2F%2Fgit.theclashfruit.me%2Fapi%2Fv1%2Frepos%2FTheClashFruit%2FClutteredCreative">
<img alt="Pull Requests" src="https://img.shields.io/badge/dynamic/json?color=brightgreen&label=pull+requests&query=%24.open_pr_counter&url=https%3A%2F%2Fgit.theclashfruit.me%2Fapi%2Fv1%2Frepos%2FTheClashFruit%2FClutteredCreative">
<img alt="Version" src="https://img.shields.io/badge/dynamic/json?color=orange&label=version&query=%24%5B0%5D.name&url=https%3A%2F%2Fgit.theclashfruit.me%2Fapi%2Fv1%2Frepos%2FTheClashFruit%2FClutteredCreative%2Freleases">
<img alt="License (MIT)" src="https://img.shields.io/badge/license-MIT-green.svg">
</p>
<p align="center">
<img alt="Modrinth Downloads" src="https://img.shields.io/modrinth/dt/Fs6mB0ic?label=Modrinth%20Downloads">
<img alt="CurseForge Downloads" src="https://img.shields.io/curseforge/dt/901062?label=CurseForge%20Downloads">
</p>
<p align="center">
<a href="https://modrinth.com/mod/cluttered-creative">
<img alt="curseforge" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/modrinth_vector.svg">
</a>
<a href="https://www.curseforge.com/minecraft/mc-mods/cluttered-creative">
<img alt="curseforge" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/curseforge_vector.svg">
</a>
</p>
<p align="center">
Bring back the old cluttered creative inventory.
</p>
## Screenshot
![Building Blocks](https://cdn-raw.modrinth.com/data/Fs6mB0ic/images/01122692525430bb275d19972e934b2126ce2792.png)
## FAQ
### Mod Compatibility
Probably not compatible with mods that add items to the default item groups, however a compatibility layer is planned.
### Missing Items
I'm doing my best to include all items including new ones from 1.20, but I might miss some so please report them on the issues page or in my [Discord server](https://discord.gg/CWEApqJ6rc).
> Got some other questions? Feel free to ask them in my [Discord server](https://discord.gg/CWEApqJ6rc).
## Developing & Contributing
Development is mostly straight forward.
### Setup
> It is recommended that you install the [Minecraft Development](https://plugins.jetbrains.com/plugin/8327-minecraft-development) Plugin for IntelliJ IDEA.
1. Clone the repository from your fork.
2. Open the project.
3. You can start developing!
<!-- 3. Run `gradle genSources` to generate the sources. -->
### Git Commit Messages
Please use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for your commit messages.
### Git Branches
You can use any branch you like except main. But it is recommended to use `dev/<feature>` if you add something new and `fix/<issue>` if you are fixing something related to an issue.
### Opening a Pull Request
When you start your development please open a draft pull request. This way we can see that someone is working on select feature/bug.
> Make sure to mention related issues/pull requests in your pull request.
## License
```
The MIT License (MIT)
Copyright (c) 2023 TheClashFruit
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.
```