Skip to content

An open-source Discord bot built for the Fiveable community.

License

Notifications You must be signed in to change notification settings

thinkfiveable/maya

Repository files navigation


Banner

An open-source Discord bot built for the Fiveable community.
Report Bug · Request Feature · Send a Pull Request

📝 About The Project

Maya is a multi-purpose, community-driven, single-guild Discord bot built for the Fiveable student community. It was built with functionality and customizability in mind, offering featurful moderation commands, utilities, reaction roles, and channel linking.

Features

  • Moderation and server management commands.
  • Reaction roles and role management.
  • Link voice channels to other voice/text channels.

👋 Getting Started

For complete setup and usage instructions, see the project wiki.

Local Installation

  1. Clone the repo.
https://github.com/thinkfiveable/maya.git
cd maya
  1. Install dependencies.
npm install
  1. Remove -example from .env-example and replace variables.
TOKEN=DISCORD BOT TOKEN
OWNER_ID=USER ID OF THE OWNER
MONGO_URI=URI TO YOUR MONGO DATABASE
  1. Start using ts-node and Nodemon.
npm run start

Resources

Contributing

See the contribution guide if you're interested in contributing to Maya.

⚖️ License

MIT License

Copyright (c) 2021 Connor Snow

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.