Skip to content

Latest commit

 

History

History
99 lines (81 loc) · 4.23 KB

README.md

File metadata and controls

99 lines (81 loc) · 4.23 KB

2Based2Wait

Lightweight & extensible 2b2t proxy.

Wiki · Report a Bug · Configuration Guide · Discussions

Last Commit Code Size Current Version License

Table of Contents

Installation

Prerequisites

Quick Start

  1. Clone the latest release: git clone https://github.com/Enchoseon/2based2wait --branch v1.0.5 --depth 1 && cd 2based2wait
  2. Install dependencies: pnpm install --prod
  3. Configure your proxy:
  4. Start the proxy: pnpm start

RTFM

We'll never phone home or enable something you didn't. In other words, you are responsible for enabling and configuring features such as:

Read the Fun Manual

"Read it and you'll understand everything", RMS

Features

  • Extremely low RAM and CPU usage
  • Robust auto-reconnection
    • Battle-tested to be online 24/7/365
  • High configurability
    • Easily configure small-to-medium-sized networks
  • Convenient Discord webhooks for:
    • Livechat
    • Queue position
    • Tunnels & connections
  • Toast notifications
  • Auto /queue main
  • Mineflayer support and extensibility (see: ./utils/mineflayer.js)
    • Already comes with:
      • Kill aura
      • Auto eat
      • Anti afk
      • Anti drowning
      • Auto totem
  • Extensive logging
  • Share proxies with plug-and-play Ngrok tunnels
    • Your machine's IP is never shared with players connecting to your proxy
    • Your players' IPs are never shared with your machine

Images

Cli Gui

No-Frills Cli Gui

Webhooks

Convenient Discord Webhooks

Grep

Extensive Logs

For Developers

If you want to contribute to the project's source you must install developer dependencies (pnpm i) and use an editor with ESLint support.

You can run tests locally with pnpm testLocal. (pnpm test will test your actual config.json rather than ./test/test-config.json)