From f44e5587859733c2d1988494676f071a5220e75f Mon Sep 17 00:00:00 2001 From: tibs Date: Wed, 8 Jun 2022 13:36:39 -0400 Subject: [PATCH] Make README me accurate --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4f5744f..cd6d09b 100644 --- a/README.md +++ b/README.md @@ -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).