Skip to content
This repository has been archived by the owner on Aug 1, 2020. It is now read-only.

Latest commit

 

History

History
31 lines (29 loc) · 2.97 KB

README.md

File metadata and controls

31 lines (29 loc) · 2.97 KB

Gitlab pipeline status Discord

Energize

Discord Bots Discord Bots Discord Bots Discord Bots

Energize⚡ is a robust music / administration / social bot featuring well-crafted music search (Youtube, SoundCloud, Twitch, Stream urls), user friendly, it proposes a set of useful commands.

Structure

Almost everything in Energize is a service, services are implemented under the Energize project under Services. Because the command service is in F# it has its own project (Energize.Commands), and because it needed to interface with other projects Energize.Interfaces was born, it contains interfaces for services. Finally Energize.Essentials contains essential classes used in the other projects; see it as a toolbox.

Where are the commands ?

You can find them here.

Why use F#?

F# works using modules and is rather powerful when coming to computations that do not require having lots of different structures which made it perfect in some of the parts of Energize, essentially the command implementation.

I need help!

If you are lost in how to use Energize, or how to make it work, feel free to open an issue with the tag [ HELP ]. You can also add me (Earu Arcana#9037) or use the feedback and/or bug commands on Discord.

Contributing

If you are willing to contribute to Energize, here are a few things that needs to be done to stay consistent with the rest of the code:

  • C# projects have: local variables in camelCase, methods, properties and fields in PascalCase.
  • F# projects have: methods available for the whole solution in PascalCase, the rest is camelCased.
  • If you create a new service do not create interfaces in Energize.Interfaces unless they are used in other projects.
  • The bot purpose is focused on the music, administration and social areas, try to keep this in mind if you want to add new commands.
  • Try to use the interfaces proposed by Discord.NET and other packages as much as possible in your method signatures.