tModLoader

tModLoader

 This topic has been pinned, so it's probably important
Munin 14 Sep, 2023 @ 12:18am
Readme — General Information
tModLoader 1.3, 1.4, 1.4.4
There are tModLoader releases available for 1.3, 1.4.3, and 1.4.4 versions of Terraria. Currently the default tModLoader is the 1.4.4 version, but if you want to play a legacy version of tModLoader, the instructions on our GitHub explain how to switch between versions.

GOG Install
GOG users should follow the manual install instructions: Over here!

Support
If tModLoader isn't launching or you are experiencing other bugs, please ask for help in the ⁠support forum on our Discord. The pins in the ⁠support forum also have some solutions to frequent issues. Please do not make issues on GitHub for support issues.



Porting Instructions
Every month tModLoader updates to a new version. These updates sometimes change methods to allow more functionality. You might find that your mod code has errors due to a tModLoader update. The migration guide teaches how to update a mod to new tModLoader versions. It teaches how to run tModPorter to fix the majority of syntax changes and explains the code changes you'll have to be aware of to port your mod successfully. Be aware that examples on the wiki might be outdated, please let us know if you find anything that is incorrect.

Your primary resource is the Migration Guide. A second resource is the stable ExampleMod. Finally, the documentation can be helpful.
  • Migration Guide
  • ExampleMod (To download ExampleMod source code to your computer rather than view online, download 1.4-stable and then find the ExampleMod folder within. If you are on preview, change the url to -preview instead of -stable)
  • Documentation



Maintaining Your Mod
Each month, default tModLoader updates to a new version with new functionality. This new version contains changes that might break your mod. We attempt to make breakages only affect the modder, making the mod unable to build until the code is fixed, but very rarely a change will break the mod for users, making the mod refuse to load.

To smoothly transition each month, we use the preview-v2023.X steam beta branch to test upcoming code changes. At the start of each month, the changes present in the preview-v2023.X branch will be brought to stable for all users. The preview-v2023.X branch allows modders to test new features before they go live. It also allows mods affected by the change to publish an update in anticipation of the changes going out to all users.

Modders should keep an eye on ⁠#preview-update-log on our Discord and look for breaking changes related to functionality in your mods. If there is something listed with Runtime Breakage related to your mod, you should join the preview-v2023.X branch and publish an update before the start of the next month so that your users can continue using your mod seamlessly. If related changes are only listed as Source-code Breakage, there is no urgency and you will just need to follow the Porting Notes section after the changes are live.



Bugs
Bugs are tracked on GitHub. Current bugs and issues are can be found on GitHub.

If you are experiencing an issue, please check the listing to see if the issue or bug is already documented. If it is, reacting to the issue with the 👍(thumbs up) reaction will let us know that you are affected by it. If you have more relevant information to add, please add a comment as well. (The listing might be incomplete, as it only shows issues with a specific label, you should also search all issues by clicking "Clear current search query, filters, and sorts" button and then searching for a key word)

As we work on tModLoader, we'll try to prioritize the issues with that most 👍 (thumbs up) reactions so that we can fix the biggest issues first.

To add the 👍(thumbs up) reaction, click on the smile icon at the bottom left corner of the issue description, then click on 👍 (thumbs up): If you can't find it, here is a picture.



Helpful Links
Donating
We really appreciate you for being here and using tModLoader.
The best way to support us is by becoming a patron
on our Patreon page. You can choose an amount to pay (monthly) to support us.

Becoming a Patron comes with many rewards! This includes a custom Discord role!
Check our Patreon page for more information.
Last edited by Munin; 18 Sep, 2023 @ 7:06am