diff --git a/README.md b/README.md index 018c8ee2c..681008311 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ See [forgehax](https://github.com/fr1kin/forgehax) for a more polished equivalen This is by no means a finished project and isn't fully ready for release. +## Troubleshooting +Please reference the main troubleshooting page: [Troubleshooting](https://github.com/zeroeightysix/KAMI/blob/master/TROUBLESHOOTING.md) +If you experience an issue and it's not listed there, please [open a new issue](https://github.com/zeroeightysix/KAMI/issues/new) and a contributor will help you further. + ## Contributing You are free to clone, modify KAMI and make pull requests as you wish. To set up your development environment, make use of the following commands: @@ -24,7 +28,7 @@ Import KAMI into your IDE of choice. If you use intelliJ, import from the `build If you do not wish to run from an IDE, use `./gradlew.bat runClient` to run KAMI. -### Building1.12.2 +### Building ``` ./gradlew.bat build diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md new file mode 100644 index 000000000..fdd192d75 --- /dev/null +++ b/TROUBLESHOOTING.md @@ -0,0 +1,24 @@ +# Troubleshooting + +This page is meant to explain how to solve common issues when installing or using KAMI. If you experience an issue and it's not listed here, please [open a new issue](https://github.com/zeroeightysix/KAMI/issues/new) and a contributor will help you further. + +## Setup +###### Could not find tools.jar +If you encounter this error when building, you most likely don't have the Java Development Kit (JDK) installed. +Head over to [here](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) to download the oracle JDK. Install it and try again. + +###### Minecraft not loading at all +What `.jar` are you using in your `mods` folder? Make sure to use the one that ends with `-full` (`KAMI-MCVER-KAMIVER-full.jar`) + +## Crashes in-game + +**Please make sure you're on the latest version of forge before proceeding!** + +###### java.lang.NoSuchMethodError: net.minecraft.client.multiplayer.WorldClient.isPlayerUpdate()Z +Are you using MultiMC? If so, move minecraft above LWJGL 2 to solve this issue. +Start on the main screen of MultiMC. +1. Select your KAMI instance. +2. Press `Edit Instance` +3. Press `Version` (Top left) +4. Select `Minecraft` +5. Press `Move up` until it is the first entry in the list. \ No newline at end of file