Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/btarg/twitchvsminecraft

[LEGACY] A Minecraft mod that lets viewers on Twitch execute commands.
https://github.com/btarg/twitchvsminecraft

curseforge eclipse forge-mod gradle interactive irc java minecraft minecraft-mod minecraftforge mod pircbotx streamer twitch

Last synced: 6 days ago
JSON representation

[LEGACY] A Minecraft mod that lets viewers on Twitch execute commands.

Awesome Lists containing this project

README

        

# Twitch Vs Minecraft
[![Build status](https://ci.appveyor.com/api/projects/status/9b887bfebvnuvixy?svg=true)](https://ci.appveyor.com/project/iCrazyBlaze/twitchvsminecraft)
[![CurseForge](http://cf.way2muchnoise.eu/full_twitch-vs-minecraft_downloads.svg)](https://www.curseforge.com/minecraft/mc-mods/twitch-vs-minecraft)

A Minecraft mod for Forge 1.12.2 inspired by [Kaze Emanuar](https://www.youtube.com/channel/UCuvSqzfO_LV_QzHdmEj84SQ) and [CrowdControl](https://crowdcontrol.live) that lets Twitch viewers interact with the game to provide a fun challenge for streamers.

[View the project on CurseForge for more info!](https://www.curseforge.com/minecraft/mc-mods/twitch-vs-minecraft)

[See the documentation if you are making modifications to the code.](https://icrazyblaze.github.io/TwitchVsMinecraft/)

# How it works
This mod integrates [PircBotX](https://github.com/pircbotx/pircbotx), a Java IRC API. It uses PircBotX to connect to Twitch's IRC server and read a Twitch channel's chat. Every time a new chat message is recieved that isn't blacklisted and starts with the chosen prefix, it is added to a list. Every 30 seconds (this can be changed), a random message from the list is chosen, and if it's a valid command, e.g. "!creeper", the list of new chat messages will be cleared, the timer will restart and the command will be executed. A list of commands is available on the CurseForge page.

# Twitch OAuth key
As stated on CurseForge, you will need a Twitch OAuth key. You can get this [here.](https://twitchapps.com/tmi)

You should keep this key private and safe. This key is stored in the mod's config file - **DO NOT** share this file with others!

Follow the instructions on the TwitchApps page for how to revoke access to the Twitch API if you want to stay extra safe.

# Getting started
To setup a modding workspace using eclipse, use
```
./gradlew setupDecompWorkspace
```

If you're using [IntelliJ IDEA](https://www.jetbrains.com/idea/), choose **"import project"** from the main screen and import the mod's `build.gradle` file. You are then able to run `setupDecompWorkspace` from the **Gradle** tab on the right of the screen, or from a terminal. Use this command to generate run configurations:
```
./gradlew genIntellijRuns
```

When moving over to IDEA from Eclipse, follow the above steps and then run `cleanEclipse` from the Gradle tab to remove all of Eclipse's files.

# Building from source
To build the project using a terminal, type
```
./gradlew build
```
Or find it in the Gradle tab in IDEA.

The build will be located in the **build/libs** folder, alongside the "sources" file. **The sources file is not a mod!**