spikehidden/TwitchMinecraftSync

TwitchMinecraftSync

A Spigot plugin developed for linking Minecraft accounts and Twitch.

✏️ Setup

Go to https://dev.twitch.tv/console/apps and click "Register Your Application"
Give your application a name. Be aware this will be shown to users.
Add an OAuth Redirect URL of https://twitchmcsync.com and set the Category as Game Integration
Click Manage on your newly created Application and copy your Client ID, and generate a new Client Secret. Save both, you will need these later.
Place TwitchMinecraftSync.jar in your /plugins folder and restart the server.
Navigate to /plugins/TwitchMinecraftSync/config.yml and paste in the Client ID and Client Secret.
Type your Twitch username in channelName
Set your Redirect URI. This is your server IP and an open port on your server.
   - The Redirect URI should be http://(server ip):(port), for example, http://172:182.52.222:8177
   - You can open a port on most popular server hosts.
   - The port is NOT your server port.
Restart your server and you should be good to go!

📚 Requirements

Java 8
Vault

📰 API

📦 Installation / Download

Gradle

maven {
  url "https://maven.pkg.github.com/dessie0/twitchminecraftsync"
}

dependencies {
  compileOnly 'com.twitchmcsync:twitchminecraftsync:1.2.0'
}

Maven

<dependencies>
  <dependency>
    <groupId>com.twitchmcsync</groupId>
    <artifactId>twitchminecraftsync</artifactId>
    <version>1.2.0</version>
  </dependency>
</dependencies>

Manual

Download JAR

API Events

TwitchMinecraftSync adds four events to listen to.

TwitchSubscribeEvent, TwitchResubscribeEvent, TwitchExpireEvent, and TwitchRevokeEvent

Example class for using events

public class Example implements Listener {

    @EventHandler
    public void onSubscribe(TwitchSubscribeEvent event) {
        if(event.getTwitchPlayer().getStreak() > 6) {
            if(event.getTwitchPlayer().getPlayer().isOnline()) {
                event.getTwitchPlayer().getPlayer().getPlayer().sendMessage(ChatColor.GREEN + "Thank you for supporting us for " + event.getTwitchPlayer().getStreak() + " months! You're awesome!");
            }
        }

        Bukkit.getOnlinePlayers().forEach(player -> {
            player.sendMessage(ChatColor.GREEN + "" + ChatColor.BOLD + event.getTwitchPlayer().getName() + 
                    " (" + event.getTwitchPlayer().getChannelName() + ") just subscribed at tier " 
                    + event.getTwitchPlayer().getTier() + "!");
        });
    }

    @EventHandler
    public void onResubscribe(TwitchResubscribeEvent event) {
        if(event.getTwitchPlayer().getChannelName().equalsIgnoreCase("abadperson")) {
            if(event.getTwitchPlayer().getPlayer().isOnline()) {
                event.getTwitchPlayer().getPlayer().getPlayer().sendMessage(ChatColor.RED + "You're not allowed to resubscribe, maybe it's your username?");
            }
            event.setCancelled(true);
        }
    }

    @EventHandler
    public void onExpire(TwitchExpireEvent event) {
        if(event.getTwitchPlayer().getPlayer().isOnline() && event.getTwitchPlayer().getPlayer().getPlayer().isOp()) {
            event.getTwitchPlayer().getPlayer().getPlayer().sendMessage(ChatColor.RED + "Your sub expired, but luckily for you, you're exempt!");
            event.setCancelled(true);
        }
    }
}

📋 Configuration

TwitchMinecraftSync is highly configurable, and you can run any commands when a player subscribes, their subscription expires, or when they re-subscribe.

%player% will be replaced with their Minecraft username.
%twitchname% will be replaced with their Twitch username.

You can also utilize permission roles that are granted or taken away as needed. Vault is required for this reason.

Additionally, you can perform different commands and roles for each tier.

The default config.yml can be seen below.

config.yml

clientID: "<Your client ID>"
clientSecret: "<Your client secret>"
channelName: "<Channel to check for subscriptions>"
redirectURI: "http://localhost:8080"
port: 8080

rewards:
  tier1:
    subscribe:
      #The role to give them when they subscribe
      #Set to '' to ignore role giving.
      role: "Subscriber"

      #The commands to execute when they subscribe
      #%player% will get their Minecraft username
      #%twitchname% will get their Twitch username.

      #Use -p at the end if you want the command to be executed by the player.
      #By default all commands are ran by console.
      commands:
        - say Thank you %player% for syncing your Twitch account! (%twitchname%)
        - give %player% diamond 1
        - spawn -p

    resubscribe:
      role: "Subscriber"
      commands:
        - say Thank you %player% for re-subscribing! (%twitchname%)

    expire:
      #The role to remove from them when it expires.
      role: "Subscriber"
      commands:
        - say %player% (%twitchname%) has not renewed their subscription :(
        - spawn -p

  tier2:
    subscribe:
      role: "Subscriber2"
      commands:
        - say Thank you %player% for syncing your Twitch account at tier 2! (%twitchname%)
        - give %player% diamond 5
        - spawn -p

    resubscribe:
      role: "Subscriber2"
      commands:
        - say Thank you %player% for re-subscribing at tier 2! (%twitchname%)

    expire:
      role: "Subscriber2"
      commands:
        - say %player% (%twitchname%) has not renewed their subscription :(
        - spawn -p

  tier3:
    subscribe:
      role: "Subscriber3"
      commands:
        - say Thank you %player% for syncing your Twitch account at tier 3! (%twitchname%)
        - give %player% diamond 15
        - spawn -p

    resubscribe:
      role: "Subscriber3"
      commands:
        - say Thank you %player% for re-subscribing at tier 3! (%twitchname%)

    expire:
      role: "Subscriber3"
      commands:
        - say %player% (%twitchname%) has not renewed their subscription :(
        - spawn -p

🔧 Commands

/sync - Sends the Twitch OAuth link to the player. (Granted by default)
/revoke <user> - Revokes a user's synced status, and expire commands will be ran. (twitchmcsync.revoke)
/tinfo <user> - Displays information regarding a user's current sync status. (twitchmcsync.tinfo)
/twitchreload - Reloads the configuration. (twitchmcsync.twitchreload)
/twitchserverreload - Reloads the WebServer. (twitchmcsync.twitchserverreload)

👓 Advanced

Webserver Configuration

By default, TwitchMinecraftSync comes with a generic look for it's locally hosted web server. (Thanks luaq)

Almost any part of this can be modified by simply changing modifying the resources with in /webserver

It is not recommended to change these files unless you know what you're doing, and do NOT touch the getTwitchResponse() function. All other functions and files can be safely edited.

spikehidden / TwitchMinecraftSync