mirror of
https://github.com/BepInEx/BepInEx.git
synced 2026-10-20 01:46:13 +00:00
Update build guide
This commit is contained in:
1 parent
ab4ce9ecce
commit
0f0bebb018
1 file changed
+10
-14
+10
-14
@@ -1,10 +1,10 @@
|
||||
# Building BepInEx
|
||||
|
||||
You can build BepInEx two ways: by using MSBuild-compatible IDE or the CakeBuild script.
|
||||
You can build BepInEx two ways: by using `dotnet` or by using the automated build project.
|
||||
|
||||
## CakeBuild script
|
||||
|
||||
You can use the included [cakebuild](https://cakebuild.net/) script that allows you to automatically get dependencies, build and package everything.
|
||||
You can use the included `build` projected based on [cakebuild](https://cakebuild.net/) that allows you to automatically get dependencies, build and package everything.
|
||||
|
||||
**CakeBuild requires [.NET 6.0](https://dotnet.microsoft.com/download) or newer to be installed**
|
||||
|
||||
@@ -14,7 +14,7 @@ Clone this repository via `git clone https://github.com/BepInEx/BepInEx.git`.
|
||||
After that, run in the repository directory
|
||||
|
||||
```bat
|
||||
build.bat --target=Build
|
||||
build.cmd --target Compile
|
||||
```
|
||||
|
||||
### Windows (PowerShell)
|
||||
@@ -23,7 +23,7 @@ Clone this repository via `git clone https://github.com/BepInEx/BepInEx.git`.
|
||||
After that, run in the repository directory
|
||||
|
||||
```ps
|
||||
./build.ps1 --target=Build
|
||||
./build.ps1 --target Compile
|
||||
```
|
||||
|
||||
Make sure you have the execution policy set to enable running scripts.
|
||||
@@ -34,19 +34,15 @@ Clone this repository via `git clone https://github.com/BepInEx/BepInEx.git`.
|
||||
After that, run in the repository directory
|
||||
|
||||
```sh
|
||||
./build.sh --target=Build
|
||||
./build.sh --target Compile
|
||||
```
|
||||
|
||||
### Additional build targets
|
||||
|
||||
The build script provides the following build targets (that you can pass via the `target` parameter)
|
||||
|
||||
| Target | Description |
|
||||
| ------------- | ------------------------------------------------------------------------ |
|
||||
| `Build` | Pulls dependencies and builds BepInEx |
|
||||
| `MakeDist` | Runs `Build` and creates distributable packages into `bin/dist` folder |
|
||||
| `Pack` | Runs `MakeDist` and zips everything into archives into `bin/dist` folder |
|
||||
|
||||
## MSBuild
|
||||
|
||||
Download and IDE (for example Visual Studio), open the solution file and build it.
|
||||
| Target | Description |
|
||||
|------------|----------------------------------------------------------------------------------------------------|
|
||||
| `Compile` | Pulls dependencies and builds BepInEx binaries |
|
||||
| `MakeDist` | Runs `Compile` and creates distributable package for each distribution target to `bin/dist` folder |
|
||||
| `Publish` | Runs `MakeDist` and zips everything into archives into `bin/dist` folder |
|
||||
Reference in new issue
Block a user