diff --git a/README.md b/README.md index ed40465..f2575cd 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ Proof of concept mod and reference implementation ## Installation -1. Patch Gamecraft with (IPA)[https://github.com/Eusth/IPA]. You will need to build it yourself; the latest release does not work (in the future the latest build will be available for download) -2. Build TestMod solution and copy `obj\\Debug\\net45\\TestMod.dll` into Gamecraft's `Plugins\\` folder (IPA should have created this automatically in the previous step) -3. Launch Gamecraft. You can check the log file `%appdata%\\..\\LocalLow\\FreeJam\\RobocraftX\\Player.log` to confirm +1. Patch Gamecraft with [IPA](https://github.com/Eusth/IPA). +You will need to build it yourself; the latest release does not work (in the future the latest build will be available for download) +2. Build TestMod solution and copy `obj\Debug\net45\TestMod.dll` into Gamecraft's `Plugins\` folder (IPA should have created this automatically in the previous step) +3. Launch Gamecraft. +You can check the log file `%APPDATA%\..\LocalLow\FreeJam\RobocraftX\Player.log` to confirm + +## Development + +Interested in making your own mod? +Clone this repository and modify the Plugin class in `TestMod\TestPlugin.cs`. +More information about the IPlugin and IEnhancedPlugin interface can be found [on the IPA repository](https://github.com/Eusth/IPA)