https://github.com/binamralamsal/WordSeek
WordSeek is a fun and competitive Wordle-style game for Telegram. Play solo or challenge friends in groups, track your scores on leaderboards, and enjoy a customizable gameplay experience. Perfect for quick challenges or extended group fun!
https://github.com/binamralamsal/WordSeek
drizzle-orm grammy telegram-bot wordle-game
Last synced: about 1 month ago
JSON representation
WordSeek is a fun and competitive Wordle-style game for Telegram. Play solo or challenge friends in groups, track your scores on leaderboards, and enjoy a customizable gameplay experience. Perfect for quick challenges or extended group fun!
- Host: GitHub
- URL: https://github.com/binamralamsal/WordSeek
- Owner: binamralamsal
- License: mit
- Created: 2024-08-24T15:04:07.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-02-15T15:59:31.000Z (2 months ago)
- Last Synced: 2025-02-15T16:32:50.789Z (2 months ago)
- Topics: drizzle-orm, grammy, telegram-bot, wordle-game
- Language: TypeScript
- Homepage: https://t.me/WordSeekBot
- Size: 854 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-grammY - binamralamsal/WordSeek - A fun and competitive Wordle-style game that you can play with friends. [á´œsá´‡](https://t.me/WordSeekBot) (Bots)
README
# WordSeek
## Features
- Play the Wordle-inspired word guessing game in private chats or group chats.
- Supports multiplayer gameplay in groups, with admin tools for game management.
- Keep track of scores with group and global leaderboards.
- Commands to view personal scores and leaderboard rankings filtered by time (today, week, month, etc.).
- Flexible game settings: customizable limits for attempts and group admin permissions.
## How to Play
1. **Start a game**: Use the `/new` command in a group or private chat.
2. **Guess the word**: Players try to guess a random 5-letter word.
3. **Hints after each guess**:
- 🟩 - Correct letter in the right spot.
- 🟨 - Correct letter in the wrong spot.
- 🟥 - Letter not in the word.
4. The game ends when:
- The word is correctly guessed, or
- Maximum number of guesses (30) is reached.
5. The first person to guess the word correctly wins!
## Commands
- **/new** - Start a new game.
- **/end** - End the current game (admins only in group chats).
- **/help** - Get help with commands and game rules.
- **/leaderboard** - View leaderboards for the group or globally. Example:
```
/leaderboard global week
```
- **/myscore** - View your score. Example:
```
/myscore group all
```
- **/stats** - View bot usage stats (admin users only).
## Installation & Setup
### Requirements
- Node.js
- Telegram Bot Token (create one via [BotFather](https://core.telegram.org/bots#botfather))
- PostgreSQL or SQLite database
### Steps
1. Clone the repository:
```bash
git clone https://github.com/binamralamsal/WordSeek
cd WordSeek
```
2. Install dependencies:
```bash
bun install
```
3. Configure the environment variables:
- Create a `.env` file:
```
BOT_TOKEN=your-telegram-bot-token
DATABASE_URL=your-database-url
```
4. Run the bot:
- Start the bot in development mode:
```bash
bun run dev
```
- Or run in production:
```bash
bun run start
```
## Technologies Used
- **[grammy](https://grammy.dev/)**: Telegram Bot API framework.
- **Drizzle ORM**: Simplified database queries.
- **PostgreSQL**: Persistent storage for game data.
- **Bun.js**: Blazing fast JavaScript runtime.
- **Zod**: Schema validation.
## Additional Resources
- **Try the Bot**:
- [WordSeek I](https://t.me/WordSeekBot) *(Main bot)*
- [WordSeek II](https://t.me/WordSeek2Bot) *(Use this if the main bot is busy)*
- **Join the Official Group**: [Word Guesser Group](https://t.me/wordguesser) - Play the game, discuss strategies, and share feedback.
- **Support the Developer**: [Binamra Bots Channel](https://t.me/BinamraBots)
- **Contact the Developer**: Suggestions? Reach out on Telegram: [@binamralamsal](https://t.me/binamralamsal)
## Contributing
We welcome contributions to enhance the bot! Here's how you can help:
1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Commit your changes and open a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.