Update readme: installation instructions

This commit is contained in:
Ridan Vandenbergh 2018-08-08 20:20:50 +02:00 committed by GitHub
parent 886c9b5424
commit 4b31e598ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,6 +6,21 @@ 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.
## Installing
KAMI is a forge mod. Start by downloading the latest version of [forge](https://files.minecraftforge.net/).
1. Install forge
2. Navigate to your `.minecraft` directory.
* **Windows**: `%appdata%/.minecraft`
* **Linux**: `~/.minecraft`
3. Navigate to the `mods` directory. If it doesn't exist, create it.
4. Obtain the KAMI `.jar` file.
* By **downloading** it: see [releases](https://github.com/zeroeightysix/KAMI/releases)
* By **building** it: see [Building](#building).
5. Place the `.jar` file in your mods directory.
In your .minecraft directory (windows: press `win+r`, type `%appdata%` and hit enter. Find `.minecraft`.; linux: `~/.minecraft`), create a `mods` directory if it doesn't exist yet, and in it put KAMI's `.jar` file
## 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.