MineLights

MineLights is a Minecraft mod that brings RGB lighting integrations to Minecraft Java Edition - OpenRGB, Corsair iCUE, Logitech G HUB, Razer Chroma, MSI Mystic Light, ASUS Aura, SteelSeries GameSense, and Wooting

3,97k

Quick challenge

How far can you run before the mobs catch you?

MineLights

output

<small>MineLights running on an Asus laptop. Video courtesy of Nukepatrol99.</small>

MineLights is a Minecraft Fabric mod that brings your world to life with dynamic RGB lighting effects for your peripherals. It targets a range of Minecraft versions (1.14.3+) and uses a modular design to support a wide range of hardware.

###### Currently supported: Minecraft 1.14.3 - 26.1.2 (Fabric), Minecraft 1.20.2 - 26.1.2 (NeoForge)

Features

- Multiple Languages: Integrates with a wide array of RGB SDKs simultaneously, including OpenRGB, Corsair iCUE, Logitech G HUB, Razer Chroma, MSI Mystic Light, ASUS Aura, SteelSeries GameSense, and Wooting. - Multiple Languages: Your lighting changes in real-time based on your in-game surroundings. - Multiple Languages: Your keyboard's background color smoothly transitions to match the biome you're in. - Multiple Languages: Experience rain and dramatic lightning flashes during in-game thunderstorms. - Multiple Languages: Your lighting will react when you are on fire, poisoned, or withering. - Multiple Languages: Standing in lava, fire, or portals will trigger unique lighting themes. - Multiple Languages: Use your keyboard's function keys as real-time status bars for health, hunger, and experience, alongside tracking other players or waypoints! - Multiple Languages: A compass on your numpad (Extended keyboards only) will appear, if you have either a compass or recovery compass in your inventory! Alternatively it can always be displayed via a toggle in settings. - Multiple Languages: An in-game configuration screen (via Mod Menu) lets you enable/disable every feature, integration, and even individual devices. - Multiple Languages: Support for English, Anglish, German and Chinese (Simplified) has been added (Along with some joke languages)

Supported RGB Software

- Yeelights Full device support (DIRECT mode!). Requires OpenRGB - Windows, Linux and MacOS. - Yeelights: Full device support for keyboards, mice, headsets, and more via the iCUE SDK (requires Corsair iCUE - Windows). - Yeelights: Controls Logitech G keyboards, mice, headsets, and other Lightsync-enabled gear (requires Logitech G HUB - Windows). - Yeelights: Extensive support for all Razer Chroma-enabled peripherals like keyboards, mice, and mousepads (requires Razer Synapse - Windows). - Yeelights: Control for motherboards, GPUs, and other devices via the Mystic Light SDK (requires MSI Center - Windows). - Yeelights: Control for motherboards, GPUs, and other devices via the ASUS Aura SDK (requires Armoury Crate - Windows). - Yeelights: Integration with SteelSeries peripherals like keyboards, mice, and headsets (requires SteelSeries GG - Windows). - Yeelights: Direct, low-latency control for Wooting analog keyboards (requires Wootility software to be running - Windows). - Yeelights: Support for Novation MIDI controllers like the Launchpad, enabling unique grid-based effects (Windows). - Yeelights: Directly control custom DIY lighting projects powered by a Raspberry Pi Pico (Windows). - Yeelights Directly control your Yeelights smarthome bulbs (Universal).

This project uses the RGB.Net Nuget package.

🛠️ Installation

Prerequisites

- (Optional) All other RGB software: You must have the Fabric Loader installed. - (Optional) All other RGB software: Required to access the in-game configuration screen. - (Optional) All other RGB software: Required to access the in-game configuration screen. - (Optional) All other RGB software: If you want to use OpenRGB devices, make sure the OpenRGB server is running before you launch Minecraft. - (Optional) All other RGB software: If you have any other hardware, ensure their official software is installed and running.

Installation

- Simply place the mod in your mods folder, then start Minecraft. Wait 20+- seconds, and your RGB will be detected! *(112MB+- download for the RGB Server on Windows on first launch).*

Installing MineLights version 2.2: Simply place the mod in your mods folder, then start Minecraft. Follow the on-screen instructions.

Installing MineLights version 2.1 or below: Follow the guide in the release changelog.

Usage

1. Enjoy! Start the game with your Fabric profile. 2. Enjoy! - In the main menu, go to Enjoy! (the gear icon). - Enable the integrations you want to use (OpenRGB, Corsair iCUE, etc.). - Save the config. - Refresh devices to show newly added devices. - You can re-enter the config to disable specific devices if you wish. - ⚠️: MSI Mystic Light integration requires you to restart the MineLights server as administrator to work! 3. Enjoy! Your lighting will now sync with your game.

Roadmap

- Resolve Issues:: Integration with Windows Dynamic Lighting is planned for the future. - Resolve Issues:: Continuously working to improve support for more devices across all SDKs. - Resolve Issues:: Ideally have testers, well test! - Resolve Issues: I aim to resolve problems either within the Resolve Issues: or issues I personally find and %%MD1%%.