Setup

How to install StreamingDrops?

1. Download the latest version here
2. Put the .jar file in your plugins folder
   1. Optional: Download PlaceholderAPI
   2. Optional: Drag and drop the placeholderapi jar file into the "plugins" folder (List of Placeholders)
3. Start your server. Starting the server will create all StreamingDrops configuration files. All configuration files can be found in the folder "StreamingDrops" in your plugins folder.
4. Now you can start setting up StreamingDrops for your server. For this you can take a closer look at the following information

Important for Forge Server (Modded Server) [Magma, Mohist & more]:

1. Open "settings.yml"
2. Set "UseSimpleConnection" to "true"
3. Save your file and restart your server

Hint: When using Matrix Anti-Cheat, StreamingDrops may not work cleanly with the "UseSimpleConnection=true" setup. Thus, using Forge Server + Matrix Anti-Cheat may not be possible.

Requirements

1. From version 8.0 Java 11 is required for StreamingDrops. If a server with an older version is used, please use StreamingDrops v.7.2 (at least Java 8).
2. To be able to connect to the Twitch servers, an open HTTPS port is important. This is possible for 99.9% of game hosts, so there have been no problems in the past. When using a root server, this can be relevant.
3. If the Twitch channel points (Twitch Rewwards) are to be used, an affiliate or partner status with Twitch is required for this feature. This has nothing to do with StreamingDrops, but is a requirement of Twitch (Amazon).

---

How to set up StreamingDrops?

To be able to set up StreamingDrops correctly, the following points are important:

1. In the "settings.yml" file, the stream name must be entered under the "AllowedStreamer" option. The Twitch channel name must be used here. This can also be done in-game / in the console by using the command "/sd streamer add [Twitch channel]". I recommend doing this via the command if you don't want to add the streamer specific part by yourself in the lower section of the configuration.

2. After the streamers have been set up, the worlds in which drops are allowed must be set. For this, the option "AllowdWorlds" in the file "Settings.yml".

3. Set up your drops. The setup for your drops is not necessary for the first test, because there are already 3 example drops in the default configuration. If you want to customize these drops, the commands are listed under "GeneralDrops" in the "settings.yml" file. Here all commands can be added, which can be entered in such a way in the Console. Thus, other plugins are also supported. After finishing the configuration please use the command "/sd reload". If the value "Interval" was adjusted, the command "/sd reload force" is important. Alternatively, the server can be restarted.

4. Now the streamer / player goes to the Minecraft server. If the name of Twitch Channel is not one-to-one the same as in Minecraft, the command "/twitch [twitch channel name / username]“ must be entered once (Example: „/twitch MorelaidOnAir). This links the Minecraft account with the Twitch account.

5. Use "/mod StreamingModule" in your twitch chat to add the bot to your moderators. This is needed to get the twitch viewers of your channel.

6. The streamer now goes live on Twitch and join the minecraft server. The Minecraft players log in to Twitch and watch the stream. Every X minutes (X = the "Interval" value in Settings.yml" in minutes) a random drop is distributed to the viewers. If you want to test a drop and not wait for the automatic Interval, the streamer can execute the command "/drops test". This will send a random drop to a viewer of the streamer. The interval will continue to run normally.

Please note that a new viewer is not recognized immediately (takes 2-6 minutes).

---

Overview of the settings

Settings	Description	Values
Enable	Global setup to enable or disable Streaming Drops	true, false
Debug	Displays log messages in the console, which allows you to track the steps taken to assign drops to the different players. The statement is also stored in an extra log file	true, false
SendStreamerListOnJoin	If there is at least one streamer online where drops can be collected, the player will be shown a current list of all streamers on the server when joining, where he can collect drops	true, false
AllowedStreamers	Listing of streamers where drops can be collected. The Twitch Channel is specified here	Twitch channel name
DropOptions.Interval	In which intervals drops should be given out. The specification is in minutes	in minutes
DropOptions.DropChance	Number of viewers who should receive drops. The value must be given in percent (1% to 100%). At 100% all players / viewers are rewarded at every drop interval	in percent
DropOptions.RandomDrops	Number of possible drops from the "Drops" list for a single player / viewer	number
DropOptions.AllowMultiStreams	Is a player allowed to be selected at the same time with multiple streamers in the drop selection if he has multiple streams open?	true, false
DropOptions.DropsPerStreamer	Is a player allowed to be selected at the same time with multiple streamers in the drop selection if he has multiple streams open? Recommended: true	true, false
DropOptions.UseMinecraftPlayerForDrops	Should the payout from the possible list of players on the server (whether online or offline) be used as a basis or should the list of twitch spectators be used as a basis? Recommended: true	true = minecraft players, false = twitch viewers (no matter if they play Minecraft)
DropOptions.DropsOnlyForOnlinePlayer	Only players in the stream and on the Minecraft server at the same time can receive drops	true, false
DropOptions.DropsOnlyForFollower	The Minecraft player must follow the streamer on Twitch to receive drops	true, false
AllowedWorlds	Specifies the worlds where drops can be received. If a player is in an unsupported world, the player counts as an offline player and will receive his drops the next time he joins the server in an allowed world	world names
BlacklistForTwitchChannel	A list of unauthorized Twitch Channel. Minecraft players cannot link their account to the names listed here.	twich channel name
AlwaysCommands	These commands are always executed when drops are given. So the player can be informed here with a message about his receipt of the drops or he can always receive a basic drop for each drop	full commands - will be executed as console
GeneralDrops	The list of possible drops. Here the drops can be specified as commands. For the player name the placeholder %player% can be used	full commands - use a pipe to add multiple commands per drop
StreamerDrops.IncludeGeneralDrops	With the option "IncludeGeneralDrops = true" both the GeneralDrops and the Streamer specific drops can be selected. If the option "IncludeGeneralDrops = false" is set, only the special drops of the streamer are selected.	true, false
StreamerDrops.UseGlobalStreamerTag	If this value is set to "true", the streamer only needs to be online on Twitch and enter "#StreamingDrops" in its stream title. Then the streamer will be marked as online and the viewer can collect drops from him, although it is not currently playing on the minecraft server.	true, false
StreamerDrops.Drops	Additional drops that can be collected only from this streamer	full commands - use a pipe to add multiple commands per drop
PlaceholderAPI.PlayerTopDropsPrefix	The placeholder tag for the player with the most received drops	text
PlaceholderAPI.Livetag	#The placeholder tag for players that are currently live (updated every 5 minutes)	text
OnlineFormat	This can be used to customize the view from the output of the "/online" command. Placeholder: "%streamer%"	text
TopDropsFormat	This option can be used to customize the display of the "/topdrops" command. Placeholder: "%number%", "%player%", "%amount%"	text
BannedPlayerToBacklist	Automatically add a player to the StreamerBlacklist if they have been banned from the server so that the player cannot receive drops	true, false
UseSimpleConnection	Enable this option if you are using a Forge server	true, false
Discord.SendLiveMessage	Sends a Discord message when a streamer goes live with drops enabled	true, false
Discord.Webhook_Url	The Discord URL to be able to write messages in Discord	Url