From b6230442df50a0a6ebf3c18cc84ac82152a74e68 Mon Sep 17 00:00:00 2001 From: Anairkoen Schno Date: Thu, 9 May 2019 16:18:26 -0500 Subject: [PATCH] Updated README to contain more useful build instructions --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2d2224db..b5ec80f1 100644 --- a/README.md +++ b/README.md @@ -59,19 +59,27 @@ REGEDIT4 ### Prerequisites -- Microsoft Visual Studio 2019 or later +- 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/ -``` +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` -5. Rebuild all. Any time you make a change, ALWAYS Rebuild All. +5. Rebuild all. + + When you make a change somewhere in BSIPA itself, right click on `IPA` and click `Build`. This sets up the output in `path/to/solution/IPA/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/` \ No newline at end of file +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/` \ No newline at end of file