> For the complete documentation index, see [llms.txt](https://stoneforgeteam.gitbook.io/stoneforgeteam-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://stoneforgeteam.gitbook.io/stoneforgeteam-docs/getting-started/installation.md). # Installation ## Requirements * Stoneshard (Steam), on the default (native) branch or the **VM modbranch**. Mods with GML of their own, and MSL mods, need the VM modbranch: see [Native and VM branches](/stoneforgeteam-docs/getting-started/game-branches.md). * The **.NET 10 Windows Desktop Runtime, x64**: [download](https://dotnet.microsoft.com/download/dotnet/10.0). It covers every kind of mod. The base .NET 10 Runtime is enough for StoneForge's own C# mods, but [MSL mods](/stoneforgeteam-docs/getting-started/msl-mods.md) need the Desktop one. The installer tells you if it's missing. StoneForge uses UndertaleModLib 0.9.2.0 and Underanalyzer directly to patch game data. Game data is read from your local install. ## Install 1. Close Stoneshard. 2. Download `StoneForge-.zip` from the [StoneForge releases](https://github.com/StoneForgeTeam/StoneForge/releases), extract it and run `Install StoneForge.cmd`. It finds Stoneshard through Steam (or asks for its folder), copies StoneForge in, and sets the game up. Your game's own files are kept, so it can all be undone. 3. Start Stoneshard as usual. The main menu has a Mods button. Re-running the installer from a newer release updates an existing installation. After switching Steam branch, install again: each build has its own game files. ## Mods Mod folders go in `\mods`. Open the in-game Mods window to enable or disable them. Enabling or reloading C# mods there (or **Enable all**) shows the loading screen, with each mod as it loads and any that fail, then returns to the Mods window. To report a problem with StoneForge or a mod, use **Report a bug** in the Esc menu: see [Bug reports](/stoneforgeteam-docs/getting-started/bug-reports.md). MSL mods (`.sml` files) go directly in `\mods` too, on the VM modbranch: see [MSL mods](/stoneforgeteam-docs/getting-started/msl-mods.md). {% hint style="warning" %} GML mods carry a warning: their scripts execute directly in GameMaker, outside the C# source restrictions, and need a game restart after edits. They run only on the **VM modbranch**: on the native branch they aren't loaded. See [GML bindings](/stoneforgeteam-docs/gml-and-c-code/gml-bindings.md). {% endhint %} ## Steam updates Game updates and Steam's "Verify integrity of game files" put the game's own `StoneShard.exe` back, which turns StoneForge off until you install it again. To have it put back automatically, set Stoneshard's launch options in Steam (right-click Stoneshard > Properties > General > Launch options) to: ``` "\dotnet\patcher\StoneForge.Patcher.exe" run %command% ``` The installer prints this line with your game's folder filled in. ## Uninstall Close Stoneshard and run `Uninstall StoneForge.cmd`. The game's own files are put back and StoneForge's removed; your mods folder is kept. ## What it changes in the game folder * `StoneShard.exe` is patched to load StoneForge (the original is kept as `StoneShard.exe.vanilla`). * `data.win` gets StoneForge's additions (the original is kept as `dotnet\data_base.win`). On the native branch these are only objects with no code: mods' objects and the loader's own. * With MSL mods, `dotnet\patcher\msl\` holds the bundled MSL helper and `dotnet\msle\` MSL Enhanced; `dotnet\msl-patch.log` is their log, and `dotnet\msl-audio-base\` keeps the originals of sounds, fonts and shaders Enhanced mods replace. * `AurieCore.dll`, `aurie\` and `dotnet\` hold StoneForge itself; `mods\` holds your mods. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://stoneforgeteam.gitbook.io/stoneforgeteam-docs/getting-started/installation.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.