Installation

This guide walks you through installing TPM on your system.

Installation Methods

The installation process varies depending on whether you're using standard TPM or TPM+, and whether you're running on a VPS or locally.

For Standard TPM (VPS)

Step 1: Set Up Your VPS

If you're using standard TPM, you'll need a VPS. See the VPS Setup Guide for detailed instructions.

Step 2: Install Node.js

TPM requires Node.js to run. Install Node.js on your VPS:

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

# Verify installation
node --version
npm --version

Step 3: Download TPM

Contact the TPM team to get access to the TPM files. Once you have access:

# Create a directory for TPM
mkdir tpm
cd tpm

# Download/clone the TPM files
# TODO: ADD LINK

Step 4: Install Dependencies

npm install

Step 5: Configure TPM

Create or edit your config.json5 file with your settings:

module.exports = {
    igns: ["YourMinecraftUsername"],
    discordID: "your-discord-id",
    webhook: "your-discord-webhook-url",
    session: "your-coflnet-password",
    // Add other configuration options
}

See the Config Structure documentation for all available options.

Join discord.gg/cfghub to buy or download a config

Step 6: Start TPM

node index.js

Your bot should now connect to Hypixel and start receiving flip notifications from Coflnet!

For TPM+

TPM+ may have a different installation process. See the TPM+ documentation for specific installation instructions.

Configuration Files

TPM requires a configuration file (config.js) with the following key settings:

Essential Configuration

{
    // Minecraft Accounts
    igns: ["account1", "account2"],

    // Discord Integration
    webhook: "your-webhook-url",

    // Coflnet Authentication
    session: "your-coflnet-password",

    // Timing Settings
    delay: 250,
    waittime: 15,
    clickDelay: 100,

    // Flipping Settings
    percentOfTarget: {...},
    listHours: {...},
    relist: true
}

For a complete guide on configuration options, see:

• Config Structure

• Filters and Settings

Common Installation Issues

Node.js Version Issues

TPM requires Node.js 16 or higher. Check your version:

node --version

Permission Errors

If you encounter permission errors on Linux:

sudo chown -R $USER:$USER /path/to/tpm

Network Issues

Ensure your firewall allows outbound connections to:

• Hypixel servers (mc.hypixel.net)

• Coflnet servers

• Discord (if using webhooks)

Tmux/PM2 for Persistent Running

To keep TPM running even after closing your terminal:

Using tmux

# Install tmux
sudo apt-get install tmux

# Start a new tmux session
tmux

# Start TPM
node index.js

# Detach from tmux: Ctrl+A, then D
# Reattach to tmux: tmux a

Using PM2

# Install PM2
npm install -g pm2

# Start TPM with PM2
pm2 start index.js --name tpm

# View logs
pm2 logs tpm

# Stop TPM
pm2 stop tpm

Next Steps

Now that TPM is installed:

1. Follow the Quickstart Guide to configure your first flips

2. Learn about Loading Configs

3. Customize your Filters and Settings

Getting Help

If you encounter issues during installation:

• Check the Troubleshooting Guide

• Contact TPM support through Discord

• Ensure all Prerequisites are met