Home

Boss Rush API Mod Wiki

Welcome!

Here, you will find information on how to use the API.

If you have issues about the mods (API and Example Boss Rush), please create an issue.

Getting Started

To get started working with the API, you will need to add a reference to the Boss Rush API DLL file into an existing mod project. To obtain the DLL file, you can use tModLoader's Extract feature. Follow these steps:

1. Open tModLoader.
2. Click Workshop.
3. Click Manage Mods.
4. Find the Boss Rush API mod from the list. Once found, click the ? button on the right side.
5. At the bottom of the description box, click the Extract button.
6. A folder should open through File Explorer. The DLL file will be there.

FAQs

Why the need for a hard dependency?

It makes our lives much easier in the long run. The API mod won't take much resources anyway since it is just a system that handles the event. Everything else is up to the implementation of the mods using this API.

Why not use a soft dependency?

I simply have not implemented the methods through Mod.Call yet. The API mod uses struct to store data, and they contain a lot of information. I don't think it is feasible to pack them all into Mod.Call. It is possible, however, if I can make the API mod to be segregated into smaller parts.

What is the goal of the API?

It is so that players and modders can create their own boss rush events according to the balance of their content mods. The API mod is designed to be as flexible as possible. It is still in its early stages, but it is currently usable now.

I have a big content mod. Should I use this API?

It is up to you. If you want to create a boss rush event for your mod, then you can use this API. However, I am more inclined to have the boss rush event in a separate mod so that whenever a deprecation happens, the content mod will not be affected in any way.

Can I use bosses from other Mods to be part of the boss rush event?

Absolutely! Thanks to tModLoader, that should be easy to do. Just remember to dynamically get their type to make this work properly. You may need to add dependencies from these mods; both soft and hard dependencies are fine from the content mods but not Boss Rush API.