Skip to content

Here to help with moderation and community management!

License

Notifications You must be signed in to change notification settings

TulipSMP/Tiramisu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tiramisu, an italian cake with coffee, chocolate, and creamy white icing. Drawn in a simplistic square

Tiramisu

Lint

An open source discord bot for all audiences, developed by the folks at Tulip SMP.

⚠️ Not Ready for Production

This bot is not finished, and is far from useable. In the meantime, feel free to open a pull request to help us out.

URI Change

Make sure to update your local clone of the repo, with the following command:

git remote set-url origin https://github.com/TulipSMP/Tiramisu.git

Getting Started

See Getting Started for instructions on how to run and develop this bot.

All our documentation is in the doc/ directory.

Roadmap

There's a lot of things we'd like to do with this bot, but here's a general idea of our current scope of the project

Commands

For Moderation

  • /warn (with dm) [user, reason]
  • /announce [pings bool, message]
  • /addrole give all users a specific role (and /delrole)
  • /kick kick a user from the server
  • Right-click user or message to perform mod action
  • Logging of the following actions:
    • Message Deletion
    • Message Edit
    • VC Join/Leave
    • VC Start/Stop streaming/camera
  • Ticketing system
    • Simple command to create ticket
    • Button to create ticket
  • Mod application system
    • Configurable per guild questions
    • Simple command to apply
    • Button to apply
  • User Levelling system
    • Points system based on messages sent in qualifying channels
    • Levels system based on points
    • /level: check own level and points

Other Features

Bot Management

  • Cogs
    • Load Cogs
    • Unload Cogs
    • Reload Cogs
  • Shutdown bot correctly (instead of just an exit)
  • Check config/config.yml against config/exampleconfig.yml and add missing options to config.yml

Platform Links Planned For Future Release

  • Two-way websocket-based chat bridge (between Tiramisu and third-party client) to other platforms (i.e. Minecraft)

Messages & Variables

  • Load most reused messages from yaml
  • Get bot token from yaml
  • Get role and guild IDs from db
  • Guild-specific settings system via db

License

All source code is provided under the terms of the BSD-3-clause license.

Assets provided in the src/ directory are provided under the terms of Creative Commons CC0 1.0 Universal.