CLIPA/README.md

39 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2016-12-14 21:43:23 +00:00
# IPA
2017-04-17 22:37:22 +01:00
Illusion Plugin Architecture (Reloaded) - let's you inject code into Unity projects.
2016-12-15 22:56:44 +00:00
## How To Install
1. Download a release (https://github.com/Eusth/IPA/releases)
2. Extract the contents into the game folder
3. Drag & drop the game exe onto **IPA.exe**
2017-03-14 16:58:49 +00:00
4. Start the game as usual (the generated shortcut is optional)
2016-12-15 22:56:44 +00:00
2017-03-14 16:58:49 +00:00
**Optional:**
2017-01-21 09:23:42 +00:00
To verify it worked, start the game with the `--verbose` flag. If a new console window opens with debug info, then you're good.
2017-01-20 20:44:24 +00:00
## How To Uninstall
1. Drag & drop the game exe onto **IPA.exe** while holding <kbd>Alt</kbd>
2. Done
2016-12-15 22:56:44 +00:00
## How To Develop
2017-04-17 22:37:22 +01:00
1. Create a new **Class Library** C# project (.NET 2.0 to 3.5 (for LINQ))
2016-12-15 22:56:44 +00:00
2. Download a release and add **IllusionPlugin.dll** to your references
3. Implement `IPlugin` or `IEnhancedPlugin`
4. Build the project and copy the DLL into the Plugins folder of the game
## How To Keep The Game Patched
2017-03-14 16:58:49 +00:00
When patching, IPA automatically creates a shortcut that keeps everything up-to-date. This simply makes sure that your DLLs remain patched even after an update.
2017-01-21 09:28:54 +00:00
## Arguments
`IPA.exe file-to-patch [arguments]`
- `--launch`: Launch the game after patching
- `--revert`: Revert changes made by IPA (= unpatch the game)
- `--nowait`: Never keep the console open
Unconsumed arguments will be passed on to the game in case of `--launch`.