-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
tModLoader guide for developers
I don't want to create mods, I just want to play with them
I don't want to create mods, I want to contribute to tModLoader another way
If you still need to install tModLoader refer to the tModLoader guide for players.
Before you begin, you will need two things, the ".NET 8 SDK" and a suitable IDE. Once you have these installed, you should start with the Basic tModLoader Modding Guide.
Choose your favorite IDE to mod with tModLoader. Refer to the development section on the homepage. For the best mod making experience, using Visual Studio is highly recommended. Currently 2022 v17.8 or higher is required.
Install the .NET 8 SDK by downloading the installer, running it, and following the instructions. Download the installer for the latest SDK release labeled "x64" corresponding to your operating system. Don't download from links in the column labeled "Binaries". Don't download the .NET 7.0 or .NET 6.0 versions, those will not work.
Click to view visual instructions
To verify that you have the ".NET 8 SDK" properly installed, you can open a new command prompt and type dotnet --list-sdks
and press enter. If you see a result with a version starting with the number 8, it is installed.
The folders shown should show the Program Files
folder not the Program Files (x86)
folder. If you see the 86 folder, that means you installed the 32 bit SDK by accident. You can uninstall it and then install the correct version OR install the correct version and adjust the PATH variable so that the 64 bit SDK shows up instead.
If tModLoader still complains that it can't find the SDK, you may need to restart your computer for the changes to take effect.
If you are new to modding, it is recommended to start with the starter guide. You can then move on to the easy guides.
The following links might be useful for you:
- Our website
- tModLoader documentation
- tModLoader wiki (useful information and guides) -- you are here right now.
- Join our Discord server (requires a free Discord account)
- Basic tModLoader Modding Guide
- Example Mod - A mod showcasing and teaching various tModLoader mod capabilities
- tModLoader's official release thread on TCF
If you made tModLoader mods previously and either want to update your outdated mod or make a new mod, there is a high chance that the tModLoader API has changed. Please read the Update Migration Guide for the versions you missed after reading the tModPorter section. Feel free to ask questions in Discord if you have any questions.