FuyuBot

English | 简体中文 | Русский

---

Description:

A Telegram Bot project based on GramJS, supporting user-defined plugins.

---

Supported Platforms

Platform	Status
Windows	✔
Termux(Android)	✔
Linux	✔
MacOS	?(Untested)

For MacOS, while we currently don't have the equipment for testing, it should theoretically work. If you encounter any issues, please submit an Issue.

For Termux, please refer to the Termux Deployment Guide

---

Deployment

Prerequisites

1. Go to https://my.telegram.org/apps and register a new application to get the API ID and API Hash.

2. Create a Telegram Bot with @BotFather to get the Bot Token.

3. Install Node.js version 18 or higher.

Clone the Project

git clone https://github.com/CatMoeCircle/FuyuBot.git

Configure API

Create a .env file in the root directory of the project and add the following content:

API_ID=123456  # Telegram API ID
API_HASH=123456789abcdefghijklmn # Telegram API Hash
BOT_TOKEN=123456:ABCDEFGHIJKLMNOPQRSTUVWXYZ # Telegram Bot Token

---

Start

You can also use pnpm instead of npm.

Windows and Linux

npm i
npm run start

Termux

Use the installation script for a quick setup. The script will automatically configure the environment.

bash <(curl -sL https://github.com/CatMoeCircle/FuyuBot/raw/main/scripts/termux.sh)

# Jump to Configure API section above

npm i
npm run start

Or install manually

# Update package list
pkg update && pkg upgrade

# Install required packages
pkg install x11-repo tur-repo
pkg install nodejs 
pkg install python3 binutils binutils-is-llvm git
pip install setuptools
# Download Termux's Android NDK https://github.com/lzhiyong/termux-ndk
curl -L https://github.com/lzhiyong/termux-ndk/releases/download/android-ndk/android-ndk-r27b-aarch64.zip --output android-ndk-r27b-aarch64.zip
unzip android-ndk-r27b-aarch64.zip

# Configure NDK environment variables
export GYP_DEFINES="android_ndk_path='$HOME/android-ndk-r27b'"

# Clone the project, if already cloned, just enter the project directory
git clone https://github.com/CatMoeCircle/FuyuBot.git
cd FuyuBot

# Install dependencies
npm i

# Start the service
npm run start

---

Contact and Contribute

If you encounter any issues or have suggestions for improvements while using the bot, feel free to submit an Issue or Pull Request. Join our group for discussions.
@CatMoeCircle_Group Let's make FuyuBot even better together!