Keyverse Open Source Documentation
Complete developer guide to cloning, building, customizing, and contributing to Keyverse Minecraft Launcher Community Edition.
Release Notes: 1.4.5 (premium launcher refresh) #
Version 1.4.5 adds a resilient updater fallback, stronger download recovery, illustrated version setup, universal game files, a dedicated themed console, and expanded Fair Play Guard reporting.
In-App Auto Updater
Direct background auto-downloads with live progress and 1-click restart installation.
KeyClient In-Game UI
Keyverse's configurable in-game menu, draggable HUD, keystrokes, CPS, FPS counter, and coordinates (Right Shift in-game).
Modrinth Discovery
Live searching and installation of compatible mods, shaders, and resource packs.
Quickstart #
Keyverse Open Source Edition is built using Electron, React, TypeScript, and Vite. Prerequisites: Node.js 18+ and npm installed on your machine.
git clone https://github.com/ahtilol/keyverse.git
cd keyverse
npm install
npm run devnpm run dev starts the Vite dev server with hot module replacement (HMR) for instant UI updates.Building from Source #
To compile standalone production distribution binaries (.exe for Windows, .dmg for macOS, .AppImage for Linux), execute the build pipeline:
# Compiles TypeScript and packages Electron application binaries
npm ci
npm run typecheck
npm run build:desktop
npm run package:win
# On macOS: npm run package:mac
# On Linux: npm run package:linuxThe desktop bundle is written to out/; installers are written to dist-electron/. Run each platform packaging command on the matching operating system. macOS and Linux source builds are not a claim of an available signed release.
Cloud setup: Run the complete supabase/RUN_THIS_FIRST.sql, then supabase/verify.sql in your Supabase project. Configure the public project URL and anon key in the launcher. Never put a service-role key in frontend settings.
Project Architecture #
The codebase is organized cleanly between Electron main process logic, preload IPC bridges, and the React UI frontend:
keyverse/
└── src/
├── main/ # Electron main process (IPC, launcher, paths)
├── preload/ # IPC bridge (window.keyverse)
├── renderer/ # React views (Home, Mods, Versions, Settings)
└── shared/ # Shared TypeScript interfaces & IPC constantsMain Process
Handles game process spawning, Java execution, version manifest resolution, and local profile management.
Renderer UI
React dashboard with live Modrinth search, theme controls, and lightweight splash themes.
Offline Accounts #
Offline accounts allow local play without signing into Microsoft services. Offline profiles generate deterministic UUIDs and keep only profile data in Keyverse storage.
Loader Support #
Keyverse supports Vanilla, Fabric, Quilt, Forge, and NeoForge profiles. New profiles resolve a recommended compatible loader build, while modpacks use the loader declared in their manifest.
CurseForge API Key #
To browse CurseForge's live mod database within the launcher, enter your CurseForge Developer API key in Settings or pass it into curseforge.ts.
PR Contribution Guidelines #
We welcome bug fixes and feature additions! Please ensure all code passes npm run build cleanly without TypeScript errors before submitting a pull request.
MIT License #
Keyverse Open Source Edition is open-source software licensed under the MIT License. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files, to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software.