diff --git a/README.md b/README.md index ba87552d..4e4bbb17 100644 --- a/README.md +++ b/README.md @@ -1,87 +1,3 @@ # ![BSIPA](docs/images/banner_dark.svg) [![Build status](https://ci.appveyor.com/api/projects/status/1ruhnnfeudrrd097?svg=true)](https://ci.appveyor.com/project/nike4613/beatsaber-ipa-reloaded-9smsb) -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](https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/wiki/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. - -```reg -REGEDIT4 -[HKEY_CURRENT_USER\Software\Wine\DllOverrides] -"winhttp"="native,builtin" -``` - -For steam there's a per-game wine prefix under compatdata. In this case `SteamLibrary/steamapps/compatdata/620980/pfx/user.reg`. -Changes to this file will likely be ovewritten when beatsaber updates or if local files are validated through steam. - -## Building - -### Prerequisites - -- Microsoft Visual Studio 2019 or later (2017 may work, no guarantees) -- 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/ - ``` -3. Open `BSIPA.sln` in Visual Studio. -4. Choose the configuration `x64-Net4` -5. Rebuild all. - - When you make a change somewhere in BSIPA itself, right click on `BSIPA-Meta` and click `Build` or `Rebuild`. This sets up the output in `path/to/solution/BSIPA-Meta/bin/` to be what - should be copied to the game directory. - - When making a change to the Mod List, you only need to build the mod list. Install by copying everything in `path/to/solution/BSIPA-ModList/bin/` to your game - directory. - -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/` +[ALL DOCUMENTATION HAS MOVED HERE](https://beat-saber-modding-group.github.io/BeatSaber-IPA-Reloaded/) diff --git a/docs/articles/command-line.md b/docs/articles/command-line.md index f1e75f69..74a917a3 100644 --- a/docs/articles/command-line.md +++ b/docs/articles/command-line.md @@ -8,7 +8,7 @@ BSIPA has 2 command lines: the installer, and the game. Their documentation is below. -# [The Installer (`IPA.exe`)](#tab/installer) +## [The Installer (`IPA.exe`)](#tab/installer) The installer has quite a few options, which are documented inline with the `-h` or `--help` flag. @@ -16,7 +16,7 @@ This is what it currently looks like: [!code[IPA command line](_ipa_command_line.txt "the result of IPA.exe -h")] -# [The Game](#tab/game) +## [The Game](#tab/game) The game *also* gets quite a few command line options, though there isn't anything as convenient as a help page for them. @@ -93,4 +93,5 @@ Here's a quick list of what they are and what they do. > > Overrides the config settings `Updates.AutoCheckUpdates` and `Updates.AutoUpdate`. > - \ No newline at end of file + +*** diff --git a/docs/articles/start-user.md b/docs/articles/start-user.md index a9a9224a..6250d25d 100644 --- a/docs/articles/start-user.md +++ b/docs/articles/start-user.md @@ -87,3 +87,10 @@ uid: articles.start.user Thats really all you have to do! The installation should persist across game updates for as long as `winhttp.dll` is present in the game directory, though your plugins will be moved to a different folder when it does update so things don't break horribly. + +## Uninstalling + +Uninstalling is fairly simple, and can be done one of two ways: + +1. Drag the game executable over `IPA.exe` while holding Alt. +2. Open a command prompt or Powershell terminal and run `.\IPA.exe -rn`. (see for what those options mean) diff --git a/docs/index.md b/docs/index.md index 617996cf..c4364e3a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,15 +13,11 @@ Assuming, that is, that Unity 2017 is "new age". ## 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 +See [Installing](xref:articles.start.user) ## How To Uninstall -1. Drag & drop the game exe onto **IPA.exe** while holding Alt - - Or run `ipa -rn` in a command window +See [Uninstalling](xref:articles.start.user#uninstalling) ## Arguments @@ -29,11 +25,6 @@ See . ## 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 `IPA.IPlugin` or `IPA.IEnhancedPlugin` -4. Build the project and copy the DLL into the Plugins folder of the game. - See [Developing](xref:articles.start.dev) for more information. ## How To Keep The Game Patched