Getting Started - Membercat-Studios/Streamlabs-Integration GitHub Wiki

To start off, let's quickly define some of the basic terms we're going to be using when talking about the plugin. This page is designed as a guide for getting started with the plugin, and all of the (linked) terms are organized in the order you should be learning about them!

When someone donates, a Streamlabs event is going to be sent from the server over the API to the plugin. You'll have certain actions configured, which can do things in the server using steps. An action can only respond to one event at a time, and can have certain conditions, limiting when the action will be executed based on data from the event. To prevent players spamming your actions, you might want to add a few rate limiters as well and to make your stream a bit more exciting, you could also add some donation goals.

While doing all of that, you should definitely check out how to use the configuration system. To keep your configuration clean and easy to maintain, you should check out features like functions, custom placeholders and string conditions. Finally, you can look at how to add an in-game scoreboard with the latest donators using the event history and check out misc. features and guides to make sure you've seen everything!

Here's a fancy graph showing how all of those terms relate to each other:

(Chart re-created by @Mazurex, and also outdated 😕)