You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

43 lines
1.6 KiB

6 years ago
6 years ago
6 years ago
6 years ago
  1. # IPA
  2. Illusion Plugin Architecture (Reloaded) - let's you inject code into Unity projects.
  3. ## How To Install
  4. 1. Download a release (https://github.com/russianGecko/IPA-Reloaded/releases)
  5. - Download older releases at (https://github.com/Eusth/IPA/releases)
  6. 2. Extract the contents into the game folder
  7. 3. Drag & drop the game exe onto **IPA.exe**
  8. 4. Start the game as usual (the generated shortcut is optional)
  9. **Optional:**
  10. To verify it worked, start the game with the `--verbose` flag. If a new console window opens with debug info, then you're good.
  11. ## How To Uninstall
  12. 1. Drag & drop the game exe onto **IPA.exe** while holding <kbd>Alt</kbd>
  13. 2. Done
  14. ## How To Develop
  15. 1. Create a new **Class Library** C# project (.NET 2.0 to 3.5 (for LINQ))
  16. 2. Download a release and add **IllusionPlugin.dll** to your references
  17. 3. Implement `IPlugin` or `IEnhancedPlugin`
  18. 4. Build the project and copy the DLL into the Plugins folder of the game
  19. Note: You can use the `Logger` class to debug your plugins. Either retrieve an instance using `this.GetLogger()` in your Plugin class or use `new Logger("Mod Name")`.
  20. Use the `--verbose` flag to access the console.
  21. ## How To Keep The Game Patched
  22. 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.
  23. ## Arguments
  24. `IPA.exe file-to-patch [arguments]`
  25. - `--launch`: Launch the game after patching
  26. - `--revert`: Revert changes made by IPA (= unpatch the game)
  27. - `--nowait`: Never keep the console open
  28. Unconsumed arguments will be passed on to the game in case of `--launch`.