tibs/cauldron-dyeing
1
0
Fork 0
mirror of https://github.com/TibiNonEst/cauldron-dyeing.git synced 2024-11-24 03:27:19 -05:00
Code Issues Projects Releases Packages Wiki Activity

Make README me accurate

Browse source
This commit is contained in:
tibs 2022-06-08 13:36:39 -04:00
parent 66b44be2bb
commit 77bc5c1cf4
Signed by untrusted user who does not match committer: tibs
GPG key ID: 047833989F50F88F
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -12,19 +12,20 @@ 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.
![dyed water](https://imgur.com/Wn2Q27Y.png)
![dyed water](https://cdn.tibinonest.me/images/dyed-water.jpg)
## 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.
Cauldron Dyeing requires Fabric or Quilt loader and [FAPI](https://modrinth.com/mod/fabric-api) or [QFAPI](https://modrinth.com/mod/qsl).
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 along with either FAPI or QFAPI.
### 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`.
## Compatibility
Cauldron Dyeing is ensured to be compatible with (Quilted) Fabric API, CaffeineMC mods, and Iris, if any incompatibility is found please report it on the [issue tracker](https://github.com/TibiNonEst/cauldron-dyeing/issues).
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.
**Note:** The current method of displaying dyed water is not compatible with shaders that customize water color such as Complementary's Realistic-ish and RTX-ish settings.
## Issues
Report any bugs, crashes, or other issues that may arise on the [issue tracker](https://github.com/TibiNonEst/cauldron-dyeing/issues).