From 80094a4e06525484e2c85f3e3ea5ad1ff11aa731 Mon Sep 17 00:00:00 2001 From: Fourmisain <8464472+Fourmisain@users.noreply.github.com> Date: Wed, 1 Jun 2022 23:35:37 +0200 Subject: [PATCH] update README (see #30) --- README.md | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 2f4afe3..72a3246 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,48 @@ # Falling Leaves -This Fabric mod for Minecraft 1.18.x adds a neat little particle effect to leaf blocks. Users can configure which types of leaf blocks will drop leaves and the frequency that these leaves are dropped at. - +This Fabric mod for Minecraft 1.18+ adds a neat little particle effect to leaf blocks. +Users can configure which types of leaf blocks will drop leaves and the frequency that these leaves are dropped at. + Requires [Cloth Config](https://www.curseforge.com/minecraft/mc-mods/cloth-config). ![](https://i.imgur.com/Y6zGq33.gif) -## Toubleshooting aka "Why are no leaves falling?" +## Troubleshooting aka "Why are no leaves falling?" Some trees do not drop leaves by default, these are: conifer trees (like spruce and pine), large leaved trees (like jungle trees and palms) and shrubs. You can change this as you like by adjusting "Conifer Leaf Spawn Rate" in the Mod Menu settings and adjusting the spawn rates for specific trees under "Leaf Settings". -A complete list of all conifer trees is found [here](https://github.com/RandomMcSomethin/fallingleaves/blob/1.17/src/main/java/randommcsomethin/fallingleaves/config/ConfigDefaults.java#L9-L23) and a list of all trees with adjusted spawn rates is found [here](https://github.com/RandomMcSomethin/fallingleaves/blob/1.17/src/main/java/randommcsomethin/fallingleaves/config/ConfigDefaults.java#L32-L52). +A complete list of all conifer trees is found [here](https://github.com/RandomMcSomethin/fallingleaves/blob/1.18/src/main/java/randommcsomethin/fallingleaves/config/ConfigDefaults.java#L9-L23) and a list of all trees with adjusted spawn rates is found [here](https://github.com/RandomMcSomethin/fallingleaves/blob/1.18/src/main/java/randommcsomethin/fallingleaves/config/ConfigDefaults.java#L33-L53). ## FAQ - Is this compatible with trees from other mods? What about Resource Packs? - Falling Leaves _should_ be 100% compatible with any modded trees and any resource pack changing leaves! + - Does this need to be installed on the server for multiplayer? - - Nope! This mod is 100% client-side and should work fine no matter what. + - Nope! This mod is 100% client-side. + - Lol fabric suxxx gief forge plx. - - That's not a question. Also, no. Feel free to port it to Forge if you want to, though! + - Cheaterpaul [ported this mod to Forge](https://www.curseforge.com/minecraft/mc-mods/falling-leaves-forge "Forge port"), note that this port is inofficial and might not always be up-to-date, it also does configuration differently. + - Do you have any screenshots I could look at before I install this? - - Sure! Check out the [images section](https://www.curseforge.com/minecraft/mc-mods/falling-leaves-fabric/screenshots) of this mod's Curseforge page. (Note that they are slightly out of date.) -- I enjoy old things. Can you backport this to Minecraft v1.7? + - Sure! Check out the [images section](https://www.curseforge.com/minecraft/mc-mods/falling-leaves-fabric/screenshots) of this mod's Curseforge page. + (Note that they are slightly out of date.) + +- I enjoy old things. Can you backport this to Minecraft 1.7? - No. We will only focus on supporting the most recently released version of Minecraft. -- I found a problem! Do I just post a comment on your CurseForge page? - - You **could**, but we'd prefer it if you posted an issue on [our GitHub repository's issue tracker](https://github.com/RandomMcSomethin/fallingleaves/issues). It makes it far easier for us to follow up when developing new versions of this mod. -- I have an idea for something you could do with this mod! - - Great, we're always happy to hear you out! Use the issue tracker on our Github Repo to post your suggestions. + +- I found a problem / have an idea! Do I just post a comment on your CurseForge page? + - You **could**, but we'd prefer it if you posted an issue on [our GitHub repository's issue tracker](https://github.com/RandomMcSomethin/fallingleaves/issues). + It makes it far easier for us to follow up when developing new versions of this mod. + - Can I include this mod in my modpack? - - Absolutely! Just remember to put a link to our Curseforge page somewhere in your modpack's documentation. + - Absolutely! Just remember to put a link to our CurseForge page somewhere in your modpack's documentation. + - What do you get if you jumble the letters in "Falling Leaves Mod"? - You get "Five Golden Llamas". We're still not sure if this means anything in particular... - + ## Thanks and Credits All good developers learn from reading code other people have written, and it's only fair to credit those who have inspired us. For that reason, we give thanks to: