MCPcopy Index your code
hub / github.com/Voxelum/x-minecraft-launcher

github.com/Voxelum/x-minecraft-launcher @v0.61.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.61.0 ↗ · + Follow
6,389 symbols 18,989 edges 1,041 files 892 documented · 14%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Logo

Build License Commit

Discord Kook afdian patreon

home

Visit the official site to download the app!

If you have winget, you can use winget to install

winget install CI010.XMinecraftLauncher

HomeBrew installation also available via tap

brew tap voxelum/xmcl
brew install --cask voxelum/xmcl/xmcl
sudo xattr -rd com.apple.quarantine /Applications/X\ Minecraft\ Launcher.app

Ukraine Russia Germany China Japan Poland Kazakhstan Spain Korean Hungarian

Features

  • 📥 Download & auto complete. Support download Minecraft, Forge, Fabric, Quilt, OptiFine, JVM from official or third party mirrors.
  • ⚡️ Download Fast. Reuse socket via HTTP/HTTPS agents, and download the files in parts concurrently.
  • 💻 Cross platform. The launcher is based on Electron, and supports 🗔 Windows 10/11, 🍎 MacOS, and 🐧 Linux.
  • 📚 Multi-Instancing. Users can create multiple instances to isolate the different versions, mods and launch settings.
  • 🗂 Manage all resources. Use (hard/symbolic) links to install resources in instances, keep your disk usage optimal. No copies of mods everywhere! 😆
  • 🔥 Built-in support of CurseForge, Modrinth. You can download resources inside the launcher.
  • 📦 Support import/export CurseForge & Modrinth modpacks with compliance!
  • 🔒 Support multiple account systems. Built-in Microsoft login and Mojang Yggdrasil API. It also has builtin support of ely.by and littleskin.cn. You can also add third-party authentication servers!
  • 🔗 Peer to peer connection between users. You can play multiplayer over LAN even you are not in same physical LAN!
  • 🔑 Code sign & modern packaging. Under Windows, you can use appx and appinstaller to install the app. You won't receive blocking messages from your browser or see SmartScreen errors anymore! 😎

Core Libraries

This repository also includes the Minecraft Launcher Core (@xmcl/* packages) — a set of npm packages providing useful functions to build a Minecraft launcher. API Documentation

Package Description Version
@xmcl/core Launch Minecraft npm
@xmcl/installer Install Minecraft, Forge, Fabric, Quilt, OptiFine, JVM npm
@xmcl/user User authentication and skin npm
@xmcl/mod-parser Parse Forge/LiteLoader/Fabric mods npm
@xmcl/curseforge CurseForge API npm
@xmcl/modrinth Modrinth API npm
@xmcl/nbt Parse NBT npm
@xmcl/game-data Load level data or servers.dat npm
@xmcl/resourcepack Parse resource packs npm
@xmcl/gamesetting Parse game settings npm
@xmcl/client Minecraft client network utilities npm
@xmcl/model Display player/block models npm
@xmcl/text-component Parse Minecraft text components npm
@xmcl/forge-site-parser Parse Forge website npm
@xmcl/file-transfer High-performance file downloads npm
@xmcl/nat-api UPnP and NAT-PMP port mapping npm
@xmcl/system FS middleware for browser/Node npm
@xmcl/unzip yauzl unzip wrapper npm
@xmcl/semver Fabric semver format npm
@xmcl/bytebuffer ByteBuffer implementation npm

Contribute

Ask DeepWiki

For general developer, see Contributing

For i18n localization developer, please follow Getting Started with Localization

LICENSE

MIT

Sponsorship

Free code signing on Windows provided by SignPath.io, certificate by SignPath Foundation
Deno Deploy, XMCL leverage its hassle-free platform for serverless JavaScript applications. Provided by Deno
Best Asian CDN, Edge, and Secure Solutions - Tencent EdgeOne,CDN acceleration and security protection for this project are sponsored by Tencent EdgeOne.

Sponsor (AFDIAN)

Credits & Acknowledgments

🌍 Community & Localization

BANSAFAn Community support and moderation for RU/UK regions · Ukrainian translation

Marmur2020 Complete Ukrainian language translation

vanja-san Russian language support

📦 Package

Extension points exported contracts — how you extend this code

VersionRange (Interface)
(no doc) [6 implementers]
packages/semver/range.ts
ResourceLoader (Interface)
(no doc) [12 implementers]
packages/resourcepack/resourceManager.ts
Item (Interface)
(no doc) [6 implementers]
xmcl-runtime-api/src/util/mavenVersion.ts
ManagedZipFile (Interface)
(no doc) [8 implementers]
xmcl-runtime/infra/zip_manager.ts
UserAccountSystem (Interface)
(no doc) [4 implementers]
xmcl-runtime/user/accountSystems/AccountSystem.ts
SecretStorage (Interface)
(no doc) [3 implementers]
xmcl-runtime/app/SecretStorage.ts
MinecraftProcessWatcher (Interface)
(no doc) [2 implementers]
packages/core/launch.ts
TextureManager (Interface)
(no doc) [2 implementers]
packages/model/block.ts

Core symbols most depended-on inside this repo

join
called by 795
xmcl-keystone-ui/src/util/basename.ts
map
called by 697
packages/nat-api/lib/pmp.ts
push
called by 525
xmcl-runtime-api/src/util/mavenVersion.ts
log
called by 456
xmcl-runtime/infra/logger.ts
t
called by 455
xmcl-keystone-ui/src/staticLocale.ts
push
called by 390
packages/asm/libs/Frame.ts
toString
called by 288
packages/asm/libs/Type.ts
get
called by 212
xmcl-runtime/app/SecretStorage.ts

Shape

Function 2,575
Method 2,297
Interface 886
Class 579
Enum 52

Languages

TypeScript100%

Modules by API surface

packages/user/mojang.ts59 symbols
xmcl-keystone-ui/src/composables/gamepad.ts53 symbols
xmcl-runtime-api/src/services/InstallService.ts50 symbols
e2e/helpers/pom/AppShell.ts50 symbols
packages/bytebuffer/index.ts49 symbols
packages/asm/libs/MethodWriter.ts49 symbols
xmcl-runtime-api/src/services/InstanceSavesService.ts47 symbols
packages/client/channel.ts47 symbols
xmcl-runtime-api/src/util/mavenVersion.ts46 symbols
packages/curseforge/index.ts46 symbols
packages/asm/libs/ClassWriter.ts46 symbols
packages/core/folder.ts45 symbols

For agents

$ claude mcp add x-minecraft-launcher \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page