purrbot-site / purrbot

A Discord bot for fun, entertainment and lots of nekos

Image made by Makay#0270

This bot was made to use the nekos.life-API but moved to its very own API.

Commands

Default Prefix: p.

The bot can have a different prefix on other Discord Servers.
If You're not sure what prefix is used can you just mention the bot (@*Purr*#6875) and it will tell you what prefix is used. Alternatively can you also start the command with the mention instead of the prefix.

A full list of all commands can be found on the wiki.
All commands require the following permissions:

• Read Messages
• Send Messages
• Embed Links
• Read Message History
• Add Reactions
• Use External Emojis

Translations

Thanks to the community is *Purr* available in various languages, and we're always open for adding more!
Want to help? Great! Just make sure to read the information provided in our documentation to find out how you can help.

All currently worked on translations can be found at lang.purrbot.site.

Inviting the bot

To invite the bot with all the necessary required permissions mentioned in the Commands Section you can use this invitation link:

https://discord.com/oauth2/authorize?client_id=425382319449309197&permissions=379968&scope=bot%20applications.commands

If you want to add the bot without a pre-made role, use this link instead:

https://discord.com/oauth2/authorize?client_id=425382319449309197&scope=bot%20applications.commands

Note that when you add the bot without a pre-made role, you will need to give it one with the necessary required permissions.

Note about Administrator permissions

The Administrator Permission is a dangerous one as it can allow bots to cause damage on your server with barely any way for you to prevent it (Except for kicking it).

To prevent such events from happening with *Purr* does it not execute any commands while having the Administrator permission assigned.
This is our way to protect your server from any possible harm.

We highly recommend to always have a dedicated Bot-Role which has the necessary permissions the bot requires and NEVER give Administrator permissions to any bot.
If a bot can't work without this permission, search for a different one as this is not considered a good practice in Bot Development.

Donations

Running the bot isn't free, which is why we appreciate any donations given to us.
Single donations can be done through Ko-fi or PayPal. Continous donations (Subscriptions) can be done through Patreon.

As a thank you for donation will you get a Donator role on our Discord Server. As a Tier 2 or 3 Patreon will you also unlock the option of defining your own custom Welcome background and icon (Requires you to be in our Discord Server).

Botlists

You can find *Purr* on the following Bot lists (Last updated: 21st Nov. 2022):

• Discord.bots.gg
• Discordextremelist.xyz
• Discordservices.net

We appreciate any upvotes/likes, but they aren't needed to use all the features of the bot.

License

This Bot is using the MIT License.
Please read the file for what you can and cannot do.

Useful Links

purrbot's Issues

v3 Overview

Quick overview over what needs to be done for the v3 rewrite.

v3 Rewrite requirements

Beta Give feedback

1. [v3] Move to slash commands #503
   Type: Enhancement v3 Rewrite +2
2. [v3] Improve overall code-quality #504
   Type: Enhancement v3 Rewrite +2
3. [v3] Better JSON file handling #505
   Type: Enhancement v3 Rewrite +2

Change of command .help

New command

.help [command]

Description

Shows all available commands, if no argument is provided.
Gives detailed command info, if you give a command-name after .help

Required permissions

none

Test issue for label-actions

Improving .welcome

• Updating images to new size
• Moving the welcome-image stuff to https://purrbot.site/api/welcome

google play

Bug/Issue

Expected behaviour

What should happen?

Actual behaviour

What happens instead?

Images/Links

Please provide any screenshots/links that help describing your issue in more detail.

aasas

wiki

Add .language command

The language command will allow server admins to set the language for their Guild.
That way can *Purr* respond with german messages on one Guild while responding in English on another.

The main parts I have to add are the following:

• An automatic system that adds the missing language setting of the guild in the database (Should be easy)
• A system that knows what languages and their codes (e.g. English with en) are available to determine if a given input is valid.

Add multi-language support [V4]

Feedback/Suggestion

Type

What kind of feedback is this? (Multiple options possible)

• New command
• Improvement of a command
• Other: Adding a language system

Description

Describe your feedback. What would change/be improved?

Adding a .lang <language> command to allow per-user translations of the information since not everyone speaks English and that would open a way to collaborate to the bot and also make the bot more personal.

This is planned for Version 4 of Purr which (hopefully) will be released soon.

Images/Links

Any images/links that could describe it more?

[v3] Better JSON file handling

An own JSON handler is used right now that isn't the best in terms of features or look.
Instead, should libraries such as Spongepowered/Configurate be used, as that would provide a much easier way of handling things.

[v3] Move to slash commands

Use Discord's slash commands for the bot's commands.

Currently missing by Discord

• Option to mark a command as "age-gated" (NSFW-only)
• Support for newlines in String options

Test issue for GitHub Bug report

[v3] Improve overall code-quality

The code as of right now is a mess (Courtesy of learning java while making the bot) and should be made from the ground up to get rid of unused and useless stuff and hopefully improve performance while doing so.

Adding command .prefix

New command

.prefix [New prefix|reset]

Description

Sends the currently used prefix in the Discord, if no argument is provided.
If argument(s) is/are provided, changes the prefix to the given argument(s).
Resets the prefix to the default one (.), if the argument is reset.

Required permissions

• .prefix - none
• .prefix [new prefix] - MANAGE_SERVER
• .prefix reset - MANAGE_SERVER

Adding command .invite

New command

.invite

Description

Sends a message in DM, that contains a link, to invite the bot with all required permissions and a link to the official Discord.

Required permissions

none