Skip to content

Installation

Gamer100309 edited this page Dec 25, 2025 · 10 revisions

📦 Installation Guide

Complete installation instructions for all supported platforms.


🎯 Choose Your Platform


💻 Windows Installation

One-Click Installer (Recommended)

Step 1: Download

⬇️ Download Windows Installer

Step 2: Run the Installer

  1. Double-click the downloaded .exe file
  2. If Windows shows a security warning:
    • Click "More info"
    • Click "Run anyway"
    • This is normal for unsigned executables

Step 3: Follow the Wizard

The installer will:

  • ✅ Check for Node.js and npm
  • ✅ Download the latest bot files
  • ✅ Install dependencies automatically
  • ✅ Create required directories
  • ✅ Configure your Discord bot token
  • ✅ Create a start script

Step 4: Done!

The bot is ready to use! You can:

  • Double-click start_bot.bat to start the bot
  • Or choose to start it immediately after installation

🐧 Linux Installation

Method 1: One-Line Install (Easiest)

Simply paste this command in your terminal:

bash <(curl -sSL https://raw.githubusercontent.com/Gamer100309/MC-Server-Status-Bot/main/install.sh)

The script automatically detects your architecture (x64 or ARM64) and downloads the correct installer!

Method 2: Manual Download

For standard Linux (Ubuntu, Debian, Fedora, etc.):

wget https://github.com/Gamer100309/MC-Server-Status-Bot/releases/download/v5.1.0_Release/RedCity_Industries_MC_Stats_Bot_Installer_Linux_x64
chmod +x RedCity_Industries_MC_Stats_Bot_Installer_Linux_x64
./RedCity_Industries_MC_Stats_Bot_Installer_Linux_x64

For Raspberry Pi / ARM64 systems:

wget https://github.com/Gamer100309/MC-Server-Status-Bot/releases/download/v5.1.0_Release/RedCity_Industries_MC_Stats_Bot_Installer_Linux_ARM64
chmod +x RedCity_Industries_MC_Stats_Bot_Installer_Linux_ARM64
./RedCity_Industries_MC_Stats_Bot_Installer_Linux_ARM64

Installing Node.js (if needed)

Ubuntu/Debian:

curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs

Fedora:

sudo dnf install nodejs npm

Arch Linux:

sudo pacman -S nodejs npm

🍎 macOS Installation

⚠️ Community Support - Not officially tested but installers are provided.

For Apple Silicon (M1/M2/M3/M4)

# Download
curl -L https://github.com/Gamer100309/MC-Server-Status-Bot/releases/latest/download/RedCity_Industries_MC_Stats_Bot_Installer_macOS_ARM64 -o installer-macos

# Remove quarantine (required for unsigned apps)
xattr -d com.apple.quarantine installer-macos

# Make executable and run
chmod +x installer-macos
./installer-macos

For Intel Macs

# Download
curl -L https://github.com/Gamer100309/MC-Server-Status-Bot/releases/latest/download/RedCity_Industries_MC_Stats_Bot_Installer_macOS_x64 -o installer-macos

# Remove quarantine
xattr -d com.apple.quarantine installer-macos

# Make executable and run
chmod +x installer-macos
./installer-macos

If macOS blocks the app

  1. Go to System PreferencesSecurity & Privacy
  2. Click "Open Anyway" next to the blocked app message

🛠️ Manual Installation

If the automated installer doesn't work:

Step 1: Prerequisites

Ensure you have:

Step 2: Clone Repository

git clone https://github.com/Gamer100309/MC-Server-Status-Bot.git
cd MC-Server-Status-Bot/Mc\ Server\ Stats\ Bot

Step 3: Install Dependencies

npm install

Step 4: Configure Bot Token

  1. Copy the example config:
   cp global-config.example.json global-config.json
  1. Edit global-config.json:
   {
     "token": "YOUR_DISCORD_BOT_TOKEN_HERE"
   }

See our Discord Bot Setup Guide for help getting a token.

Step 5: Start the Bot

node index.js

📋 System Requirements

Minimum Requirements:

  • Windows: Windows 10 or higher
  • Linux: Any modern distribution (Ubuntu 20.04+, Debian 10+, Fedora 35+)
  • macOS: macOS 10.15 (Catalina) or higher

For Running:

  • Node.js 18 or higher
  • npm 8 or higher
  • 100 MB free disk space
  • Internet connection

✅ Verify Installation

After installation, verify everything works:

# Check Node.js version
node --version
# Should show v18.x.x or higher

# Check npm version
npm --version
# Should show 8.x.x or higher

# Check bot files
ls
# Should show index.js, package.json, etc.

🔄 Next Steps

After successful installation:

  1. Create a Discord Bot - Get your bot token
  2. Configure the Bot - Customize settings
  3. First Steps - Add your first server
  4. Commands Reference - Learn available commands

⚠️ Troubleshooting

Having issues? See our Troubleshooting Guide for common problems and solutions.


← Back to Home | Next: Discord Bot Setup →

Clone this wiki locally