sunflowerfuchs / discord-bot Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 0.0 209 KB

A modular discord bot, built in PHP

PHP 100.00%

discord-bot's Introduction

Modular Discord Bot

A Bot for Discord, written in PHP.

The main goal was modularity, which enables it to easily be split into independently installable plugins.

Requirements

PHP >= 8.1
composer
discord developer application

Quickstart

The following snippet is all that is required to run the basic bot with the default plugins.

$bot = new SunflowerFuchs\DiscordBot\Bot([
    'token' => 'XXXXX'
]);
$bot->run();

Other features can easily be added to the Bot by just adding more plugins, like for example the TikTok Plugin.

$bot = new SunflowerFuchs\DiscordBot\Bot($options);
$bot->registerPlugin(new TiktokPlugin());
$bot->run();

discord-bot's People

Contributors

Stargazers

Watchers

discord-bot's Issues

Implement Guild object

Not sure why, but it seems I've forgotten to implement the Guild object.
See the discord api docs for more info.

P.s.: I should probably verify that all other objects are implemented.

Implement remaining Thread Permissions

See https://discord.com/developers/docs/change-log#updated-thread-permissions

Implement bot command permission system

Minimum, we need a 2 level permission system (regular user + admin), possibly more flexible though.

First thoughts right now:

Global admin
- Highly restricted high-level functionality that we could expose, like bot restarts/reloads
- how declared? editable at runtime? or static and defined in the config?
Per-Server admin
- less critical functionality, important for plugins
Extensible?
- Would allow plugins to create their own permission levels if needed, instead of being restricted to the 2/3 we decide to start with

Implement data storage

We need a simple data storage management.
There's two types of data that needs to be stored:

Bot data
Per-Plugin data

Implement sharding

Sharding isn't yet implemented, and it would be good to have if the bot should be able to run on many servers at once.

Implement WelcomeScreen object

See discord api docs

Write basic documentation

We should have a simple documentation for the following things:

How to launch the bot
What options the bot takes
How to write a plugin

Some functionality requires specific permission of the bot.
The permissions get first set when the bot gets invited to a server, so we need to define the permissions as early as possible.
Easiest way would be a public static const PERMISSION_REQUIREMENTS = (int) for every plugin, and then the bot gets a getPermissionRequirements():int function to use for the invite link.

Implement DMs

Immediate thoughts:

The bot should be able to react to things sent to it via dm.
Plugins should be able to:
- register commands available in DMs
- send DMs to users in reaction to server messages? (careful with this, since DMs should get initialized by users and not by bots, and opening too many too quickly may cause rate limiting or worse, see https://discord.com/developers/docs/resources/user#create-dm)

Improve error handling

Currently. if e.g. User::loadById() fails (due to e.g. a network error), it will cause a hard crash. We should probably improve error handling enough that an error within a plugin doesn't crash the entire bot.

Implement Guild Member Timeouts

See https://discord.com/developers/docs/change-log#guild-member-timeouts

Generate invite links

The bot should have a simple function to generate the links needed to invite it to servers.
Either:

Show during boot
Be available via plugin command

Implement help command

We need a help command.
It should probably look like this:

help [function]

Without a parameter, it lists all (currently available) commands.
With a parameter, it returns extended information for the given command, if available.

Clean up constructors

The constructors should use named arguments instead of accepting an array, and instead all objects should gain a static ::fromData() method that just calls the constructor.
That way we can actually construct elements without having to memorize the array structure, while keeping it easy to deal with api responses.

Implement GuildScheduledEvent object