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

# Installation

> Install Spyglass and connect Discord.

Spyglass lets you run your server from Discord and watch every command that gets typed on it. You define your own Discord slash commands in `config.yml`, and every in-game command is mirrored to a Discord channel you choose.

## Requirements

* Paper, Purpur, Spigot, or Bukkit 1.21 to 26.2

* Java 21+

* A Discord bot token

## Setup Guide

* Download the latest `Spyglass-1.0.jar` build.

* Place the jar file in your server plugins folder.

* Start or restart your server. Spyglass creates `/plugins/Spyglass/config.yml` and `/plugins/Spyglass/messages.yml`.

* Create a bot at the [Discord developer portal](https://discord.com/developers/applications), open the **Bot** tab, and press **Reset Token** to get your token.

* Invite the bot from **OAuth2 > URL Generator** with `bot` and `applications.commands` ticked.

* Turn on **Developer Mode** in Discord under User Settings > Advanced so you can right-click anything and choose **Copy ID**.

* Paste your token and server ID into `config.yml`, then run `/spyglass reload`.

## Minimum Config

These three values are all that is needed to get the bot online and logging commands:

```
discord:
bot-token: "your token here"
guild-id: "your discord server id"

command-monitor:
enabled: true
channel-id: "your channel id"
```

## Checking It Works

Run `/spyglass test`. It posts a message to your monitor channel and checks the token, the channel ID, and the bot's permissions in that channel in one go. If something is wrong it names which of the three failed instead of leaving you to guess.

No privileged intents need enabling in the developer portal.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.