Skip to content

Home

Jump to bottom
direwolf420 edited this page Apr 22, 2022 · 19 revisions

Welcome to the ClickerClassExampleMod wiki!

This is the Example Mod for the Clicker Class mod. It serves as an up-to-date hub for cross mod interaction with Clicker Class.

Check the sidebar for relevant pages.

You can clone this repo into your Mod Sources folder (here is the tml modding guide if you haven't got that yet) and explore the possibilities.

If you mod on 1.4, checkout/switch to the 1.4 branch.

General Info

First Steps

Depending on what you want to do with your mod, there are a few things to concider/do.

First: Read this guide to familiarize yourself with cross mod concepts.

Then copy this file into your mods root folder (where the build.txt is) and read its comments. It contains everything you need to start working with Clicker Class.

The Rest

If you want to make a hard dependency mod that won't work by itself without Clicker Class, in your build.txt, add

modReference = ClickerClass

If you want to make a soft dependency mod that will work by itself, but will have additional content with Clicker Class, concider doing the following for added content (items, projectiles etc)

  • Override the Autoload hook, and return true/false depending on if ClickerCompat.ClickerClass is null
    • That will make that content not load if Clicker Class isn't loaded
    • You can still use the other calls just fine but they won't do anything (i.e. IsClickerWeapon will always return false since Clicker Class isn't loaded)
  • in your build.txt, add
loadAfter = ClickerClass

That will make sure your mod loads after it, making your logic always follow after Clicker Class, preventing potential value mismatches.

Troubleshooting

If you come across something that doesn't work correctly:

  1. Check that you are using it the same way the examples do
  2. Make sure Clicker Class is actually enabled
  3. There are no exceptions in the logs. You find them in the logs folder. Look for client.log. (NOT the .zip file, the file named client or client.log)

[1.3]

Windows Logs: %UserProfile%\Documents\My Games\Terraria\ModLoader\Logs (This is typically found in C:\Documents)
Linux Logs: ~/.local/share/Terraria/ModLoader/Logs/ or $XDG_DATA_HOME/Terraria/ModLoader/Logs/
Mac Logs: ~/Library/Application support/Terraria/ModLoader/Logs/

[1.4]

For startup issues - Install Directory/tModLoader-Logs/Launch.log
For client issues - Install Directory/tModLoader-Logs/client.log
For server issues - Install Directory/tModLoader-Logs/server.log

(To get to your install directory on Steam - right click tModLoader in the library, then hover over Manage and click on Browse local files.)

  1. If you still have issues, or questions, visit the Thorium Mod discord (for where the clicker class channel is)

That's it, happy modding!

Clone this wiki locally