Skip to content

malouro/yggis-bot

Repository files navigation

Yggis

CircleCI codecov dependencies Status devDependencies Status styled with prettier license

Project initially generated by tosin

Feature List

Anyone installing or running Yggis should be able to do the following:

  • Run the Discord bot locally and with minimal initial configuration. (setup & run, that's it!)
  • Be able to configure the bot in a multitude of robust ways, for your own personal use & on your own server(s) of choice with (relative) ease.
  • Logging of all events
  • Commands!
    • LFG
    • StreamLink

... Granted, a number of these are a work in progress and probably not implemented or implemented fully yet. Check out the Yggis project board for more information on the progress & status of these features.

Requirements

  • Node.js 10 LTS
  • A Discord application/bot token
  • Yarn (if contributing or working locally)

What is Yggis?

A Discord bot utilizing the wonderful Discord.js. Yggis is the official "sequel" to Ggis. Built from the ground up to be more scalable, better structured and tested fully.

Contributing

Please read CONTRIBUTING.md for details on the code of conduct, and the process for submitting pull requests.

Versioning

Yggis uses SemVer for versioning.

Acknowledgment

Use this section for acknowledgments. Is your project based on other projects? Have you've been help by someone you want to mention?

License

This project is licensed under the MIT License - see the LICENSE file for details.