luckperms / clippy

A (very) helpful office assistant for the LuckPerms Discord.

clippy

It looks like you are trying to understand this bot

clippy is our small Office Assistant:tm: bot used on the LuckPerms Discord to aid with support tasks like providing useful links to the wiki or reminding people to not tag staff members.

Contributions

If you would like to help with development on Clippy then please read CONTRIBUTING.md

clippy's Issues

Add a !docs command

The Discord could really benefit from Clippy having a !docs command

This command would essentially search the LuckPerms Javadoc for the provided info and returns whatever it can find for it.

---

Example

Running !docs NodeAddEvent#getNode() would give the below output (as Embed)

@NonNull NodeAddEvent#getNode() : Node
Gets the node that was added

Returns:
The node that was added

---

Issues/Downsides

The Javadocs are built agains Java 8.
This comes with the issue, that the URL won't reflect the current class/method being selected.
For example, would the above example still display the URL as https://javadoc.io/doc/net.luckperms/api/latest/index.html while it should preferably display as https://javadoc.io/doc/net.luckperms/api/latest/net/luckperms/api/event/node/NodeAddEvent.html#getNode() since this is a more reliable and shareable link.

Implementation of punishment-system

Idea is to add a system, to log warns and similar and maybe run automated actions if user received x warns.

Example:
User A advertises.
Mod runs !warn A advertised
Clippy logs the warn in a channel.
User A advertises again.
Mod runs command again
Clippy now kicks the user for the defined reason (Also logs it in the channel too)

Replacement for Dyno botlogs

TODO: elaborate

lmgtfy integration

So because a lot of users seem to be unable to google stuff themself, I had the idea to add a !google <term> command that generates a lmgtfy link that explains them how to look for stuff themself.

I think it would reduce the cases of "I am too lazy to google so google that for me"

Make Clippy auto-detect hastebin links and analyze them

This is an idea _11#8218 had on the Discord together with me.

It would be interesting and helpful if Clippy would look for messages containing links to hastebin-like sites and then analyze those for various information like if it is a server log or displays an error.
Then, depending on what it is, would clippy either return the information it could gather (Server version, LP version, plugins installed), solutions to common errors or nothing.

This would imo help gathering critical information for helping others without going through hundreds if not thousands of log-lines.

Maybe in addition to this could clippy have a auto-hastebin function to automatically push uploaded txt/log files to hastebin with a reminder to share logs through this site?

Add !help command

Suggestion is simple: Add a !help command that would show all available commands for the users.
Many people use Clippy's command but not everyone knows all the ones that are available.

Add auto-respond for when someone says "LuckyPerms"

We really should add this as it is a bit annoying if people constantly miss-pronounce LuckPerms as LuckyPerms.
This would also make a bit more sense for Clippy as it is based on the Word-Assistant we all know and hate love.

Automate donor "hall of fame" generation/updating

There is a new metadata endpoint at: https://metadata.luckperms.net/data/donors

It exports an up-to-date list of donors from the Patreon API, and combines this with a manual list of donations (from GitHub Sponsors or elsewhere) - and makes it available as a metadata endpoint that other services can consume.

The system respects the users privacy settings in Patreon, and only displays public pledges.

The idea is, we can use this endpoint to automatically update the Hall of Fame message in Discord.

My existing message will need to be deleted (clippy can't edit it), but after that, it should be possible to update it!

The metadata endpoint returns the following per user:

{"name":"Luck", "discord":"615647165548724372", "tiers":["Donor"]}

If the user is online/connected to Discord, we can use the Discord API to resolve their user id to their Discord username, and use that in the list.

If not, we can use their full name as given by Patreon.