tibs/cauldron-dyeing
1
0
Fork 0
mirror of https://github.com/TibiNonEst/cauldron-dyeing.git synced 2024-10-22 17:53:26 -05:00
Code Issues Projects Releases Packages Wiki Activity

Improve README

Browse source
This commit is contained in:
tibs 2022-01-17 17:21:17 -05:00 committed by GitHub
parent 3c13e63e40
commit 6418399d20
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -5,8 +5,6 @@
Bring Bedrock's cauldron-based armor dyeing to Java Edition.
:warning: This mod is still in alpha stage, it may be unstable.
---
This mod adds Bedrock's ability to dye leather armor or leather horse armor with cauldrons to Java Edition.
@ -14,8 +12,22 @@ The usage is the same as in Bedrock, right-clicking on a water cauldron with dye
When you right-click on the dyed water cauldron with a dyeable item, it will add the current color in the cauldron to the item.
Right-clicking on an un-dyed water cauldron with a dyed item to remove its color will still work.
### Build
![dyed water](https://imgur.com/Wn2Q27Y.png)
## Usage
Fabric Loader version 12.x or newer is required to install this mod. The latest release is available on the [Modrinth](https://modrinth.com/mod/cauldron-dyeing) or [Github releases](https://github.com/TibiNonEst/cauldron-dyeing/releases). To install, just drag the mod jar into your mods folder.
### Building
Building the mod requires JDK 17+ on your system. To build, simply run `./gradlew build` and the artifacts will be available in `build/libs`.
### License
## Compatibility
Cauldron Dyeing is ensured to be compatible with Fabric API, CaffineMC mods, and Iris, if any incompatibility is found please report it on the [issue tracker](https://github.com/TibiNonEst/cauldron-dyeing/issues).
**Note:** The current method of displaying dyed water is not compatible with shaders that customize water color, such as Complementary.
## Issues
Report any bugs, crashes, or other issues that may arise on the [issue tracker](https://github.com/TibiNonEst/cauldron-dyeing/issues).
## License
Cauldron Dyeing is licensed under the GNU LGPLv3, see the [full license](https://github.com/TibiNonEst/cauldron-dyeing/blob/main/LICENSE).