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.
 
 
 
 
Anairkoen Schno 0d3ea2c6e3 Added injector for PluginMetadata 5 years ago
BSIPA-ModList Added null check to DownloadProgressCell (because apparently Init wasn't being called?) 5 years ago
BuildTools@77fbb3498b Updated BuildTools to point to BSMG Repo 5 years ago
Doorstop@0f76cf26a2 Made BSIPA game agnostic 5 years ago
IPA Version bump 5 years ago
IPA.Injector Added some error checking 5 years ago
IPA.Loader Added injector for PluginMetadata 5 years ago
IPA.Tests Finished migration to new locations 6 years ago
Libs Started rewrite of loader 5 years ago
Refs Added injector for PluginMetadata 5 years ago
.gitignore Added a rate limiter of sorts to StandardLogger 5 years ago
.gitmodules Updated BuildTools to point to BSMG Repo 5 years ago
BSIPA.sln Removed 'Any CPU' build target that doesn't work anyway 5 years ago
BSIPA.sln.DotSettings Finished Features implimentation 5 years ago
LICENSE Update LICENSE 5 years ago
README.md Added note to README, per #9 5 years ago
appveyor.yml Version bump 5 years ago

README.md

BSIPA Build status

Beat Saber IPA - The mod injector tailored for Beat Saber

How To Install

  1. Download a release (https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/releases)
  2. Extract the contents into the game folder
  3. Run IPA.exe
  4. Start the game as usual

A console window should open before the game starts if the installation was successful.

To disable this console window, pass --no-console to the game.

How To Uninstall

  1. Drag & drop the game exe onto IPA.exe while holding Alt
    • Or run ipa -rn in a command window

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
  • See -h or --help for more options.

Unconsumed arguments will be passed on to the game in case of --launch.

How To Develop

  1. Create a new Class Library C# project (.NET 4.6)
  2. Download a release and add IPA.Loader.dll to your references
  3. Implement IBeatSaberPlugin or IEnhancedBeatSaberPlugin
  4. Build the project and copy the DLL into the Plugins folder of the game.

See Developing for more information.

How To Keep The Game Patched

BSIPA will automatically repatch the game when it updates, as long as winhttp.dll is present in the install directory.

Notes for running under Wine

For some reason, by default, Wine does not load DLLs in quite the same way that Windows does, causing issues with the injection. To make the injection work with Wine, winhttp has to have a DLL override set to native,builtin. This can be set either through Protontricks, or with the following .reg file.

REGEDIT4
[HKEY_CURRENT_USER\Software\Wine\DllOverrides]
"winhttp"="native,builtin"

Building

Prerequisites

  • Microsoft Visual Studio 2019 or later
  • Tools for C/C++ (MSVC) v141
  • .NET 4.6.1 SDK and .NET 4.7.2 SDK

Building

  1. Clone with git clone https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded.git --recursive
  2. Create a file, bsinstalldir.txt in the solution root. Do NOT create this in Visual Studio; VS adds a BOM at the begginning of the file that the tools used cannot read. It should contain the path to your Beat Saber installation, using forward slashes with a trailing slash. e.g.
C:/Program Files (x86)/Steam/steamapps/common/Beat Saber/
  1. Open BSIPA.sln in Visual Studio.
  2. Choose the configuration x64
  3. Rebuild all. Any time you make a change, ALWAYS Rebuild All.

When building a Debug build, all referenced assemblies from Beat Saber will be copied from the install directory provided in bsinstalldir.txt into Refs/. Any new references should reference the copy in there. When building for Release, it just uses the files already in Refs/