Displays the status of your chosen Minecraft server as a row of colours on your keyboard. The first key indicates if the server is online, following keys indicate the number of players.
Requires a Das Keyboard Q Series: www.daskeyboard.com
Installation, configuration and uninstallation of applets is done within the Q Desktop application.
- Clone the repository with Git or download it as a ZIP and unzip it.
git clone https://gitlab.legitcorp.com/daskeyboard/minecraft-server-status.git
-
Open a terminal or cmd or PowerShell inside the folder and run
yarn. If you're on Windows see this guide on installing Yarn first. -
Open the Q Das Keyboard applet, click the Gear ⚙ menu and click
toggle dev menu. -
A new icon near the top-right will appear looking like
</>click this and clickload applet. -
Navigate to the folder holding the Applet and click OK.
-
Follow displayed instructions.
- Clone the repository with Git.
git clone https://gitlab.legitcorp.com/daskeyboard/minecraft-server-status.git
-
Open a terminal or cmd or PowerShell inside the folder and run
yarn. -
You're done
A VSCode task inside tasks.json will run the index.js file for you for testing, it is called Run test this includes the Das Keyboard dev command-line arguments you need to test from the command-line.
Host a local Minecraft server on 127.0.0.1 and port 25565, or modify test/config-0-players.json to point to another server.
Or just ignore the test for #getMinecraftStatus()
- Run
yarn test.
-
mc-server-statuslibrary by janispritzkau which does all the hard work. -
Major JavaScript consultancy provided by JF908
-
This useful blog on writing Mocha tests
Issues and Pull Requests Welcome \o/ Please make them on my GitLab here (You can sign in with GitHub.) (Changes will be mirrored to GitHub.)