ilo Linku: Toki Pona bot

This bot aims to support various Toki Pona needs on Discord, particularly Sitelen Pona and access to dictionaries such as Linku and Kemeka.

Contributing

This is a collaborative project brought to you by the Toki Pona community.

Your help is welcome! Feel free to submit pull requests if you find anything that needs improvement.

Want to help but you're new to Github? We can help!

You can also join the Discord and talk to the maintainers!

To run locally:

• git submodule update --init
• Install uv
• Install fribidi and libraqm. On Linux you likely already have these. If not, /sp will fail!
• Follow the instructions in Setup to create a bot account.

Then:

• Run the bot: uv run -m ilo
• Run tests: uv run pytest
• Regenerate code from JSON schemas: uv run datamodel-codegen --all-jobs

Self-hosting

Prerequisites

• git submodule update --init

To run in a Podman environment (default):

• Podman
• Podman Compose

To run in Docker environment:

• Docker
• Docker Compose

Setup

• Create a bot account on the Discord developer portal. Follow official Discord instructions for that.
• Make sure to enable the following in the developer portal:
  • Scopes:
    • bot
    • applications.commands
  • Permissions:
    • Send Messages
    • Send Messages in Threads
    • Embed Links
    • Attach Files
    • Use Slash Commands
• Save your bot token to a .env file as DISCORD_TOKEN=longstringofcharactersyougotfromtheportal.
• Run the bot: podman compose up or docker compose up.

License

ilo Linku is licensed under GPL-3.0.