ReminderVoteBot

English · Français · Project website

A Discord bot that reminds your players to vote for your server at the right time: by direct message or channel mention, for each voting site, following their own hours and timezone.

Features

• 🔔 Reminders by DM or mention in the channel picked by the admin, with automatic fallback to DM
• 🕗 Time windows: presets (daytime, morning, evening…) or exact hours, overnight windows included
• 🌍 Per-player timezone
• 🎯 Several voting sites (up to 25), each with its own cooldown (1 h to 24 h) and channel; the username is inserted in the URL
• ✅ Buttons in the reminder: Vote now, I voted (restarts the timer), In 30 min
• ⚡ One-click voting (optional): with a public domain, Vote now records the vote by itself
• 📋 /status: last vote and next reminder, edit or delete in one click
• 🛡️ Reliable: saves with a backup copy, non-root container, admin commands restricted to “Manage Server”
• 🇬🇧 🇫🇷 English or French

Installation

The bot ships as a ready-to-use Docker image (linux/amd64 and linux/arm64): all you need is Docker with Docker Compose.

1. Create the Discord bot

1. On the Discord Developer Portal, create an application.
2. Copy its Application ID (General Information tab), then in the Bot tab, generate and copy the token.
3. Invite the bot to your server with this link, replacing APPLICATION_ID:

   https://discord.com/oauth2/authorize?client_id=APPLICATION_ID&scope=bot%20applications.commands&permissions=19456
   

   (permissions: view channels, send messages, embed links)
4. Get your server ID: enable Developer Mode in Discord settings, then right-click the server → Copy Server ID.

2. Create the docker-compose.yml file

In a dedicated folder (for example remindervotebot/), create this file and replace the first three values:

services:
  bot:
    image: ghcr.io/mrddream/remindervotebot:latest
    container_name: ReminderVoteBot
    restart: unless-stopped
    init: true
    # Registers the slash commands on your server, then starts the bot
    command: sh -c "node src/deploy-commands.js && exec node src/index.js"
    environment:
      DISCORD_TOKEN: "bot_token"
      CLIENT_ID: "application_id"
      GUILD_ID: "your_discord_server_id"
      BOT_LANG: "en"
      DEFAULT_TZ: "Europe/London"
      # Optional: one-click voting (see below), uncomment both lines
      # PUBLIC_BASE_URL: "https://vote.example.com"
      # MARK_SECRET: "32+ characters, e.g. openssl rand -hex 32"
    volumes:
      - bot_data:/app/data
    # Only needed for one-click voting
    ports:
      - "3000:3000"

volumes:
  bot_data:

3. Start

docker compose up -d
docker compose logs -f   # to follow the startup

On startup, the bot registers its slash commands on your server. An administrator then adds the voting sites with /addvote, and players subscribe with /subscribe.

Update

docker compose pull && docker compose up -d

Subscriptions and voting sites are kept in the bot_data Docker volume.

Updating from an image older than October 27, 2026: the container no longer runs as root. If the bot refuses to start and reports data it cannot write, run once:

docker compose run --rm --user root bot chown -R node:node /app/data

One-click voting (optional)

By default, Vote now opens the voting site directly, and the player clicks I voted to restart their timer. To record the vote automatically:

1. Make the bot reachable from the Internet on an HTTPS domain, for example with a reverse proxy (Caddy, Nginx, Traefik…) to port 3000 of the container.
2. In docker-compose.yml, uncomment PUBLIC_BASE_URL with that domain and MARK_SECRET with a key of at least 32 characters (openssl rand -hex 32).
3. Restart: docker compose up -d.

The button then goes through a personal link, signed and valid for 7 days, that records the vote and redirects to the site. In channel mention mode, this link is sent to the player privately, so other members cannot vote in their place.

Configuration

Variable	Required	Description	Default
DISCORD_TOKEN	Yes	Bot token	-
CLIENT_ID	Yes	Bot Application ID	-
GUILD_ID	Yes	ID of the bot's Discord server: commands only exist there, and admin commands only work there	-
BOT_LANG	No	Bot language: en or fr	fr
DEFAULT_TZ	No	Timezone offered to players by default (e.g. Europe/London, America/New_York)	Europe/Paris
PUBLIC_BASE_URL	No	Public domain of the bot, for one-click voting	-
MARK_SECRET	With PUBLIC_BASE_URL	Signing key for vote links, 32 characters minimum	-
PORT	No	Port of the bot's HTTP server	3000

The bot checks its configuration on startup and stops with an explicit message if something is missing or invalid.

以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗