UNIkeEN/SJMCL — Gitpedia

English · 简体中文 · 繁體中文

Features

Cross Platform: Supports Windows 10/11, macOS and Linux.
Efficient Instance Management: Supports multiple game directories and instances, allowing the management of all instance resources (such as saves, mods, resource packs, shaders, screenshots, etc.) and settings in one place.
Convenient Resource Download: Supports downloading game clients, mod loaders, various game resources and modpacks from CurseForge and Modrinth.
Multi-Account System Support: Built-in Microsoft login and third-party authentication server support, compatible with the OAuth login process proposed by the Yggdrasil Connect proposal.
External Service Collaboration: Works with external webpages, applications, and Agent services through deeplinks and MCP services, delivering a range of convenient features and automation capabilities.
Open Extension System: Supports extension development to extend the launcher with more interesting and practical features. >> View Community Extensions

Note: some features may be limited by region, platform, or bundle type.

Built with

Getting Started

Getting started with SJMCL is simple, just download the latest release from the Official Website.

You can also find all the releases, including the nightly versions, on GitHub Releases.

SJMCL currently supports the following platforms:

Platform	Versions	Architectures	Provided Bundles
Windows	10 and above	`aarch64`, `i686`, `x86_64`	installer `.exe`, portable `.exe`
macOS	10.15 and above	`aarch64`, `x86_64`	`.app`, `.dmg`
Linux	webkit2gtk 4.1 (e.g., Ubuntu 22.04)	`aarch64`, `x86_64`	`.deb`, `.rpm`, portable binary

To learn about how to use SJMCL’s features and browse frequently asked questions, please refer to the User Documentation.

<details> <summary><h3>Install from Command Line</h3></summary> <details> <summary><h4>Linux</h4></summary>

Install the latest stable release with the Linux installer:

bash
curl -LsSf https://mc.sjtu.cn/sjmcl/releases/install.sh | sh -s -- --source sjmc

Install the portable Linux build without root access:

bash
curl -LsSf https://mc.sjtu.cn/sjmcl/releases/install.sh | sh -s -- --portable --source sjmc

Install from the Arch User Repository (AUR) with a common AUR helper:

bash
yay -S sjmcl-bin

If you do not use an AUR helper, you can also install manually:

bash
git clone https://aur.archlinux.org/sjmcl-bin.git
cd sjmcl-bin
makepkg -si

Install from Snap Store:

bash
sudo snap install sjmcl

[!WARNING]
When installing via Snap, game data may be stored in a sandboxed directory by default. Before uninstalling the launcher, please back up important data such as saves, resource packs, and mods in a timely manner.

</details> <details> <summary><h4>macOS</h4></summary>

Install with Homebrew:

bash
brew install --cask SJMC-Dev/SJMCL/sjmcl

</details> <details> <summary><h4>Windows</h4></summary>

Install with Winget:

powershell
winget install SJMC.SJMCL

[!WARNING]
The Winget index is publicly maintained. Before installing, consider running winget show SJMC.SJMCL to inspect the installer URL, and make sure the download source is from github.com/UNIkeEN/SJMCL or sjmcl.club.

</details>

For more installation options and platform notes, see the User Documentation.

</details>

Development and Contributing

To get started, clone the repository and install the required dependencies:

bash
git clone git@github.com:UNIkeEN/SJMCL.git
npm install

To run the project in development mode:

bash
npm run tauri dev

We warmly invite contributions from everyone.

Before you get started, please take a moment to review our Contributing Guide (includes more details on the development workflow).
API references and some developers’ insights can be found in the Developer Documentation.
Feel free to share your ideas through Pull Requests or GitHub Issues.

Developing Extensions

If you want to develop extensions for SJMCL, check out the Extension Documentation. It includes an introduction to the extension system and API references. We also provide a scaffold to help you quickly create a template project and get started.

Repo Activity

Copyright

NOT AN OFFICIAL MINECRAFT SERVICE. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.

The software is distributed under GNU General Public License v3.0.

By GPLv3 License term 7, we require that when you distribute a modified version of the software, you must obey GPLv3 License as well as the following additional terms:

Use a different software name than SJMCL or SJMC Launcher;
Mark clearly in your repository README file, your distribution website or thread, Support documents, About Page in the software that your program is based on SJMCL and give out the url of the origin repository.
When your modifications to this software are limited solely to adding (without modifying or deleting) preset authentication servers (src-tauri/src/account/helpers/authlib_injector/constants.rs), the restrictions set forth in Clauses 1 above shall not apply. In this case, you may continue to compile and distribute the software under its original name.

Besides, per term of use of our website, when distributing a modified version of the software, please send version numbers with prefix (more than two letters, e.g. XX-0.0.1) to our statistics server (src-tauri/src/utils/sys_info.rs) unless your modifications meets Clauses 3 above.