~ シンプル ~

A simple multi purpose discord bot written in Go (discord.go)
with focus on stability and reliability

Branch	Main CI	Docker CD	Releases CD
stable
canary

Invite

Here you can choose between the stable or canary version of shinpuru:

Intro

シンプル (shinpuru), a simple (as the name says), multi-purpose Discord Bot written in Go, using bwmarrin's package discord.go as API and gateway wrapper. The focus on this bot is not to punch in as many features and commands as possible, just some commands and features which I thought would be useful and which were the most used with my older Discord bots, like zekroBot 2, and more on making this bot as reliable and stable as possible.

Also, I want to use this project as a chance for me, to get some deeper into Go and larger Go project structures. In a later development state, this bot will detach zekroBot 2.

Features

In this wiki article, you can find an automatically generated list of all commands and their manuals.

Web Interface

shinpuru also offers a web interface to view members profiles, reports, the guild mod log and also configure the guilds settings for shinpuru like mod log channel, voice log channel or join/leave messages and channels.

ATTENTION: This web interface should be considered as 'beta version' because it is in a very early release state. If you are running into bugs or if you have suggestions, please contribute them as issue or pull request.

Moderation

shinpuru brings general guild moderation features like clearing messages in text channels (also user-specific, if required), reporting, muting, kicking and banning members. Those actions initiated with shinpurus moderation commands will be logged in a defined moderation text channel and in the database. So, all actions can be reviewed.

Also, there is a notify system, which creates a @notify role, which is as standard, not mentionable. Users can get or remove themselves this role by using the notify command. So, you can use this role as a replacement for @everyone, so it is like an "opt-in notification system".

You can combine that function with the ment command, which allows enabling or disabling mentionability of roles by command. If you enable the mentionability of @notify, for example, and after that, you mention this role in a message, the mentionability of this role will automatically be disabled.

Another feature is the autorole system: You can specify a role, which will be added to every user joined the guild.

Chat

Of course, there are some chats supporting commands like the say command, where you can create embedded messages with the bot with custom colors, titles, footers, images, and so on. Also, it is possible to create embeds from raw json data (like documented in Discords API docs). For example, here you can find the format of our development Discord guilds welcome message.

Another useful feature is the quote command, where you can quote messages from all text channels on a guild in any channel with jump to link. This can be generated by the ID or the URL of a message.

Time for some democracy? So, you can create reaction-interactive votes with the vote command.

Annoyed from ghost pings (messages with mentions, which were deleted, so you only see a mention but no message)? shinpuru has a system for detecting those ghost pings and punish people doing so by exposing the message which was deleted actually. You can also specify a format of how the warn message should look like, if you do not want to expose the message content or ping the victim again, for example.

Guild Backups

You want to be prepared for each emergency? Just enable the auto-backup system of shinpuru with the backup command. Then, a full backup of all of the guild roles, channels, members and guild settings will be saved every 12 hours. The last 10 backups are saved, so you have access to backups for the last 5 days. Of course, you can also automatically restore saved backups by using the backup restore command.

Twitch Notifications

With the Twitch Notification System, you can stay up to date which channels are currently live on Twitch! Just enter the command !twitch <twitchUserName> in a channel to set up the system. Then, every time, the channel goes live, a message will be posted to this channel, which will be automatically removed when the channel goes offline on Twitch.
Because of API limitations, the delay until the bot notifies a status change can be up to 3 minutes.

Code Execution

shinpuru is able to compile embedded code in messages on the fly, just by clicking a reaction under the message containing the code. The code will be sent to jdoodle's API, will be executed and the output will be displayed in the discord channel!

For setting up this system, use the exec setup command. Then, the bot will request your jdoodle's API credentials in DM (because we don't want you to send your credentials into a public guilds text chat). Then, the system will be set up and enabled on your guild. Your credentials will only be used for your guild, so every guild is responsible for their credentials. That also means, if you have an advanced jdoodle plan, you can use this accounts credentials, of course, for your guild.

Invite Link Blocking

By using the inv command, you can set up a guild-wide blocking for Discord Guild Invite Links. You can pass a minimum permission level users need to have to be allowed to send Invite Links. If users with a permission level below that, the messages including Invite Links will be deleted.

The system detects obvious invite links like discord.gg/<InvID> or discordapp.com/invite/<InvID>. Also, links which redirect to a Discord Invite link using the location header or some sort of HTML redirection methods, like link shorteners do, for example, will be blocked.

Voice Logging

Missing Teamspeaks voice activity log? Just specify a voice log channel with the voicelog command and every voice channel move will be logged in this channel.

Docker

Read about how to self-host shinpuru using the provided Docker image in the wiki article.

Compiling

Read about self-compiling in the wiki article.

Third party dependencies

Avatar of 御中元魔法少女詰め合わせ from 瑞希.

7h3730B/shinpuru