diff --git a/README.md b/README.md index 2f5314b..6a1539b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # SnowyGUI -This mod requires fabric-language-kotlin on fabric, kotlinforforge on forge. +**Currently only supports minecraft 1.16+ with forge or fabric** -### Compiling requirements -- A Java 11 JDK or higher (Jabel will be used to produce java 8 bytecode) \ No newline at end of file +This mod has both a fabric* and a forge version. +For the fabric version, [fabric-language-kotlin](https://www.curseforge.com/minecraft/mc-mods/fabric-language-kotlin) (1.6.0 or higher) mod is required, or [kotlinforforge](https://modrinth.com/mod/kotlin-for-forge) (1.12.1 or higher) if you wish to use the forge one. + +If you want to (optionally) use the configuration screen, please install the cloth config mod or a mod that bundles it. + +##### \* The fabric api mod isn't needed to use snowygui on fabric but it is recommended to add it. \ No newline at end of file