Improved CSharp documentation

2024-08-25 14:06:17 -03:00
parent 74d27d8fd3
commit 3788e4641c
15 changed files with 3027 additions and 861 deletions
@@ -0,0 +1,22 @@
+# Introduction
+
+**[LuaCsForBarotrauma](https://github.com/evilfactory/LuaCsForBarotrauma)** also provides a way to write custom CSharp mods for %Barotrauma. Since this type of mod is not sandboxed, it's disabled by default and must be enabled in the LuaCs Settings menu.
+
+If you are wondering how to get started with CSharp modding, this guide is for you. It will walk you through the process of setting up a new C# mod project, and provide you with a simple example to get you started.
+
+## Enabling
+
+To enable CSharp mod loading, you will have to go to your mainmenu, click top left LuaCs Settings, and enable the `Enable CSharp` option. If you do not have CSharp enabled and you join a server that has CSharp mods, you will receive a popup asking if you want to enable it for that session.
+
+You can also enable by setting the `EnableCSharp` option in the `LuaCsConfig.xml` file found in the game root folder to `true`.
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<LuaCsSetupConfig EnableCsScripting="true" TreatForcedModsAsNormal="false" PreferToUseWorkshopLuaSetup="false" DisableErrorGUIOverlay="false" HideUserNames="true" />
+```
+
+## Development
+
+- [In-memory CSharp Mod](/md_manual_2inmemorymod.html)
+- [Assembly CSharp Mod](/md_manual_2assemblymod.html)
+- [Using Harmony](/md_manual_2harmony.html)
+