forked from TeamInklings/Octobot
Macintosh II
c6dd3727c3
mctaylors: - updated readme 7 times (and only adding new logo from /about) - [removed](aeeb3d4399
) bot footer from created event embed on the second try - [changed](4b9b91d9e4
) cdn from discord to upload.systems Octol1ttle: - Guild settings code has been overhauled. Instead of instances of a `GuildConfiguration` class being (de-)serialized when used with listing and setting options provided by reflection, there are now multiple `Option` classes responsible for the type of option they are storing. The classes support getting a value, validating and setting values with Results, and getting a user-friendly representation of these values. This makes use of polymorphism, providing clean and easier to use and refactor code. - Gateway event responders have been split into their own separate files, which should make it easier to find and modify responders when needed. - Warning suppressions regarding unused and never instantiated classes have been replaced by `[ImplicitUse]` annotations provided by `JetBrains.Annotations`. This avoids hiding real issues and provides a better way to suppress false warnings while being explicit. - It is no longer possible to execute some slash commands if they are run without the correct permissions - Dependencies are now more explicitly defined neroduckale: - Made easter eggs case-insensitive --------- Signed-off-by: Macintosh II <95250141+mctaylors@users.noreply.github.com> Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com> Co-authored-by: Octol1ttle <l1ttleofficial@outlook.com> Co-authored-by: nrdk <neroduck@vk.com>
42 lines
1.9 KiB
Markdown
42 lines
1.9 KiB
Markdown
<p align="center">
|
|
<img src="https://cdn.upload.systems/uploads/v40uV9K1.png" alt="Boyfriend logo" width="75%"/>
|
|
</p>
|
|
|
|
![GitHub License](https://img.shields.io/github/license/TeamOctolings/Boyfriend)
|
|
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/TeamOctolings/Boyfriend/.github/workflows/resharper.yml?branch=master)
|
|
![GitHub last commit](https://img.shields.io/github/last-commit/TeamOctolings/Boyfriend)
|
|
![CodeFactor](https://img.shields.io/codefactor/grade/github/TeamOctolings/Boyfriend)
|
|
|
|
Beep! I'm a general-purpose bot for moderation written by [@Octol1ttle](https://github.com/Octol1ttle) in C# and
|
|
Remora.Discord
|
|
|
|
## Features
|
|
|
|
* Banning, muting, kicking, etc.
|
|
* Reminding you about something if you wish
|
|
* Reminding everyone about that new event you made
|
|
* Log everything from joining the server to deleting messages
|
|
|
|
*...and more!*
|
|
|
|
## Installing and running Boyfriend
|
|
|
|
You can read our [wiki](https://github.com/TeamOctolings/Boyfriend/wiki) in order to assemble your Boyfriend™ and
|
|
moderate the server.
|
|
|
|
## Contributing
|
|
|
|
When it comes to contributing to the project, the two main things you can do to help out are reporting issues and
|
|
submitting pull requests. Please refer to the [contributing guidelines](CONTRIBUTING.md) to understand how to help in
|
|
the most effective way possible.
|
|
|
|
## Special Thanks
|
|
|
|
![JetBrains Logo (Main) logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)
|
|
|
|
[JetBrains](https://www.jetbrains.com/), creators of [ReSharper](https://www.jetbrains.com/resharper)
|
|
and [Rider](https://www.jetbrains.com/rider), supports Boyfriend with one of
|
|
their [Open Source Licenses](https://jb.gg/OpenSourceSupport).
|
|
Rider is the recommended IDE when working with Boyfriend, and everyone on the Boyfriend team uses it.
|
|
Additionally, ReSharper command-line tools made by JetBrains are used for status checks on pull requests to ensure code
|
|
quality even when not using ReSharper or Rider.
|