diff --git a/README.md b/README.md index 93aee86..06bf1cf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ -# ExamplePatchMod -Example Patch Mod For BepInEx & Stationeers +# Setup + +Follow these steps to prepare your Stationeers mod project: + +1. **Download the Repository** + - Either download the ZIP or clone the repo to your PC. + +2. **Rename the Folder** + - Change the folder name to your mod’s name. + *Example:* `MyStationeersMod` + +3. **Open the Solution** + - Open the `.sln` file in Visual Studio. + +4. **Update Project References** + - In the **Solution Explorer**, press `CTRL + A` to select all files. + - Press `CTRL + F` to open the **Find and Replace** window. + - Find all instances of `ExamplePatchMod` and replace them with your mod name, e.g., `MyStationeersMod`. + - Click **Replace All**. + +5. **Update Project Properties** + - On the top menu, go to **Project → [YourModName] Properties**. + - Change both the **Assembly Name** and **Default Namespace** from `ExamplePatchMod` to your mod name.