Note:
This project and its documentation are still experimental and under active development.
See the full documentation and guide in thedocs/folder.
Disclaimer: This README and parts of the automation were created with help from GitHub Copilot.
hyprmcsr is a toolkit for automating a modern Minecraft speedrunning environment on Linux, with a focus on performance, usability, and automation.
It is especially useful for runners looking for a streamlined, performant alternative to the typical Windows-based MCSR setup.
The toolkit leverages Hyprland (Wayland compositor), Pipewire, PrismLauncher, and various helper tools to provide:
- Automated setup and download/update of all desired tools, such as Ninjabrain-bot, Paceman-tracker, etc.
- Automated window size management
- Configurable keybinds and window sizes
- Multiple profiles support
- Audio splitting (game / Discord)
- Automated start of all necessary tools when you begin a speedrunning session, including Minecraft, Kanata / input remapping, OBS, and your speedrun helper tools
- Automated closing and cleanup after ending your session
All core functionality is controlled via the hyprmcsr CLI, which manages setup, teardown, and automation for your speedrun sessions.
For setup instructions, usage, and all details, see the
👉 Full Guide & Documentation 👈
For recent changes and migration guides, see the
👉 CHANGELOG 👈
- Me (youtube, speedrun.com)
- Igelway (youtube, speedrun.com)
- All project code is under the MIT License.
- Some components (like obs-vkcapture, InputRemapper) have their own licenses—see the respective files.
Questions or issues?
Check the script comments or open an issue!