Quick Start Guide

This guide will help you get SSoggySouls up and running in 8 simple steps. For more detailed instructions, see the Installation Guide.

Note: Fabric, Forge, and NeoForge versions are currently in an early testing phase. Expect frequent updates and please report any bugs you find!

Prerequisites

For a Single Server Setup (Easy):

For a 2-Server Setup (Advanced):

Installation Steps

Step 1: Download

Download the latest SSoggySouls-4.5.7.jar from:

Step 2: Install Plugin

Place SSoggySouls-4.5.7.jar in your server’s plugins/ folder.

If using a 2-server setup, install it on both backend servers:

Important: If using a proxy, install on backend servers only, NOT on Velocity!

Step 3: Generate Config

  1. Start both servers to generate default config.yml files
  2. Stop both servers after generation

You should see a plugins/SSoggySouls/config.yml file on each server.

Step 4: Configure Database

Option A: Single Server (SQLite) If you only run one server, just verify your config.yml is set to sqlite:

database:
  type: "sqlite"

Option B: 2-Server Setup (MySQL) If you run Main + Limbo, you need one MySQL database. Set it up once, then put the same connection details in config.yml on both servers:

database:
  type: "mysql"
  host: "localhost"        # Your database host
  port: 3306               # Your database port
  name: "ssoggysouls"       # Your database name
  username: "root"         # Your MySQL username
  password: "your_password" # Your MySQL password
  pool-size: 5
  table-name: "hardcore_players"

For Pterodactyl users:

  1. Go to your panel → Databases tab
  2. Create a new database
  3. Use the provided host, port, username, and password in config

Step 5: Configure Server Roles (2-Server Setup Only)

If you are only running a single server with SQLite, skip this step — leave the defaults.

On Main server (config.yml):

is-limbo-server: false        # This is the Main server

main-server-name: "main"      # Must match your Velocity config

limbo-server-name: "limbo"    # Must match your Velocity config

On Limbo server (config.yml):

is-limbo-server: true         # This is the Limbo server

main-server-name: "main"      # Must match your Velocity config

limbo-server-name: "limbo"    # Must match your Velocity config

Tip: The server names must exactly match the server names in your velocity.toml file.

Step 6: Set Limbo Spawn

  1. Start the Limbo server
  2. Join the Limbo server in-game
  3. Stand where you want dead players to spawn
  4. Run /setlimbospawn
  5. Verify the spawn location is saved in config

Step 7: Configure Proxy Forwarding

For Velocity:

Edit velocity.toml:

player-info-forwarding-mode = "modern"

For BungeeCord/Waterfall:

Step 8: Restart & Test

  1. Restart both servers
  2. Check console for successful database connection messages
  3. Test the complete flow:

    • Join the Main server

    • Use /pstatus to check your lives

    • Kill yourself enough times to lose all lives

    • Verify you’re transferred to Limbo

    • Use /psadmin revive <player> to revive yourself

    • Verify you’re returned to Main

What’s Next?

Customize Your Settings

Review and customize these important settings in config.yml:

See the Configuration Reference for details on all options.

Learn About Features

Troubleshooting

Having issues? Check the Troubleshooting Guide for solutions to common problems.

Quick Reference

Death Modes

| Mode | Behavior | | ——————– | ————————————————————————————- |

hybrid Dead players get 5 minutes in spectator mode to be revived, then transferred to Limbo
spectator Dead players stay on Main in spectator mode indefinitely until revived (SQLite default)
limbo Dead players immediately transferred to Limbo upon losing all lives

Essential Commands

| Command | Description | | ———————————- | ———————- |

/pstatus [player] Check lives and status
/revive <player> Revive a dead player
/psadmin lives <player> <amount> Set player’s lives
/psadmin grace <player> <hours> Set grace period
/setlimbospawn Set Limbo spawn point

For the complete command list, see Commands.

Need Help?

← Back to Home Installation Guide →