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

# Castor

> Overview of Castor, an open source Discord bot with minigames, image generation, and utility commands.

<Warning>
  Castor's documentation is under construction. The repository README below is
  the most reliable reference for setup and configuration right now.
</Warning>

Castor is a fun Discord bot built with TypeScript and discord.js v14. It's a full
rewrite of [KSJaay's Castor](https://github.com/KSJaay/Alita/tree/Castor) with a lot
more features, and was originally made for the
[No Text To Speech](https://discord.gg/ntts) server.

## Feature overview

<CardGroup cols={2}>
  <Card title="Games & Entertainment" icon="gamepad">
    8Ball, coin flip, dice, slots, tic tac toe, rock paper scissors, and leaderboards.
  </Card>

  <Card title="Fun Commands" icon="wand-sparkles">
    Dad jokes, meme generator, image captions, speech bubbles, and roleplay
    actions.
  </Card>

  <Card title="Utility" icon="wrench">
    Ping, browser connectivity checks, and per-server settings.
  </Card>

  <Card title="Staff Commands" icon="shield-halved">
    Add and remove dad jokes, and migrate jokes between databases.
  </Card>
</CardGroup>

## Self hosting

Castor is open source under the MIT license. The repository README covers everything
needed to run it yourself.

<CardGroup cols={2}>
  <Card title="Source Code" icon="github" href="https://github.com/Foreverably/Castor">
    Clone, configure, and build Castor from source.
  </Card>

  <Card title="Issues & Pull Requests" icon="code-pull-request" href="https://github.com/Foreverably/Castor/issues">
    Bug reports and pull requests are welcome.
  </Card>
</CardGroup>

<Note>
  Castor needs Node.js 18 or newer, a MongoDB instance, a MariaDB instance,
  and a Browserless endpoint with Chrome for the image commands.
</Note>

## Policies

<CardGroup cols={2}>
  <Card title="Terms of Service" icon="file-contract" href="https://forwynn.net/castor/tos.html">
    The terms that apply when you use Castor.
  </Card>

  <Card title="Privacy Policy" icon="shield" href="https://forwynn.net/castor/privacy.html">
    What data Castor stores and why.
  </Card>
</CardGroup>


## Related topics

- [Forwynn Documentation](/index.md)


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