|
|
- <!DOCTYPE html>
- <!--[if IE]><![endif]-->
- <html>
-
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
- <title>Contributing </title>
- <meta name="viewport" content="width=device-width">
- <meta name="title" content="Contributing ">
- <meta name="generator" content="docfx 2.48.1.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 rel="stylesheet" href="../styles/fix.css">
- <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
- <meta property="docfx:navrel" content="../toc.html">
- <meta property="docfx:tocrel" content="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="articles.contributing">
- <h1 id="contributing">Contributing</h1>
-
- <h2 id="prerequisites">Prerequisites</h2>
- <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>
- <li>Beat Saber (if developing for .NET 4.5+)</li>
- <li>Muse Dash (if developing for .NET 3.5)</li>
- </ul>
- <h2 id="building">Building</h2>
- <ol>
- <li>Clone with <code>git clone https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded.git --recursive</code></li>
- <li><p>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.</p>
- <pre><code>C:/Program Files (x86)/Steam/steamapps/common/Beat Saber/
- </code></pre><p>If you intend to be doing .NET 3.5 centric development, you must put your Muse Dash installation folder in a file named <code>mdinstalldir.txt</code> that is otherwise identical to
- <code>bsinstalldir.txt</code>.</p>
- </li>
- <li><p>Open <code>BSIPA.sln</code> in Visual Studio.</p>
- </li>
- <li>Choose the configuration that you intend to target during development.</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/<Configuration></code> to be what
- should be copied to the game directory.</p>
- <p>When making a change to Mod List, you only need to build Mod List itself. Install by copying everything in <code>path/to/solution/BSIPA-ModList/bin/<Configuration></code> to your game
- directory.</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/7e2f34d5f29a860019b2b412a601924661a92e45/docs/articles/contributing.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>
|
