Discord bot for sending and collecting gifts
Home Page: https://podaboutli.st/discord
License: GNU Affero General Public License v3.0
Made for the Podcast About List Discord server: https://podaboutli.st/discord
Add logging to file to make it easier to inspect exceptions and fix bugs. Easier than scrolling through docker logs.
This feature changes or adds functionality to:
.env, scripts, etc.)Replacing the @santa my and @santa global commands is the @santa stats command.
This feature changes or adds functionality to: report various statistics about gift-giving through the bot. Ideally I'd like these wrapped in an Embed to give them some snazz.
Commands would function as follows:
@santa stats: prints a message asking for me, a @mention, or global@santa stats me: displays the following statistics for a user:
max_present_count in santabot/db/models/user.py.env, scripts, etc.)When using Postgres as a database provider, cooldowns on gifting times don't work.
docker-compose.yml using the one from docs/docker-compose up.env, scripts, etc.)What the title says. Move the data we're currently storing in config/config.json to environment variables so we can use .env files and easily deploy Docker images.
There is still some code in santabot/cogs/grinch.py that fetches the webhook avatar URL which was going to use data from config.json. See line #23. Shouldn't be missed when working on this issue.
We need to configure unit tests. These should include:
GrinchManager)Having channel stats/leaderboard in the #christmas channel topic seems like a good idea, then it can auto update on an interval rather than having to be summoned. Need to investigate how to edit a topic and how to implement recurring processes.
This feature changes or adds functionality to:
.env, scripts, etc.)Add @santabot debug command that displays:
Only allow the command to run if the user is a server admin.
This feature changes or adds functionality to:
.env, scripts, etc.)Discord already strips white space from the end of messages, but sometimes present names are still blank?
@SantaBot (beta) please give me .env, scripts, etc.)Implement a help page for SantaBot. This could be achieved through customizing Discord.py's built in HelpCommand, or by writing a GitHub Gist, markdown file in this repo, GitHub Wiki page, custom web page, or any other method of effectively showing the user how to use the bot.
More user testing is also needed to figure out what the best way to display functionality is.
The @santa help command should effectively communicate how to use SantaBot to users.
.env, scripts, etc.)* Unless we create a new website lol
If you say, for example, @santa give me my own item, you get the response check... for my own item. A stretch goal is implementing changing perspective to second person, where we would see something like:
@santa give me my own item -> check... for your own item
.env, scripts, etc.)Didn't include these in the design doc, but these should get some consideration: commands for administrative action.
Functionality should include but isn't limited to:
Implementation with the wordfilter package would be very simple. We can use the default list and simply reject the present if it has a bad word in the name.
This feature changes or adds functionality to:
.env, scripts, etc.)Adds wordfilter, which will speed up development time without adding too large a dependency.
docker build doesn't include the .git directory, so git rev-parse --short HEAD fails when trying to set the bot's status message. One possible solution is to move Docker builds to Travis, then use docker push so we can use Travis to set default environment variables for the image
ralphorama/santabot).env, scripts, etc.)Docker kicks ass. Gotta add it to this repo.
We'd need to add:
Dockerfile.dockerignoredocs/docker/docker-compose.yml example configuration fileAnd:
This feature changes or adds functionality to:
.env, scripts, etc.)Adds optional dependencies on Docker, but not required.
The limiting factor for this project right now is getting database integration up and running.
The DB functionality should be accessible from individual cogs so database logic can be abstracted out to its respective functions.
We need tables to store data for:
userspresentsserversFunctionality that we still need to add:
When using @santabot give, after a while, the cooldown stops being enforced. I'm sure this is some logical blunder on my part.
give commands.env, scripts, etc.)Currently, @santabot stats doesn't display anything. It should display the same information as @santabot stats global.
@santabot stats command.env, scripts, etc.)README.md needs some updates to documentation. It could use:
If I think of more stuff I'll add it to the list.
This feature changes or adds functionality to:
.env, scripts, etc.)Depends on #2.
The current implementation of santabot/cogs/grinch.py contains the class GrinchManager which caches a discord.Webhook object, but doesn't save the details for when the bot is restarted. This leads to a lot of webhooks getting created when testing the grinch commands that one needs to delete by hand.
Once database support is functional, we should cache these values in the db. See docs/DESIGN.md for more info.
The current algorithm for predicting the chance of the Grinch visiting the user seems to result in a very high visit rate (only tested at a lower number of gifts). See the current implementation here
My current implementation for the Grinch Visit algorithm is:
def calc_steal_chance() -> bool:
# Generate a number between 0 and the # of presents the User currently owns
rand_int = random.randint(0, current_present_count)
# Take the cube root of the User's present count
threshold = int(present_count ** (1 / 3))
# If the user said 'Please', give them a 5% better chance at not failing the check
threshold = threshold * 1.05 if please else threshold
# If rand_int > threshold, steal presents
return rand_int > thresholdThe logic behind this was to use cube root falloff so as a user's present count gets higher, the threshold determined via cube root levels off (see graph).
However, this dropoff is way too fast. Gotta rewrite the algo.
n/a
.env, scripts, etc.)Discord users can set arbitrary status messages. The bot should have one that, ideally, would rotate through several messages on a timer:
- ''Use @santa help for help"
- "Sent {0} presents to {1} users"
- "Christmas (EST) is in days_left days"
For now, a static message that just displays the first help message is fine.
This feature changes or adds functionality to:
.env, scripts, etc.)Some cogs have functions to which I didn't add type hints or docstrings. Adding these will definitely help new contributors to this project.
Please keep in mind you should add documentation like this to your own code before submitting PRs. Don't be lazy like me!
Adds leader boards, sorted by gift count. @santa top displays the users with the most presents in the server. @santa top all displays users with the most presents from all servers.
This feature changes or adds functionality to:
.env, scripts, etc.)
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.