EndvoyantEndvoyant

Inviting the Bot

Use the hosted bot or self-host the Endvoyant source code yourself

Hosted Bot

The hosted version is the recommended path if you want the fastest setup.

First Steps After Inviting

  1. Run /about to confirm the bot is installed where you expect it.
  2. Run /add account and choose either the login flow or the cookie/token fallback flow.
  3. Open /settings to set your privacy, language, and DM notification preferences.
  4. Use /attendance, /profile, or /events to verify your setup.

Self-Hosting

If you want your own deployment, the current source expects:

  • Node.js
  • PostgreSQL
  • A Discord application with a bot token, client ID, and client secret

Environment Variables

Copy example.env to .env and set:

VariableRequiredPurpose
TOKENYesDiscord bot token
CLIENT_IDYesDiscord application client ID
CLIENT_SECRETYesDiscord application client secret
DATABASE_URLYesPostgreSQL connection string
ENVIRONMENTYesdevelopment or production
SURVEY_WEBHOOKOptionalDestination for /survey submissions

Setup Flow

If you want your own deployment:

  1. Clone the repository.
  2. Install dependencies with npm install.
  3. Copy example.env to .env and fill in the required values.
  4. Run npm run db:migrate.
  5. Deploy slash commands with npm run deploy.
  6. Start the bot with npm start.

Requirements

  • Node.js
  • PostgreSQL
  • A Discord application with bot credentials

Runtime Behavior

When the bot is online, the current source also starts background jobs for:

  • rotating the Discord presence on a schedule
  • automatic attendance for accounts with auto check-in enabled
  • refreshing linked account tokens in the background

Those jobs use the same linked-account and user settings managed through /settings.

For the full project source, see the GitHub repository.

Last updated on

On this page