Skip to content

💡 Let Minecraft control your RGB peripherals.

License

Notifications You must be signed in to change notification settings

jeremylvln/LedMC

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LedMC Build Status Minecraft Version License

Let Minecraft control your RGB peripherals!

Today, a lot of gamers have RGB peripherals to pimp their setup. They can control them with the provided software. Some have preconfigured integrations with games whereas others not. The idea of LedMC is to provide a low-level integration with the game. It will permit to improve your survival life with modules you enabled.

This mod is called LedMC because it could be cool to control more RGB peripherals in the future. But first, lets do keyboards properly ;).

Installation

This mod works with Minecraft Forge. Place the jar archive of LedMC in the mods folder. When your game will start for the first time, you will be asked to select your keyboard provider and layout. If you cancel the configuration window or if you select I don't have a compatible RGB keyboard, LedMC will simply be inactive. If your keyboard provider and/or layout is not supported yet, be patient! Maybe awesome contributors will come to rescue you!

TODO: Module explanations.

Screenshot

Compatibility

Keyboard Provider Model Tested
Logitech G910 Orion Spark No (Should work)
Logitech G810 Orion Spectrum Yes
Keyboard Layout Tested
QWERTY No (Should work)
AZERTY Yes

Contributing

Adding a keyboard provider

If you are a modder and you want to contribute by adding your keyboard provider, please create a Keyboard Controller class like I did here. You just have to implement IKeyboardController who contains methods used to do the magic!

package fr.blueslime.ledmc.peripheral;

/**
 *                )\._.,--....,'``.
 * .b--.        /;   _.. \   _\  (`._ ,.
 * `=,-,-'~~~   `----(,_..'--(,_..'`-.;.'
 *
 * Created by Jérémy L. (BlueSlime) on 26/08/2017
 */
public interface IKeyboardController
{
    void enable() throws Exception;
    void disable() throws Exception;

    void setLightningForKey(int keyCode, int red, int green, int blue) throws Exception;
    void removeLightningForKey(int keyCode) throws Exception;

    boolean isCompatible();
}

It's important to implement correctly isCompatible() because some SDK are compatible with Windows only (like Logitech).

By contributing, you will probably need to support your code during the updates I made to the core of the mod.

Adding a keyboard layout

TODO.

Adding a module

TODO.

License

See LICENSE.txt.

Author

Jérémy L. ("BlueSlime") - Website - Twitter

About

💡 Let Minecraft control your RGB peripherals.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages