DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git

﻿<!DOCTYPE html><!--[if IE]><![endif]--><html>    <head>    <meta charset="utf-8">    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">    <title>  </title>    <meta name="viewport" content="width=device-width">    <meta name="title" content="  ">    <meta name="generator" content="docfx 2.45.0.0">        <link rel="shortcut icon" href="favicon.ico">    <link rel="stylesheet" href="styles/docfx.vendor.css">    <link rel="stylesheet" href="styles/docfx.css">    <link rel="stylesheet" href="styles/main.css">    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">     <meta property="docfx:navrel" content="toc.html">    <meta property="docfx:tocrel" content="articles/toc.html">        <meta property="docfx:rel" content="">    <meta property="docfx:newtab" content="true">  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">    <div id="wrapper">      <header>                <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">          <div class="container">            <div class="navbar-header">              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">                <span class="sr-only">Toggle navigation</span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>              </button>                            <a class="navbar-brand" href="index.html">                <img id="logo" class="svg" src="logo.svg" alt="">              </a>            </div>            <div class="collapse navbar-collapse" id="navbar">              <form class="navbar-form navbar-right" role="search" id="search">                <div class="form-group">                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">                </div>              </form>            </div>          </div>        </nav>                <div class="subnav navbar navbar-default">          <div class="container hide-when-search" id="breadcrumb">            <ul class="breadcrumb">              <li></li>            </ul>          </div>        </div>      </header>      <div class="container body-content">                <div id="search-results">          <div class="search-list"></div>          <div class="sr-items">            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>          </div>          <ul id="pagination"></ul>        </div>      </div>      <div role="main" class="container body-content hide-when-search">                <div class="sidenav hide-when-search">          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>          <div class="sidetoggle collapse" id="sidetoggle">            <div id="sidetoc"></div>          </div>        </div>        <div class="article row grid-right">          <div class="col-md-10">            <article class="content wrap" id="_content" data-uid=""><h1 id="beat-saber-ipa-reloadedimagesbannerdarksvg-build-statushttpsciappveyorcomapiprojectsstatus1ruhnnfeudrrd097svgtruehttpsciappveyorcomprojectnike4613beatsaber-ipa-reloaded-9smsb"><img src="images/banner_dark.svg" alt="Beat Saber IPA Reloaded"> <a href="https://ci.appveyor.com/project/nike4613/beatsaber-ipa-reloaded-9smsb"><img src="https://ci.appveyor.com/api/projects/status/1ruhnnfeudrrd097?svg=true" alt="Build status"></a></h1>
<p>Beat Saber IPA - The mod injector tailored for Beat Saber</p><h2 id="how-to-install">How To Install</h2><ol><li><a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/releases">Download a release</a></li><li>Extract the contents into the game folder</li><li>Run <strong>IPA.exe</strong></li><li>Start the game as usual</li></ol><p>A console window should open before the game starts if the installation was successful.</p><p>To disable this console window, pass <code>--no-console</code> to the game.</p><h2 id="how-to-uninstall">How To Uninstall</h2><ol><li>Drag &amp; drop the game exe onto <strong>IPA.exe</strong> while holding <kbd>Alt</kbd><ul><li>Or run <code>ipa -rn</code> in a command window</li></ul></li></ol><h2 id="arguments">Arguments</h2><p><code>IPA.exe file-to-patch [arguments]</code></p><ul><li><code>--launch</code>: Launch the game after patching</li><li><code>--revert</code>: Revert changes made by IPA (= unpatch the game)</li><li><code>--nowait</code>: Never keep the console open</li><li>See <code>-h</code> or <code>--help</code> for more options.</li></ul><p>Unconsumed arguments will be passed on to the game in case of <code>--launch</code>.</p><h2 id="how-to-develop">How To Develop</h2><ol><li>Create a new <strong>Class Library</strong> C# project (.NET 4.6)</li><li>Download a release and add <strong>IPA.Loader.dll</strong> to your references</li><li>Implement <code>IBeatSaberPlugin</code> or <code>IEnhancedBeatSaberPlugin</code></li><li>Build the project and copy the DLL into the Plugins folder of the game.</li></ol><p>See <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/wiki/Developing">Developing</a> for more information.</p><h2 id="how-to-keep-the-game-patched">How To Keep The Game Patched</h2><p>BSIPA will automatically repatch the game when it updates, as long as <code>winhttp.dll</code> is present in the install directory.</p><h2 id="notes-for-running-under-wine">Notes for running under Wine</h2><p>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, <code>winhttp</code> has to have a DLL override set to <code>native,builtin</code>. This can be set either throughProtontricks, or with the following <code>.reg</code> file.</p><pre><code class="lang-reg">REGEDIT4[HKEY_CURRENT_USER\Software\Wine\DllOverrides]&quot;winhttp&quot;=&quot;native,builtin&quot;</code></pre><p>For Steam there&#39;s a per-game Wine prefix under <code>compatdata</code>. In this case <code>SteamLibrary/steamapps/compatdata/620980/pfx/user.reg</code>.Changes to this file will likely be ovewritten when the game updates or if local files are validated through Steam.</p><h2 id="developing-bsipa-itself">Developing BSIPA itself</h2><h3 id="prerequisites">Prerequisites</h3><ul><li>Microsoft Visual Studio 2019 or later (2017 may work, no guarantees)</li><li>Tools for C/C++ (MSVC) v141</li><li>.NET 4.6.1 SDK and .NET 4.7.2 SDK</li></ul><h3 id="building">Building</h3><ol><li>Clone with <code>git clone https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded.git --recursive</code></li><li>Create a file, <code>bsinstalldir.txt</code> 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. <code>C:/Program Files (x86)/Steam/steamapps/common/Beat Saber/</code></li><li>Open <code>BSIPA.sln</code> in Visual Studio.</li><li>Choose the configuration <code>x64-Net4</code></li><li><p>Rebuild all. </p><p>When you make a change somewhere in BSIPA itself, right click on <code>BSIPA-Meta</code> and click <code>Build</code> or <code>Rebuild</code>. This sets up the output in <code>path/to/solution/BSIPA-Meta/bin/&lt;Configuration&gt;</code> to be whatshould be copied to the game directory.</p><p>When making a change to the Mod List, you only need to build the mod list. Install by copying everything in <code>path/to/solution/BSIPA-ModList/bin/&lt;Configuration&gt;</code> to your gamedirectory.</p></li></ol><p>When building a Debug build, all referenced assemblies from Beat Saber will be copied from the install directory provided in <code>bsinstalldir.txt</code> into <code>Refs/</code>. Any new references should reference the copy in there. When building for Release, it just uses the files already in <code>Refs/</code></p></article>          </div>                    <div class="hidden-sm col-md-2" role="complementary">            <div class="sideaffix">              <div class="contribution">                <ul class="nav">                  <li>                    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/a87bebd670362a56e329e28a9044bc622fcba575/docs/index.md/#L1" class="contribution-link">Improve this Doc</a>                  </li>                </ul>              </div>              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->              </nav>            </div>          </div>        </div>      </div>            <footer>        <div class="grad-bottom"></div>        <div class="footer">          <div class="container">            <span class="pull-right">              <a href="#top">Back to top</a>            </span>                        <span>Generated by <strong>DocFX</strong></span>          </div>        </div>      </footer>    </div>        <script type="text/javascript" src="styles/docfx.vendor.js"></script>    <script type="text/javascript" src="styles/docfx.js"></script>    <script type="text/javascript" src="styles/main.js"></script>  </body></html>