You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
0x1a8510f2 ae8f004c2e
Split CTX into GCTX and ECTX
5 months ago
locales Update deps + some work on help command 5 months ago
src Split CTX into GCTX and ECTX 5 months ago
.gitignore Add .gitignore and README 7 months ago
Cargo.lock Update deps + some work on help command 5 months ago
Cargo.toml Update deps + some work on help command 5 months ago
LICENSE Initial commit 7 months ago
README.md Initial actual README 7 months ago

README.md

MxSelfBot (WIP)

A Matrix bot designed to run behind your own Matrix account providing various helpful commands to enhance your Matrix experience

️ Features

  • Written in Rust for low resource usage and high performance
  • Fully free and open-source and based on matrix-rust-sdk
  • Supports end-to-end encryption
  • Extremely simple setup
  • No database - all data is stored in a Matrix room
  • So. Many. Commands!!!
  • Best Matrix bot ever[citation needed]

🤔 Usecases

  • Use features of advanced clients while using a simple or minimal client
  • Manage account while away/busy (with autoreply for example)
  • Quickly perform actions which would be slow otherwise, like removing multiple messages

💬 Commands

  • Meta:
    • help - Display all available commands
    • ping - Check if the bot is active
    • shutdown - End the bot's session and exit
    • restart - End the bot's session and restart it
  • Messaging:
    • msend - Send a message to a room
    • medit - Edit one of your own messages
    • msed - Edit one of your own messages as if using the sed utility
  • Rooms:
    • rjoin - Join a room
    • rleave - Leave a room
    • rinvite - Invite a user to a room
    • rkick - Kick a user from a room
    • rban - Ban a user from a room
    • rname - Edit the name of a room
    • ravatar - Edit the avatar of a room
    • ralias - Manage the aliases of a room
    • rpl - Edit the powerlevel of a user in the room
  • Account:
    • astats - Display statistics about your account
  • System:
    • sexec - Run a shell command on the bot's host

🔨 Setup

// TODO