Browse Source

Updated README to contain more useful build instructions

pull/11/head
Anairkoen Schno 5 years ago
parent
commit
26de332575
1 changed files with 15 additions and 7 deletions
  1. +15
    -7
      README.md

+ 15
- 7
README.md View File

@ -59,19 +59,27 @@ REGEDIT4
### Prerequisites ### Prerequisites
- Microsoft Visual Studio 2019 or later
- Microsoft Visual Studio 2019 or later (2017 may work, no guarantees)
- Tools for C/C++ (MSVC) v141 - Tools for C/C++ (MSVC) v141
- .NET 4.6.1 SDK and .NET 4.7.2 SDK - .NET 4.6.1 SDK and .NET 4.7.2 SDK
### Building ### Building
1. Clone with `git clone https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded.git --recursive` 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. 3. Open `BSIPA.sln` in Visual Studio.
4. Choose the configuration `x64` 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/<Configuration>` 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/<Configuration>` 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/`
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/`

Loading…
Cancel
Save