Skip to content

Commit

Permalink
Created build instruction in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
estintax committed Feb 11, 2020
1 parent dc412a7 commit 92024c1
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
# Twitch Chat for Minecraft Server
# ttvmc - Twitch(TM) Chat in Minecraft

Now this is just a proof of concept.
Plugin for Bukkit/Spigot/Paper allowing certain players to see Twitch chat in the game.

## How to build
1. Download and install IntelliJIDEA;
2. Clone this repository via `git clone`;
3. Download BuildTools.jar from [here](https://hub.spigotmc.org/jenkins/job/BuildTools/) to empty directory;
4. Build Spigot. See [this](https://www.spigotmc.org/wiki/buildtools) for instructions;
5. Find `spigot-api-1.15.2-R0.1-SNAPSHOT-shaded.jar` in `*BuildTools directory*/Spigot/Spigot-API/target`;
6. Put this file into ttvmc's repository root;
7. Run IntelliJIDEA and open ttvmc project;
8. Just build project using Ctrl+F9 or click on hammer in IDE;
9. Find plugin in `classes/artifacts/ttvmc_jar`.

## How to install
1. Drop .jar to `plugins` on your server;
2. Start or restart the server;
3. Configure plugin in `plugins/ttvmc/plugin.yml`;
4. Restart the server.

0 comments on commit 92024c1

Please sign in to comment.