StudyLion is a Discord bot that tracks members' study and work time while offering members the ability to view their statistics and use productivity tools such as: To-do lists, pomodoro timers, reminders, and much more.
Invite StudyLion here, and get started with !help.
Join the support server to contact us if you need help configuring the bot on your server, or start a discussion to report issues and bugs.
In the past couple of years, we noticed a new trend on Discord – instead of being a platform designed only for gamers, many students joined it as well, forming communities dedicated to studying and working together.
This bot was founder by Ari Horesh (Ari Horesh#0001) to support these forming study communities and allow students all over the world to study better.
You can self-host and fork the bot using the following steps, but beware that this version does not include our visual graphical user interface, which is only include in the custom private instances or our the public instance.
Follow the steps below to self-host the bot.
- Clone the repo recursively (which makes sure to include the cmdClient submodule, otherwise you need to initialise it separately)
- Install the requirements from
requirements.txt - Install Postgresql, and setup a database with the schema given in
data/schema.sql - Copy
config/example-bot.conftoconfig/bot.conf, filling in the appropriate information, including database connection arguments. - Start the bot from the top level
run.py.
We do not offer support for self-hosted bots, the code is provided as is without warranty of any kind.
- Students Cards and Statistics
Allow users to create their own private student profile cards and set customs study field tags by using !stats and !setprofile
- Camera only study rooms
Set specific channels to force users to use their webcam to study.
- To-Do List
Users can create and share their own to-do lists, and get rewards when completing a task! Use !todo to launch our interactive to do list!
- Reminders
Users can set their own private reminders, to drink water, stretch, or anything else they want to remember, every X minutes, hours, days, or maybe even just once.
Example: !remindme to drink water every 3h will send you a reminder every 3 hours to drink water.
- Scheduled Sessions
This feature allows the users to use their coins to schedule a time to study at. Book rooms using !rooms book
Not attending prevents everyone in the room from getting the bonus.
- Study and Work Statistics
In addition to the profile cards, users can view their daily, weekly, monthly and all-time stats, as well as their study streak. Use !weekly and !monthly to view your revision statistics in more detail.
- Pomodoro Timers
The bot will show the timer in the title of the study room and play a sound at the start and end of each session.
Commands: !timer , !pomodoro
- Private Study Rooms
Allows the members to create their own private study rooms and invite their friends to join!
Rent a room using !rent [usernames].
- Workout Rooms
Allows the Admins to create workout rooms with a bonus for people who workout.
- Study Tiers and Achievements
Reward users based on their total study time, allow them to get better ranks, and show off how long they've been working.
- Full-Scale Economy System
Reward users for studying, allow them to use the coins to buy private study rooms, schedule accountability rooms, and even change their name's color.
- Full-Scale Moderation System
Punish cheaters, audit-log, welcome message, and so much more using our full-scale moderation system.
A command list and general documentation for StudyLion may be found using the !help command, and documentation for a specific command, e.g. config, may be found with !help config.
Make sure to check the full documentation to stay updated.
