Skip to content
Β 
Β 

Repository files navigation

baibot logo

baibot

πŸ€– baibot is an AI (Large Language Model) bot for Matrix built by etke.cc (managed Matrix servers).

The name is pronounced 'bye'-bot and is a play on AI, referencing the fictional character πŸ‡§πŸ‡¬ Bai Ganyo.

It's designed as a more private and featureful alternative to matrix-chatgpt-bot. It's influenced by chaz, but does not use the AIChat CLI tool and instead does everything in-process, without forking.

🌟 Features

🧩 Chums additions

This is the chums branch of Chums-Team/baibot, the fork that runs the assistant of the Chums messenger. On top of upstream baibot it adds the following. All of it is optional: without the corresponding configuration the bot behaves like upstream.

  • πŸ’° Billing: an append-only SQLite ledger of the money spent per room. Each LLM call reserves, charges (the provider's real cost with a markup; for OpenRouter the cost it reports) and releases; spending caps per day and month; balance, stats and billing chat commands.

  • πŸ’Έ x402 top-ups: users pay USDT (TRC-20) on TRON into a room's balance, through the payment sidecar in this repository and an x402 facilitator; topup chat command.

  • πŸ“‘ Matrix events for the Chums client: cc.chums.x402_request, cc.chums.cap_hit, cc.chums.x402_topup_confirmed from the bot, cc.chums.set_user_locale from the client.

  • 🌍 Localization of the replies to users in 8 languages, per user, and an optional introduction per language after joining a room.

  • 🚧 Administrator-only commands, for deployments where users only talk to the bot.

  • πŸ” TRON wallet login: the bot authenticates with the key of a TRON wallet (private key or seed phrase) on homeservers where accounts belong to wallets and password login is off, and derives the passphrase of its encryption key backup from the same key, like the Chums web client. Cargo feature tron-login, on by default.

  • πŸ““ Runbook and a docker-compose.yml for running the bot next to the sidecar.

The changes are listed at the top of the changelog.

πŸ–ΌοΈ Screenshots

Introduction and general usage

You can find more screenshots on the 🌟 Features and other πŸ“š Documentation pages, as well as in the docs/screenshots directory.

πŸš€ Getting Started

πŸ—² For a quick experiment, you can refer to the πŸ§‘β€πŸ’» development documentation which contains information on how to build and run the bot (and its various dependency services) locally.

For a real installation, see the πŸš€ Installation documentation which contains information on πŸ‹ Running in a container and πŸ–₯️️️️️ Running a binary.

πŸ“š Documentation

See the bot's πŸ“š documentation for more information on how to use and configure the bot.

πŸ’» Development

See the bot's πŸ§‘β€πŸ’» development documentation for more information on how to develop on the bot.

πŸ“œ Changes

This bot evolves over time, sometimes with backward-incompatible changes.

When updating the bot, refer to the changelog to catch up with what's new.

πŸ†˜ Support

About

πŸ€– A Matrix bot for using different capabilities (text-generation, text-to-speech, speech-to-text, image-generation, etc.) of AI / Large Language Models (OpenAI, Anthropic, etc.)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages