Bukkit

Description

This plugin allows users to use their razer chroma devices while connected to a minecraft server that adds immersive keyboard highlighting based on the player's environment. This mod is inspired by past projects such as _ForgeUser16015389's ChromaCraft and tgraupmann's MinecraftChromaMod. Both of these required Minecraft Forge, and as a result, playing multiplayer wasn't always easy because it requires new players to install forge themselves to connect to the server, which is not ideal. This plugin is composed of two parts: the server plugin and client standalone application. Server admins need to load the server plugin in the plugins folder, while players that want to use their keyboard need to download the client plugin and run it while connected to the server. Players that do not have chroma devices can still connect as normal to the server without any additional installations.

 

Features

Many features are yet to come, but I want to see if there is an actual demand for this before I continue expanding :)

 

     Server Commands

     /chroma list - displays who is currently connected to the chroma plugin

 

     Hotbar Indicator

     The hotbar keys will be white, except for the slot which is currently selected, which will be red.

 

     Health Indicator

     The top row of the keyboard (esc, F keys, etc.) will toggle between green, yellow, and red based

     on how much health you have.

 

     Control Keys

     Currently, WASD are highlighted red, and common keys like Q, E, and Shift, are all yellow. In later

     versions, I plan on making this configurable.

 

     Biome Coloring

     Each biome has a unique combination of two different colors that are displayed on the keyboard

 

     Liquids

     While in water, the keyboard will show dark blue colors, while in lava, you will see bright red colors.

 

Setup

There are two parts to the setup: Server setup and Client Setup

     Server
     1. Download ChromaMinecraftServerPlugin-0.5 and place this in your plugins folder.

     2. Install the server plugin in the plugin folder.

     3. You must allow portforwarding on port 25566. This is similar to how you set up a minecraft

     server on port 25565. Ensure portforwarding is enabled on 25566 (as well as 25565 for mc) or

     players will not be able to connect to the chroma event handler.

     3. Launch the minecraft server as normal.

 

     Client

     This is entirely optional for all players, but only the players that have razer devices should do this

     so that their devices are synchronized with their minecraft session.

     1. For clients that wish to use the keyboard highlighting, you must download the

     ChromaMinecraftClientPlugin. 

     2. Move the plugin to a folder on your desktop, called whatever you want as long as it does not 

     have a space in the name. For instance, you can call it "plugin" but not "plugin folder".

     3. Inside this folder, open a terminal. 

     4. Connect to the minecraft server that is running with the ChromaServerPlugin.

     5. In the open terminal, run "java -jar ChromaMinecraftClientPlugin <yourName> <serverIP> 25566"

     Note: Replace <yourName> with your minecraft name, and replace <serverIP> with the address you

     used to connect to the minecraft server.

     Also: You can only connect once you are logged into the minecraft server, otherwise you will be

     blocked.

 

Risks

This plugin works by opening another port on the server computer to allow communication of player events driven by Bukkit sent to users that are running the client plugin. The client then runs the native ChromaSDK library to perform device highlighting. Opening an additional port on your computer always comes with security risks and vulnerabilities, so use at own risk.

 

 

FAQ

 

    I cannot connect to the chroma server even though it is running the plugin.

     Make sure that port 25566 is open. You can verify this as follows:

     Use this port checking tool. Enter the address of the server, and enter the port 25566. If the

     port is closed, contact the Server Admin. If it is open read on.

 

     Verify that your username is correct, verify that the address of the server is correct, and verify that

     you are using port 25566.  Also, as an obvious check, make sure you have an active internet

     connection.

 

     My connection was closed!

     Make sure you are connected to the minecraft server first.

 

     My keyboard stopped working even though I was already connected.

     There was probably a network timeout, so you just need to relaunch the client.

 

     How do I do this in single player?

     You have two options.

     1. Host your own local server, here. Minecraft hosts its own server anyway, so performance should

     not be terribly different.

     2. You can install forge and use forgebukkit, here. You can google how to install forge and forge
     bukkit. I have never used forge bukkit myself, so I cannot confirm this will work.

 

     I don't have a razer device but I want to test it. What do I do?

     You can use an emulator. Go to the razer chroma dev portal, and download the emulator.

 

     'Java' is not a recognized command.

     You need to set the path to your java location. You might find this helpful. If you still can't get

      java recognized, then google it.

 

Similar Projects

Check out ChromaCraft and MinecraftChromaMod.