Settings
This function is used to display further messages in the console. This is required in certain support cases. There is corresponding information from Support to activate this. Activation without a reason only leads to further messages in the console or the log, so that the functions continue to be executed and no special functions are activated as a result (only information messages for support).
The Interval option is specified in minutes. StreamingModule checks every X minutes whether viewers are allowed to receive drops on Twitch. The timer is a global timer and runs in the background.
The command “/sm timer” can be used to check when the next drop will be issued.
The DropChance is specified as a percentage. This defines how many viewers should receive a reward per interval. The calculation is carried out as follows:
Current viewers of the streamer * DropChance. At least one viewer will always receive a reward. For the basic number of eligible viewers, all viewers are taken into account, regardless of whether they play Minecraft or not.
This specifies the number of commands to be executed per drop from the list of “Drops”. The number is per viewer. The exact commands are randomly generated per viewer.
This option can be used to control whether viewers can be in several streams at the same time and thus increase the chance of a drop. If the value is set to “false”, the first streamer where the viewer was found is recognized. The viewer is then no longer authorized to receive a drop for the other streamers.
This option can be used to control whether viewers can watch multiple streamers at the same time and therefore increase their chance of drops. If this option is set to “false”, viewers will only be considered for the drop selection for the first streamer for which they were recognized.
If this option is active, the viewer must be in the Twitch stream and logged in to the Minecraft server at the same time. If the viewer is not on the server and this option is active, they cannot receive any drops.
If this option is active, the viewer must follow the streamer. If the viewer does not follow the streamer and this option is active, they cannot receive any drops.
World names in which no drops are to be awarded to players can be entered here. If players are currently in this world when they receive a drop, the drop is saved offline and output if the player is in a permitted world for drops.
For example, drops can be deactivated in worlds with creative mode.
All available drops can be defined as Minecraft commands here. Everything can be a drop for the viewers, as long as the command can be executed in the console.
When executed, the commands are executed as “Console” so that the player does not need permission for the command.
Commands from external plugins can also be used.
Each line is a single drop. If more than one command is to be executed per drop, several commands can be written one after the other. The individual commands are separated by a pipe and executed by the plugin one after the other.
For placeholders in the commands, take a look at the list of internal placeholders
If the alwaysCommands are activated, the commands from the list are executed once per streamer (regardless of the number of viewer rewards). This can be used to ensure that many viewers receive a reward, but only one general message is sent for the reward distribution.
If this option is active, a connection to the SQL database is established. The information that can be filled in below is used for this. If the option is set to “false”, a local database (SQLite) is created automatically. If you do not want to use a database, leave this option set to “false” and ignore the other options for the SQLSettings.
Enter the IP address of your SQL server here so that the plugin can connect to the server. Make sure that access to the database is allowed.
Enter the port of your SQL server here so that the plugin can connect to the server. Make sure that access to the database is allowed.
Enter the database name of the SQL database here. The database must already exist or be created manually. The tables are created automatically by the plugin.
Enter the user name for the SQL connection to be used here. The user requires authorizations on the database to be able to create new tables.
Enter the password for the user here so that the plugin has the authorization to read and write data on the SQL server.
Enter the chat format for Minecraft here, as the Twitch messages from the Twitch chat in Minecraft (only visible to the streamers) should look like. Colorcodes or Markdown can be used.
Activate or deactivate the viewer times function. If this function is active, the plugin remembers how long a viewer was in the stream. The times are added together so that a total time is always available.
The interval is specified in minutes. After X minutes (X = the number entered), the plugin checks whether the viewer is still in the chat and adds X minutes to the viewer's existing time. The viewer does not need to be connected to the Minecraft server for this.
The LiveTag is filled via the PlaceholderAPI. If a streamer is live, the placeholder is returned with the value specified here. If the player is offline, “” (empty) is returned. For exceptions, see “OfflineTag”.
The offline tag is filled in when a streamer is not online. This placeholder is not used for general placeholders, but only if a special streamer has been defined. This makes it possible to control empty placeholders and filled placeholders. See the list of placeholders.
If the Discord function is activated and the “WebhookUrl” field is filled in correctly, a Discord message is generated (live message). Only live messages are sent for streamers where drops can be collected.
If general live messages are to be sent in Discord, one of the many external Discord bots can be used for this.
The WebhookUrl can be copied from the Discord channel and is used to send the Discord message in the correct channel. A configuration of the texts is possible via the “messages.yml” setup.
Here you can define the name in which the bot should send the message. This is displayed as the sent user in the Discord.
Only Premium - Here you can enter a url to a picture for the avatar picture of the user in the Discord who sends the live messages. Enter a direct url to the picture.
If this option is active, a message is sent to the player after joining the server to show which streamers are currently live.
If no streamers are live, no message will be sent. The list can also be executed manually with the command “/online”.
If twitch usernames are added to the blacklist here, players cannot link to these Twitch accounts. They will then receive a message that there is already a link to this account. As an admin, these Twitch channels can still be assigned to Minecraft players. So that this only counts for the “/twitch [twitch username]” area.
The online streamer format will be used for "StreamerListOnJoin" and the commmand "/online". It defines the format style of the single streamer line for the user.
StreamingModule supports proxy software servers and can be installed on the proxy server. The commands are transferred to the sub-server. This setup is not necessary as it already works in the standard configuration.
This option can be used if StreamingModule is installed on a proxy server AND on one or more sub-servers. Installation on the sub-servers is only necessary if different configurations are to be set up for the proxy server.
This allows a distinction to be made as to whether the command should only work on the sub-server or across the entire network.
The following settings will only be necessary for this special requirement
If one of the following options is changed, the entire server must be restarted for the changes to take effect.
A “/sm reload (force)” is NOT sufficient for this!
Activates the availability of extra proxy commands. If the option is deactivated, the normal commands must be used. This is only activated on the proxy server. This option should be deactivated or ignored on the sub-servers.
Here you can specify what comes after the command. The command “/sm reload” would become “/smp reload” if “p” is set.
Structure:
[Base command] + [proxyCommandSufix] = new proxy command
