Skip to content

README.md

Latest commit

 

History

History
89 lines (52 loc) · 2.01 KB

README.md

File metadata and controls

89 lines (52 loc) · 2.01 KB

🚀 iCraft Launcher

A lightweight, open-source Minecraft launcher built with Electron + React + Vite.

✨ Features

  • 🧑‍💻 Offline-mode accounts: Create and manage local (offline) accounts without an external auth provider.
  • 🧩 Built-in Modrinth integration: Discover and install mods & resource packs directly from Modrinth.
  • 📦 Version management: Fetch Minecraft version manifests and download specific releases.
  • ⚙️ Launch configuration: Select Java runtime, allocate memory, and launch Minecraft from the launcher.
  • 🖥️ Modern front-end: React + TypeScript + Vite with a focused UI and predictable state.

🗺️ Roadmap

  • 🧑‍🎨 Skins support (coming soon): Manage and apply player skins from a streamlined UI.
  • 🗂️ Improved mod management: Per-profile mod lists and one-click modpacks.
  • 🔄 Auto-updates and improved patching for assets and libraries.

🛠️ Quick Start

📋 Prerequisites

  • Node.js (recommended LTS) and bun/npm available on PATH
  • Git to clone the repository

📦 Install dependencies

bun install

🖥️ Run the renderer in dev mode

bun dev

🧪 Run tests

bun run test

🏗️ Build for production

bun run build

📦 Packaging

The repository uses electron-builder. After building, artifacts are generated under release/1.0.0.

🤝 Contributing

Contributions are welcome — open an issue or a pull request. Please:

  1. 🍴 Fork the repository and create a feature branch.
  2. 🧪 Run tests and linters locally before submitting.
  3. 📝 Add tests for new behavior when possible.

🧹 Code Style

  • TypeScript + ESLint + Prettier rules are included. Run npm run lint before committing.

📄 License

This project is (add your license here). If you want to change the license, update this README and the repository metadata.

📬 Contact

If you have questions or ideas, please open an issue on GitHub.