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.

41 lines
1.5 KiB

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/nike4613/IPA-Reloaded/releases)
  5. 2. Extract the contents into the game folder
  6. 3. Drag & drop the game exe onto **IPA.exe**
  7. 4. Start the game as usual (the generated shortcut is optional)
  8. **Optional:**
  9. To verify it worked, start the game with the `--verbose` flag. If a new console window opens with debug info, then you're good.
  10. ## How To Uninstall
  11. 1. Drag & drop the game exe onto **IPA.exe** while holding <kbd>Alt</kbd>
  12. 2. Done
  13. ## How To Develop
  14. 1. Create a new **Class Library** C# project (.NET 4.6)
  15. 2. Download a release and add **IPA.Loader.dll** to your references
  16. 3. Implement `IBeatSaberPlugin` or `IEnhancedBeatSaberPlugin`
  17. 4. Build the project and copy the DLL into the Plugins folder of the game.
  18. See [Developing](https://github.com/nike4613/IPA-Reloaded/wiki/Developing) for more information.
  19. ## How To Keep The Game Patched
  20. 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.
  21. ## Arguments
  22. `IPA.exe file-to-patch [arguments]`
  23. - `--launch`: Launch the game after patching
  24. - `--revert`: Revert changes made by IPA (= unpatch the game)
  25. - `--nowait`: Never keep the console open
  26. - See `-h` or `--help` for more options.
  27. Unconsumed arguments will be passed on to the game in case of `--launch`.