on9wordchainbot

KO | EN

gitlite — search

#javascript #react #ai #typescript #go #golang #rust #linux #java #windows #cli #pytorch #security #ios

on9wordchainbot

(★ 45)

Telegram word chain bot

on9wordchainbot Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# On9 Word Chain Bot
![On9 Word Chain Bot logo](https://i.imgur.com/B4hjMC5.jpg)

(Epic icon by [@AdriTheDreamer](https://github.com/AdriTheDreamer))

On9 Word Chain Bot hosts games of word chain in Telegram groups.

### Telegram Links
- [On9 Word Chain Bot](https://t.me/on9wordchainbot) (Live Version)
- [Official Group](https://t.me/+T30aTNo-2Xx2kc52)
- [Word Additions Channel](https://t.me/on9wcwa)

## Installation

### Requirements
Python 3.10+ \
PostgreSQL 11+ \
2 Telegram bots

> It is highly recommended that you turn off privacy mode for On9 Word Chain Bot via @BotFather,
> which is on by default. Otherwise, leaving privacy mode on, the bot will only receive players'
> answers when they reply to the bot.

### Configuration
Copy `config.json.template` to `config.json`, then edit the following constants in `config.json`:

- `TOKEN`*: A Telegram bot token.
- `ON9BOT_TOKEN`*: Another Telegram bot token for the virtual player bot.
- `DB_URI`: A [PostgresSQL database URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING).
- `PROVIDER_TOKEN`*#: A Telegram payment provider token.
- `OWNER_ID`: Telegram user id of the bot owner.
- `ADMIN_GROUP_ID`^: Telegram group id of the bot admin group. Error messages and word addition requests are sent here.
- `OFFICIAL_GROUP_ID`^: Telegram group id of the official group of the bot.
- `WORD_ADDITION_CHANNEL_ID`^: Telegram channel id of the channel to announce word additions.
- `VIP`: A list of Telegram user ids designated as VIPs.
- `VIP_GROUP`: A list of Telegram group ids designated as VIP groups.

\*: Obtained via [BotFather](https://t.me/BotFather). \
\#: Optional if payment-related functions are commented out. \
^: Set to the same throwaway group if these features are not used.

### Table Creation
Create the required tables in your PostgreSQL database by running [init.sql](init.sql).

### Deployment
Install and update dependencies with `pip install -Ur requirements.txt`. \
Run `python -m on9wordchainbot`.

### Roadmap
- Switch from Markdown to HTML completely
- Fix slow db queries
- Fix slow `/trend` generation
- Rewrite to be more event-driven and principled
- Notify admin group when on maint mode and last game finishes
- Some kind of observability (dashboard?)
- Rate limiting
- Set up webhook?
- Make required letter game more reasonable
- Group leaderboard

### Development
```
pip install -r requirements-dev.txt
```

Type checking: `python -m mypy .`

on9wordchainbot

on9wordchainbot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

on9wordchainbot

on9wordchainbot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README