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.

163 lines
7.5 KiB

  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Installing BSIPA </title>
  8. <meta name="viewport" content="width=device-width">
  9. <meta name="title" content="Installing BSIPA ">
  10. <meta name="generator" content="docfx 2.43.3.0">
  11. <link rel="shortcut icon" href="../favicon.ico">
  12. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  13. <link rel="stylesheet" href="../styles/docfx.css">
  14. <link rel="stylesheet" href="../styles/main.css">
  15. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  16. <meta property="docfx:navrel" content="../toc.html">
  17. <meta property="docfx:tocrel" content="toc.html">
  18. <meta property="docfx:rel" content="../">
  19. <meta property="docfx:newtab" content="true">
  20. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../index.html">
  33. <img id="logo" class="svg" src="../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div class="container body-content">
  54. <div id="search-results">
  55. <div class="search-list"></div>
  56. <div class="sr-items">
  57. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  58. </div>
  59. <ul id="pagination"></ul>
  60. </div>
  61. </div>
  62. <div role="main" class="container body-content hide-when-search">
  63. <div class="sidenav hide-when-search">
  64. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  65. <div class="sidetoggle collapse" id="sidetoggle">
  66. <div id="sidetoc"></div>
  67. </div>
  68. </div>
  69. <div class="article row grid-right">
  70. <div class="col-md-10">
  71. <article class="content wrap" id="_content" data-uid="">
  72. <h1 id="installing-bsipa">Installing BSIPA</h1>
  73. <div class="NOTE"><h5>Note</h5><p>This guide assumes that you are starting completely fresh.</p>
  74. </div>
  75. <ol>
  76. <li><p>Grab a release from the GitHub <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/releases">Releases page</a>.
  77. Make sure to download <code>BSIPA.zip</code>, as <code>ModList.zip</code> contains the Beat Saber mod for showing your mods in-game, not the loader itself.</p>
  78. </li>
  79. <li><p>Extract the zip into your game installation directory. There should now be a folder named <code>IPA</code> and a file named <code>IPA.exe</code> in
  80. the same folder as the game executable.</p>
  81. <p>For example, if you are installing BSIPA in Beat Saber, it might look like this after extraction:</p>
  82. <p><img src="../images/install-extracted.png" alt="What your game directory may look like after extracting BSIPA"></p>
  83. </li>
  84. <li><p>Run <code>IPA.exe</code> by double clicking it. A console window should pop up, and eventually, a gold message asking you to press a key
  85. will appear. Here is an example of a successful installation:</p>
  86. <p><img src="../images/install-successful.png" alt="A successful installation"></p>
  87. <div class="NOTE"><h5>Note</h5><p>In some cases, this may fail, something like this: <img src="../images/install-failed.png" alt="A failing installation"></p>
  88. <p>In these cases, try dragging the game executable over <code>IPA.exe</code>.</p>
  89. </div>
  90. <p>After installing, your game directory should look something like this:
  91. <img src="../images/install-correct.png" alt="A properly installed BSIPA"></p>
  92. <div class="NOTE"><h5>Note</h5><p>At this point it is recommended to run the game once before continuing, to ensure that things are installed correctly.</p>
  93. <p>The first run should create a <code>UserData</code> folder with <code>Beat Saber IPA.json</code> and <code>Disabled Mods.json</code>, as well as a
  94. <code>Logs</code> folder with several subfolders with their own files. If these are created, then the installation was very
  95. likely successful.</p>
  96. </div>
  97. <div class="TIP"><h5>Tip</h5><p>If you are not installing BSIPA on Beat Saber, you probably want to go to the config at <code>UserData/Beat Saber IPA.json</code>
  98. and set both of the following to <code>false</code>:</p>
  99. <pre><code class="lang-json">{
  100. ...
  101. &quot;Updates&quot;: {
  102. &quot;AutoUpdate&quot;: false,
  103. &quot;AutoCheckUpdates&quot;: false
  104. },
  105. ...
  106. }
  107. </code></pre></div>
  108. </li>
  109. <li><p>From here, just place all of your plugins in the <code>Plugins</code> folder, and you&#39;re all set!</p>
  110. <p>Many plugins will come in a zip such that the root of the zip represents the game install directory, so all you may have to
  111. do is extract the plugin into the game installation folder.</p>
  112. </li>
  113. </ol>
  114. <p>Thats really all you have to do! The installation should persist across game updates for as long as <code>winhttp.dll</code> is present in
  115. the game directory, though your plugins will be moved to a different folder when it does update so things don&#39;t break horribly.</p>
  116. </article>
  117. </div>
  118. <div class="hidden-sm col-md-2" role="complementary">
  119. <div class="sideaffix">
  120. <div class="contribution">
  121. <ul class="nav">
  122. <li>
  123. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/3f9d6b4ef9e5cda2e2581178301610b05be2b179/docs/articles/start-user.md/#L1" class="contribution-link">Improve this Doc</a>
  124. </li>
  125. </ul>
  126. </div>
  127. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  128. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  129. </nav>
  130. </div>
  131. </div>
  132. </div>
  133. </div>
  134. <footer>
  135. <div class="grad-bottom"></div>
  136. <div class="footer">
  137. <div class="container">
  138. <span class="pull-right">
  139. <a href="#top">Back to top</a>
  140. </span>
  141. <span>Generated by <strong>DocFX</strong></span>
  142. </div>
  143. </div>
  144. </footer>
  145. </div>
  146. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  147. <script type="text/javascript" src="../styles/docfx.js"></script>
  148. <script type="text/javascript" src="../styles/main.js"></script>
  149. </body>
  150. </html>