diff --git a/docs/files/initial-setup/netsdkdownload.png b/docs/files/initial-setup/netsdkdownload.png new file mode 100644 index 00000000000..becaefbdd52 Binary files /dev/null and b/docs/files/initial-setup/netsdkdownload.png differ diff --git a/docs/files/initial-setup/unityexplorerdownload.png b/docs/files/initial-setup/unityexplorerdownload.png new file mode 100644 index 00000000000..d64d970adee Binary files /dev/null and b/docs/files/initial-setup/unityexplorerdownload.png differ diff --git a/docs/files/publishing-your-mod/thunderstorecreateteam.png b/docs/files/publishing-your-mod/thunderstorecreateteam.png new file mode 100644 index 00000000000..408fc563605 Binary files /dev/null and b/docs/files/publishing-your-mod/thunderstorecreateteam.png differ diff --git a/docs/files/publishing-your-mod/thunderstoresettings.png b/docs/files/publishing-your-mod/thunderstoresettings.png new file mode 100644 index 00000000000..1e09cc73ffc Binary files /dev/null and b/docs/files/publishing-your-mod/thunderstoresettings.png differ diff --git a/docs/files/publishing-your-mod/thunderstoreupload.png b/docs/files/publishing-your-mod/thunderstoreupload.png new file mode 100644 index 00000000000..8801cf29e1d Binary files /dev/null and b/docs/files/publishing-your-mod/thunderstoreupload.png differ diff --git a/docs/files/publishing-your-mod/thunderstoreuploadpackage.png b/docs/files/publishing-your-mod/thunderstoreuploadpackage.png new file mode 100644 index 00000000000..cd24b048068 Binary files /dev/null and b/docs/files/publishing-your-mod/thunderstoreuploadpackage.png differ diff --git a/docs/files/starting-a-mod/csprojexample.png b/docs/files/starting-a-mod/csprojexample.png new file mode 100644 index 00000000000..621478c1026 Binary files /dev/null and b/docs/files/starting-a-mod/csprojexample.png differ diff --git a/docs/files/starting-a-mod/riderbuild.png b/docs/files/starting-a-mod/riderbuild.png new file mode 100644 index 00000000000..f51d917dbd6 Binary files /dev/null and b/docs/files/starting-a-mod/riderbuild.png differ diff --git a/docs/files/starting-a-mod/ridernugetfeeds.png b/docs/files/starting-a-mod/ridernugetfeeds.png new file mode 100644 index 00000000000..dedf6b5970c Binary files /dev/null and b/docs/files/starting-a-mod/ridernugetfeeds.png differ diff --git a/docs/files/starting-a-mod/ridershownugetsources.png b/docs/files/starting-a-mod/ridershownugetsources.png new file mode 100644 index 00000000000..72fc2418e84 Binary files /dev/null and b/docs/files/starting-a-mod/ridershownugetsources.png differ diff --git a/docs/sidebar.md b/docs/sidebar.md index f27cc6dd774..fdc3612da2d 100644 --- a/docs/sidebar.md +++ b/docs/sidebar.md @@ -3,7 +3,10 @@ - **Modding** - [Using r2modman](installing-r2modman) - **Developers** -- [Writing Mods](writing-mods) +- [Initial modding setup](initial-setup) +- [Starting a mod](starting-a-mod) +- [Open-source and ethics](open-source-and-ethics) +- [Publishing your mod](publishing-your-mod) - **Extras** - [Frequently Asked Questions](faq) - **Links** diff --git a/docs/user-guide/modding/initial-setup.md b/docs/user-guide/modding/initial-setup.md index f41156675cb..d074f755183 100644 --- a/docs/user-guide/modding/initial-setup.md +++ b/docs/user-guide/modding/initial-setup.md @@ -11,7 +11,7 @@ An SDK (=Software Development Kit) is a system that allows you to turn your code You'll want to download and install the latest recommended version from [this page](https://dotnet.microsoft.com/en-us/download). It'll look something like this: -[![image](https://github.com/LethalCompany/LethalCompanyModdingWiki/assets/89798523/6cbfe6ac-bc13-4566-a458-f432061f9393)](https://dotnet.microsoft.com/en-us/download) +[![.Net SDK download](../docs/files/initial-setup/netsdkdownload.png)](https://dotnet.microsoft.com/en-us/download) ### IDE @@ -73,7 +73,7 @@ We recommend one (or all) of three free options: You will want to download the version compatible with the latest version of BepInEx (5). -[![image](https://github.com/LethalCompany/LethalCompanyModdingWiki/assets/89798523/56027c1a-dfd8-4b99-8756-a496c7dd18ca)](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.BepInEx5.Mono.zip) +[![Unity Explorer download](../docs/files/initial-setup/unityexplorerdownload.png)](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.BepInEx5.Mono.zip) ### Additional tools (optional) There are a number of BepInEx plugins and tools that might be useful as you get more experienced with modding. The BepInEx devs have helpfully listed them [here](https://docs.bepinex.dev/articles/dev_guide/dev_tools.html). @@ -103,4 +103,4 @@ To create an account, simply go to [GitHub's home page](https://github.com/) and ## Next steps -Now that you've set up everything, you'll want to proceed to the **[starting a mod]()** article! +Now that you've set up everything, you'll want to proceed to the **[starting a mod](starting-a-mod)** article! diff --git a/docs/user-guide/modding/starting-a-mod.md b/docs/user-guide/modding/starting-a-mod.md index 641bde0ea1d..70c19addd53 100644 --- a/docs/user-guide/modding/starting-a-mod.md +++ b/docs/user-guide/modding/starting-a-mod.md @@ -47,9 +47,9 @@ url: https://nuget.bepinex.dev/v3/index.json For Rider, you can do this by going to the NuGet window, going to its `Sources` tab, and then clicking on the green "+" icon in the `Feeds` sub-tab. There, add a new entry using the above configuration. See [Rider's docs](https://www.jetbrains.com/help/rider/Using_NuGet.html#sources) for more info. -![29diyCjTfG](https://github.com/LethalCompany/LethalCompanyModdingWiki/assets/89798523/879e8346-edc2-4841-85f8-7f0da90ee676) +![Show Nuget Sources tab in Rider](../docs/files/starting-a-mod/ridershownugetsources.png) -![image](https://github.com/LethalCompany/LethalCompanyModdingWiki/assets/89798523/e71d17e7-bcd7-45e0-8d8d-bbf0c4002e93) +![Rider Nuget Sources config with BepInEx added](../docs/files/starting-a-mod/ridernugetfeeds.png) For Visual Studio, please follow [this documentation](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio#package-sources). @@ -59,7 +59,7 @@ Mods are developed for specific versions of Unity and .NET, which can be specifi Our [template project](https://github.com/LethalCompany/LethalCompanyTemplate) has an example `.csproj` file that is properly configured, which can be found [here](https://github.com/LethalCompany/LethalCompanyTemplate/blob/main/LethalCompanyTemplate/LethalCompanyTemplate.csproj). Please check and compare your local mod's file with this file, and make sure the following segment is the same (except for the `AssemblyName`, `Description`, and `Version`). -![firefox_2GJuWUWtfR](https://github.com/LethalCompany/LethalCompanyModdingWiki/assets/89798523/412f0870-a806-42ef-a7e7-a3a63c79f6c4) +![Example csproj with Nuget references and proper metadata](../docs/files/starting-a-mod/csprojexample.png) ### "Building" your mod @@ -67,7 +67,7 @@ Your IDE is capable of turning your code into a file that can be run (in this ca Depending on your IDE, the build button may be placed differently. For Rider, it is in the top right: -![image](https://github.com/LethalCompany/LethalCompanyModdingWiki/assets/89798523/fe4bd6d2-8948-4045-a05c-b9703916feea) +![Rider's Build Solution button](../docs/files/starting-a-mod/riderbuild.png) Once built, you should be able to find the `.dll` file in your project's folder, in the following subfolder path (once again replacing `MyFirstPlugin` with the name you gave your mod/project): `MyFirstPlugin/bin/(Release or Debug)/netstandard2.1/MyFirstPlugin.dll` @@ -89,6 +89,6 @@ We highly recommend reading through the rest of the [official BepInEx guide](htt ## Next steps -We recommend reading through our very short guide on [open-source & ethics](), to help foster a healthy modding community. +We recommend reading through our very short guide on [open-source & ethics](open-source-and-ethics), to help foster a healthy modding community. -Once you've finished a mod, you can [publish it](). \ No newline at end of file +Once you've finished a mod, you can [publish it](publishing-your-mod). \ No newline at end of file diff --git a/docs/user-guide/publishing/publishing-your-mod.md b/docs/user-guide/publishing/publishing-your-mod.md index d7e1f12138a..7e094861562 100644 --- a/docs/user-guide/publishing/publishing-your-mod.md +++ b/docs/user-guide/publishing/publishing-your-mod.md @@ -18,11 +18,11 @@ There are a number of reasons we recommend this: First, create an account. Once you've created your account, you'll need to set up a "Team". Do this by going to your account settings, which you can find at the top right of the window, over here: -![lmozQfKP3b](https://github.com/LethalCompany/LethalCompanyModdingWiki/assets/89798523/5edbfa2f-1ad6-47b2-a610-20d1de0a59fb) +![Thunderstore account settings](../docs/files/publishing-your-mod/thunderstoresettings.png) Then, go to the "Teams" tab, and click on "Create Team": -![EHZeKsNd0u](https://github.com/LethalCompany/LethalCompanyModdingWiki/assets/89798523/7b79a775-8dbb-41b4-920e-ab43b5371e63) +![Thunderstore Create Team button](../docs/files/publishing-your-mod/thunderstorecreateteam.png) We recommend using your username as team name, unless you actually have a team and an agreed-upon name for it. @@ -30,11 +30,11 @@ To upload a mod for Lethal Company, you'll first want to go to the [Lethal Compa All you need to do here is press the "Upload" button, which you can find at the top left: -![image](https://github.com/LethalCompany/LethalCompanyModdingWiki/assets/89798523/f17bb9de-8542-47a0-8cb9-6fc0efbef3a9) +![Thunderstore Upload button](../docs/files/publishing-your-mod/thunderstoreupload.png) You'll be met with the following page: -![image](https://github.com/LethalCompany/LethalCompanyModdingWiki/assets/89798523/02ea1513-d063-471a-8d30-f539f95132b5) +![Thunderstore Upload package page](../docs/files/publishing-your-mod/thunderstoreuploadpackage.png) A mod needs to be a specific format to be valid for the Thunderstore. This allows them to present your description, image, and other properties to the users. diff --git a/index.html b/index.html index a8e347e4602..408f94468b2 100644 --- a/index.html +++ b/index.html @@ -44,7 +44,10 @@ '/': '/docs/user-guide/introduction.md', '/installing-r2modman': '/docs/user-guide/installation/installing-r2modman.md', '/installing-r2modman-linux': '/docs/user-guide/installation/installing-r2modman-linux.md', - '/writing-mods': '/docs/user-guide/modding/writing-mods.md', + '/initial-setup': '/docs/user-guide/modding/initial-setup.md', + '/starting-a-mod': '/docs/user-guide/modding/starting-a-mod.md', + '/publishing-your-mod': '/docs/user-guide/publishing/publishing-your-mod.md', + '/open-source-and-ethics': '/docs/user-guide/ethics/open-source-and-ethics.md', '/sidebar.md': '/docs/sidebar.md', '/introduction': '/docs/user-guide/introduction.md', /*