Transit

A Minecraft reverse proxy software written in TypeScript and Bun.
View Documentation »
English / 简体中文

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Features
3. Getting Started
4. Usage
5. Documentation
6. Tech Stack
7. License

About The Project

Transit is a high-performance Minecraft reverse proxy software written in TypeScript and Bun. It offers powerful extensibility, supporting a plugin system and hot-reloading of configurations.

Features

• 🚀 High Reliability - Transit has been deployed and used in production environments.
• 🔌 Plugin System - Implement custom whitelist, kick messages, traffic control, and more with just a few lines of code.
• 💡 Developer Experience - Supports hot-reloading of configuration files and plugins.

Getting Started

Prebuilt Versions

We provide prebuilt binaries packaged with the Bun runtime. Supported platforms:

• Windows x64
• Linux x64
• Linux ARM64

Download the latest version from Github Release.

Installing from Source

1. Install Bun
2. Clone the repository and install dependencies

git clone https://github.com/Ikaleio/transit.git
cd transit
bun install
bun start

When Transit starts for the first time, it will generate a configuration file config.yml in the working directory and will attempt to load plugins from the plugins/ directory on every startup.

Documentation

You can find detailed information in our online documentation.

License

This project is open-sourced under the MIT License - see the LICENSE file for details.