{"id":13989424,"url":"https://github.com/HeySreelal/xwordlebot","last_synced_at":"2025-07-22T10:32:22.372Z","repository":{"id":44434345,"uuid":"460978683","full_name":"HeySreelal/xwordlebot","owner":"HeySreelal","description":"Telegram Bot inspired by the Wordle game.","archived":true,"fork":false,"pushed_at":"2023-07-16T09:41:42.000Z","size":115,"stargazers_count":18,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-09T13:15:52.583Z","etag":null,"topics":["bot","game","grammy","telegram","typescript","wordle"],"latest_commit_sha":null,"homepage":"https://t.me/xwordlebot","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HeySreelal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-02-18T19:23:18.000Z","updated_at":"2023-07-16T09:42:32.000Z","dependencies_parsed_at":"2024-01-18T04:11:19.362Z","dependency_job_id":"c45eaa32-a818-4152-bb01-7e13ab1586cb","html_url":"https://github.com/HeySreelal/xwordlebot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeySreelal%2Fxwordlebot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeySreelal%2Fxwordlebot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeySreelal%2Fxwordlebot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HeySreelal%2Fxwordlebot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HeySreelal","download_url":"https://codeload.github.com/HeySreelal/xwordlebot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227079366,"owners_count":17727996,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","game","grammy","telegram","typescript","wordle"],"created_at":"2024-08-09T13:01:38.793Z","updated_at":"2024-11-29T08:31:21.577Z","avatar_url":"https://github.com/HeySreelal.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Wordle Bot\n\nThis is a simple bot inspired by [Wordle game](https://www.nytimes.com/games/wordle/index.html).\n\nThe bot is entirely written in TypeScript. Thanks to [grammY](https://grammy.dev/) Telegram Bot framework. And to [datamuse](https://www.datamuse.com/api/) API for word check.\n\n# 🗃️ Archive Notice\n\nThis repo is archived as this code is no longer maintained. I've rewritten the bot in Dart and is available here: [HeySreelal/xwordle](https://github.com/HeySreelal/xwordle).\n\n## Give a try! [@xWordleBot](https://t.me/xwordlebot).\n\n\u003chr\u003e\n\n## Setup\n\n1. Clone the repo.\n2. Run `npm install`\n3. Create an .env file with the following variables:\n   1. BOT_TOKEN - the Telegram bot token provided by [@BotFather](https://t.me/BotFather)\n   2. LOGS - Telegram channel or group ID where the bot will send logs. (Make sure bot is an admin of the channel or member of the group).\n   3. ADMINS - Telegram User IDs of the admins of the bot.\n   4. Check the [.env.sample](./.env.sample) file for reference.\n4. Create a Firebase Project and download the Admin SDK creds as `service-account.json`. Save the file inside `src/config/`\n5. Run `npm run build` - Make sure you have installed the latest version of [TypeScript](https://www.typescriptlang.org/download)\n6. And to complete the setup run `npm run setup`.\n7. Run `npm start` to start the bot.\n\n## Words\n\nYou can customize the words to be used by the bot by editing the [`src/config/words.ts` file](./src/config/words.ts).\n\n\u003chr\u003e\n\n## TODOs:\n\n- [x] Add error handlers.\n- [ ] **Meaning of Words**: Thinking of adding `/meaning` command or similar thing to send the meaning of the word at the end of the game daily.\n- [ ] **Better Reminders**: Currently we're sending reminders only to people who have played yesterday's game and turned on notifications. I think, it's better to nudge the users who haven't played the game for a while like 7 days or more to play.\n\n## Thanks ❤️\n\nShow some love by sharing the bot with your friends!\n\n[Twitter](https://twitter.com/HeySreelal) | [Xooniverse](https://t.me/xooniverse)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHeySreelal%2Fxwordlebot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHeySreelal%2Fxwordlebot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHeySreelal%2Fxwordlebot/lists"}