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.

45 lines
1.6 KiB

6 years ago
6 years ago
6 years ago
  1. # BSIPA [![Build status](https://ci.appveyor.com/api/projects/status/fql702mky0d5bcky?svg=true)](https://ci.appveyor.com/project/nike4613/beatsaber-ipa-reloaded)
  2. Beat Saber IPA - The mod injector tailored for Beat Saber
  3. ## How To Install
  4. 1. Download a release (https://github.com/nike4613/BeatSaber-IPA-Reloaded/releases)
  5. 2. Extract the contents into the game folder
  6. 3. Run **IPA.exe**
  7. 4. Start the game as usual
  8. A console window should open before the game starts if the installation was successful.
  9. To disable this console window, pass `--no-console` to the game.
  10. ## How To Uninstall
  11. 1. Drag & drop the game exe onto **IPA.exe** while holding <kbd>Alt</kbd>
  12. - Or run `ipa -rn` in a command window
  13. 2. Done
  14. ## How To Develop
  15. 1. Create a new **Class Library** C# project (.NET 4.6)
  16. 2. Download a release and add **IPA.Loader.dll** to your references
  17. 3. Implement `IBeatSaberPlugin` or `IEnhancedBeatSaberPlugin`
  18. 4. Build the project and copy the DLL into the Plugins folder of the game.
  19. See [Developing](https://github.com/nike4613/BeatSaber-IPA-Reloaded/wiki/Developing) for more information.
  20. ## How To Keep The Game Patched
  21. BSIPA will automatically repatch the game when it updates, as long as `winhttp.dll` is present in the install directory.
  22. ## Arguments
  23. `IPA.exe file-to-patch [arguments]`
  24. - `--launch`: Launch the game after patching
  25. - `--revert`: Revert changes made by IPA (= unpatch the game)
  26. - `--nowait`: Never keep the console open
  27. - See `-h` or `--help` for more options.
  28. Unconsumed arguments will be passed on to the game in case of `--launch`.