> ## Documentation Index
> Fetch the complete documentation index at: https://docs.poplock.scyne.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PopLock Server Management Toolkit

> A complete self-hosted Minecraft Server Management Toolkit (SMT) including a server graphical resource pack, a custom function datapack, Management CLI, automated backups, and even a REST API.

The SMT is a self-hosted Minecraft server management toolkit built for Linux. It bundles everything you need to run, automate, and remotely control a PaperMC or Vanilla Minecraft server: a custom resource pack, a custom function datapack, an interactive CLI, a daily snapshot system, and a REST API with Discord integration support.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get the server running in minutes with the full installation walkthrough.
  </Card>

  <Card title="Resource Pack" icon="palette" href="/resource-pack/installation">
    Install the PopLock custom textures and UI for Java Edition.
  </Card>

  <Card title="serv CLI" icon="terminal" href="/scripts/serv-commands">
    Manage your server from the command line — start, stop, backup, restore, and update.
  </Card>

  <Card title="API Reference" icon="code" href="/api/overview">
    Control the server remotely via the lightweight HTTP REST API.
  </Card>
</CardGroup>

## What's included

<CardGroup cols={2}>
  <Card title="Custom Resource Pack" icon="image">
    Enhanced textures, redesigned UI elements, and improved environmental aesthetics for Minecraft 26.1.
  </Card>

  <Card title="serv CLI" icon="terminal">
    Interactive shell commands for start, stop, restart, backup, restore, update, and status checks.
  </Card>

  <Card title="Automated Snapshots" icon="clock">
    Daily cron-triggered snapshots with 30-minute in-game countdown warnings and 7-day retention.
  </Card>

  <Card title="Three-Tier Backups" icon="database">
    Daily snapshots, full manual backups, and automatic restore undo points so you can always roll back safely.
  </Card>

  <Card title="REST API" icon="webhook">
    Zero-dependency Node.js API running on port 6767 with public read endpoints and API-key-secured write endpoints.
  </Card>

  <Card title="Discord Integration" icon="discord">
    Connect n8n to Discord slash commands so authorized users can manage the server without SSH access.
  </Card>
</CardGroup>

## How it fits together

```text theme={null}
Discord Slash Command
        │
        ▼
      n8n (stores API key, validates Discord role)
        │
        ▼
  PopLock API (:6767)
        │
        ▼
  serv CLI / tmux session
        │
        ▼
  Minecraft Server (PaperMC or Vanilla)
```

The `serv` CLI manages the Minecraft process inside a persistent `tmux` session. The REST API wraps `serv` commands over HTTP, and n8n acts as a secure relay between Discord and the API — keeping your API key off Discord entirely.