An open API service indexing awesome lists of open source software.

https://github.com/marechalg/countrydex

Pokรฉmon-like with flags, hosted on Discord
https://github.com/marechalg/countrydex

discordjs json nodejs

Last synced: 2 months ago
JSON representation

Pokรฉmon-like with flags, hosted on Discord

Awesome Lists containing this project

README

          

# ๐ŸŒ Countrydex

A Discord bot that turns geography into an addictive collection game. Hunt flags, guess countries, and compete with players worldwide.

## ๐ŸŽฏ Overview

Countrydex spawns flags from around the world in your Discord server. Race to identify them, build your collection, and climb the global leaderboard.

## โœจ Features

- ๐Ÿณ๏ธ **Auto-spawning flags** - New flags appear every hour at :30
- ๐ŸŽฎ **Interactive guessing** - Pop-up interface for country identification
- ๐Ÿ† **Global leaderboard** - Compete on completion rate, collection size, and speed
- ๐Ÿ“Š **Personal stats** - Track your progress with `/dex`
- ๐Ÿ’พ **Reliable data** - Database backed up daily

## ๐Ÿ› ๏ธ Commands

| Command | Description |
|---------|-------------|
| `/help` | Display all available commands |
| `/dex` | View your complete flag collection and stats |
| `/lb` | Check the global leaderboard |
| `/clear [1-99]` | Clear messages (requires `MANAGE_MESSAGES`) |
| `/ping` | Display latency and uptime |
| `/reset` | Reset your progression (โš ๏ธ irreversible for now) |

## ๐Ÿš€ Tech Stack

- **Runtime**: Node.js

- **Framework**: discord.js

- **Database**: PostgreSQL

- **Libraries**:
- node-vibrant (color extraction)
- moment (time handling)
- axios (HTTP requests)
- deepl-node (translations)

you can find more details into [packages file](package.json)

- **Hosting**: Raspberry Pi 5 (8GB)

## ๐ŸŽฎ How to Play

1. Add Countrydex to your Discord server
2. Flags will spawn automatically in designated channels
3. Click the pop-up and guess the country (name or code)
4. Build your collection and compete globally

## ๐Ÿ“ฆ Installation

Invite the bot in your server from this [Invitation Link](https://discord.com/oauth2/authorize?client_id=1342612831647957063&permissions=125968&integration_type=0&scope=bot+applications.commands)

## ๐Ÿ”ง Configuration

Countrydex only requires a text channel having `spawning` in its name, and the permissions asked in the invitation.

## ๐Ÿ“ License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## ๐Ÿค Contributing

Contributions are welcome ! Feel free to open issues or submit pull requests.

## ๐Ÿ“ž Support

Join our [Discord Server](https://discord.gg/ZSt2vPydbN) for support, updates and Beta Testing Programm.

---

**Sharpen your knowledge, and start your hunting journey.**