Skip to content

ScobbleQ/Endvoyant

Repository files navigation

Endvoyant

A Discord bot for Arknights: Endfield with utility commands to enhance your experience.

Features | Screenshots | Using the bot | Commands | Project Structure

Features

  • Automatic Sign-in: Daily attendance is checked automatically
  • Profile view: View your in-game profile with real-time data
  • Characters: Browse all Endfield characters with detailed info
  • Wiki: Quick access to operators, weapons, facilities, gear, missions, and more

Screenshots

Sign-in notification Profile view Character list catalog Exploration overview

Using the Bot

Hosted Version (Recommended)

The bot is hosted with a centralized database and 24/7 uptime. Get instant updates and skip the setup.

Invite Endvoyant or join our Community Server

Self-Hosted

Prerequisites

  • Node.js 18+
  • PostgreSQL database
  • Discord Application (Bot token, Client ID, Client Secret)

Setup

  1. Clone the repository

    git clone https://github.com/ScobbleQ/Endvoyant.git
    cd Endvoyant
  2. Install dependencies

    npm install
  3. Configure environment

    cp example.env .env

    Edit .env and fill in:

    Variable Description
    TOKEN Discord bot token
    CLIENT_ID Discord application client ID
    CLIENT_SECRET Discord application client secret
    DATABASE_URL PostgreSQL connection string (e.g. postgresql://user:pass@host:5432/db)
    ENVIRONMENT development or production
  4. Initialize the database

    npm run db:migrate
  5. Deploy slash commands

    npm run deploy
  6. Start the bot

    npm start

Database Scripts

  • npm run db:migrate — Apply migrations to the database (for fresh setups)
  • npm run db:studio — Open Drizzle Studio to inspect or edit data
  • npm run db:pull — Pull schema from an existing database (updates drizzle folder)

Commands

Command Description
/about About the bot
/add account Add your SKPort account to Discord
/attendance Claim daily sign-in rewards
/characters Show your obtained operators
/data Get your account data (ZIP)
/development Show regional development
/enka View profile via Enka.Network
/exploration Show region exploration progress
/profile View your in-game profile
/redeem Redeem Endfield codes
/settings View settings (coming soon)
/survey Open feedback surveys to improve the bot

Project Structure

  • src/ application source, including commands, events, database access, shared utilities, config, and constants
  • assets/ static images and fonts used by the bot output
  • drizzle/ generated migration and schema artifacts for database tooling
  • scratch/ non-runtime prototypes and experiments that should not be auto-loaded as bot commands

Contributing

Feature requests and contributions are welcome.

License

GPL-3.0-only