Skip to content

Latest commit

 

History

History
70 lines (51 loc) · 2.15 KB

README.md

File metadata and controls

70 lines (51 loc) · 2.15 KB
Raw

ilo Linku

Overview

ilo Linku is a Discord bot for toki pona, providing the Linku dictionary, font rendering, and other miscellaneous features.

Self-hosting

Prerequisites

To run in a Podman environment (default):

To run in Docker environment (see Makefile):

To run locally:

  • Python 3.8+
  • pdm
  • fribidi
  • libraqm
  • Install your dependencies with pdm: pdm install or make init

You likely already have the last two, but a symptom of not having them is that /sp will emit normal text instead of sitelen pona!

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: make build up or make local, if you want the containerized or local bot respectively.

Contributing

Feel free to post issues, fork the repo, and open pull requests with your changes. You can also join the discord to contribute translations and talk to the maintainers.

License

ilo Linku is licensed under the GNU General Public License Version 3.