https://github.com/atikahe/wordl-bot

Bot to accommodate playing wordle on discord.
https://github.com/atikahe/wordl-bot

bot discord discord-bot game

Last synced: about 2 months ago
JSON representation

Bot to accommodate playing wordle on discord.

• Host: GitHub
• URL: https://github.com/atikahe/wordl-bot
• Owner: atikahe
• License: other
• Created: 2022-02-03T09:32:53.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-19T15:08:33.000Z (over 3 years ago)
• Last Synced: 2025-03-28T18:51:53.566Z (over 1 year ago)
• Topics: bot, discord, discord-bot, game
• Language: JavaScript
• Homepage: https://dsc.gg/wordl
• Size: 315 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Wordl Bot

![Github CI](https://github.com/atikahe/wordl-bot/actions/workflows/tests.yml/badge.svg)

 [![HitCount](https://hits.dwyl.com/atikahe/wordl-bot.svg?style=flat)](http://hits.dwyl.com/atikahe/wordl-bot)

Play wordle on your discord server! Inspired Josh Wardle's puzzle game and other variations of it found on the internet.

## How to use bot

Invite this bot to your server. Link goes [here](https://dsc.gg/wordl)

Use ```/``` as prefix with these commands:

- ```start``` to start a session

- ```guess``` to make a guess

The game will start as ```wordle``` mode by default, the good old-fashioned, one five-lettered word. However in the future we will have ```dordle``` and ```quordle``` mode options to spice up the race.

## How to setup

- Git clone this repository

- Setup token, client id, and guild id variable in env

- ```npm install```

- ```node src/deploy-commands.js```

- And you're ready to go

## How to test

- Use ```npm run test:live``` command to run ```jest --watchAll``` in the background

- Use ```npm run test```command to run the test one time and generate coverage report

## TODO

- Keep track of winner

- Check if word is english

- Put guess evaluation to separate function

- Isolate test cases

## What to improve

- Research command format (which format is most preferred)

- Beta user

## Resources

- [Discord.js](https://discord.js.org/#/)

- [Keyv](https://www.npmjs.com/package/keyv)

- [Nodemon](https://www.npmjs.com/package/nodemon)

- [Redis](https://redis.io)