diff --git a/README.md b/README.md index 251ece0..2fc6fc9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +

+ Cluttered Creative Icon +

+

Cluttered Creative

@@ -12,27 +16,85 @@ License (MIT)

+

+ + curseforge + + + + curseforge + +

Bring back the old cluttered creative inventory.

-## Building +## Screenshot -TBA +![Building Blocks](https://cdn-raw.modrinth.com/data/Fs6mB0ic/images/01122692525430bb275d19972e934b2126ce2792.png) -## Contributing +## FAQ -TBA +### Mod Compatibility -## Download (soon) +Probably not compatible with mods that add items to the default item groups, however a compatibility layer is planned. -

- - curseforge - +### Missing Items - - curseforge - -

\ No newline at end of file +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. Run `gradle genSources` to generate the sources. +4. You can start developing! + +### 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/` if you add something new and `fix/` 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. +``` \ No newline at end of file