Skip to content
This repository was archived by the owner on May 9, 2023. It is now read-only.

Commit 4d74724

Browse files
authored
Update README.md
1 parent accff9d commit 4d74724

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,28 @@
33
[![Version](https://img.shields.io/badge/BepInEx-5.X-green.svg)](https://github.com/BepInEx/BepInEx)
44
[![Version](https://img.shields.io/badge/Partiality-0.3.1-green.svg)](https://github.com/PartialityModding/Partiality)
55

6-
The **BepInEx-Partiality-Wrapper** allows Partiality mods to run in BepInEx (5.X).
6+
The **BepInEx-Partiality-Wrapper** allows you to run [Partiality](https://github.com/PartialityModding) mods for Unity games without Partiality Launcher, by using [BepInEx](https://github.com/BepInEx/BepInEx) to load them instead. Existing Partiality mods can be loaded without any changes.
7+
8+
This tool will generate the `HOOKS-Assembly-CSharp.dll` file to the `BepInEx\plugins\PartialityWrapper\` folder, and will regenerate it each time the game receives an update. This is done as a preloader patch so that the new assembly is generated before any plugins are loaded.
79

810
## Install
911

1012
Installation is pretty straight-forward:
1113

1214
* Install [BepInEx 5.X](https://github.com/BepInEx/BepInEx/releases)
1315
* [Download the latest PartialityWrapper release](https://github.com/sinai-dev/BepInEx-Partiality-Wrapper/releases/latest)
14-
* Extract the zip file and put the contents into your Game folder, making sure you merge with the existing BepInEx folder.
15-
* It should look like `[game]\BepInEx\patchers\PartialityWrapper\...` and `[game]\BepInEx\plugins\PartialityWrapper\...`.
16+
* Extract the zip file and put the contents into your Game folder, making sure you merge with the existing BepInEx folder. It should look like `[game]\BepInEx\patchers\PartialityWrapper\...` and `[game]\BepInEx\plugins\PartialityWrapper\...`.
1617
* **Run the game once** to generate the necessary files and folders.
17-
* If you see the file `BepInEx\plugins\PartialityWrapper\HOOKS-Assembly-CSharp.dll` then you did it correctly.
18+
* If you see the folder `BepInEx\plugins\partiality-plugins\` then you did it correctly.
1819

1920
## Adding Partiality Mods
2021

2122
PartialityWrapper supports two folders where you can place your Partiality mods:
2223

23-
* `[game]\BepInEx\plugins\partiality-mods\` - generated after first launch, the recommended folder to use.
24-
* `[game]\Mods\` - the legacy Partiality folder for mods, in case the mod **requires** this structure.
24+
* `[game]\BepInEx\plugins\partiality-mods\` - generated after first launch
25+
* `[game]\Mods\` - the legacy Partiality folder for mods
2526

26-
Both folders allow you to place the mods inside sub-folder(s).
27+
Both folders allow you to place the mods inside subfolders.
2728

2829
## Credits
2930
Written by Sinai, with help from:

0 commit comments

Comments
 (0)