Skip to content

πŸ±β€πŸ Your personal assistant, reimagined | A text and voice assistant with useful moderation tools for large Discord servers and privacy options

Branch: master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Amy

Build Status PRs Welcome HitCount Latest Release MIT License

Amy


πŸ±β€πŸ Amy is your personal assisstant, reimagined. In other words, Amy is a Discord bot for the Dudes of 708 Discord server. You can also visit our YouTube homepage to see the kind of content that is relevant to the usage of Amy. To see the full docs, click here.

Amy builds upon over a decade of experience in social interactions at scale using various messaging platforms, with the current platform of choice being Discord as the community comes together to build best-in-class ideas and practices for our own purposes.

Amy currently runs on Gideon Tong's Server Network and has been given her own private subdomain space. If you would like to get involved in helping to shape the evolution of not just Amy but also future smart personal assisstants, consider reading the contributor's guide to get started.


Features

  • Custom welcome, about, join, and help messages tailored to communities
  • Utility commands to find out user information
  • Moderation commands to help moderators manage a community and find out user details
    • Wipe recent channel history
    • Control and manage announcements
  • Easter eggs and collectible achievements to create friendly competition between memebers of a community
    • Intelligently respond to certain users
  • Calls members out when they delete a spicy message (like an image)
  • Randomly prank users of a Discord server
  • All values, variables, and settings are admin-configurable
  • Advanced permissions system with clear hierarchy and inhereitance
  • Multiple bot instances controlled via one dashboard
  • Automatic multi-process load balancing without dependencies

Amy is in active development, and if you have a feature request, simply fill out an issue and we will get to it as soon as possible.

Achievements

Achievements

Amy supports custom achievements, which you can add your own instance of the bot (if you're running a custom instance for a private server), and soon will support admin-configurable achievements as well as default achievements that can be enabled globally (across servers) as well as only within a server.

Getting Started

To get started, simply clone this repository to your hard drive. You'll need Node 12.x or another JS code interpreter. Assuming you have Node installed, simply type

npm install --production

and while Node grabs the dependencies for you, move the file in config/secrets-blank.json to config/secrets.json and replace token with your Discord API key. Then start the application with

npm start

Developers

If you're a developer and would like to get started, see the setup guide in the documentation /docs folder.

Support

If you need support, you can start with reference guides and Google searches.

That said, if you have questions, feel free to reach out to me if you have any questions.

Contributing

There are many ways you can contribute to the project, and we greatly appreicate all the work you want to put into helping me making Amy better! For example:

If you'd like to contribute directly to the code base, see the contributor's guide before getting started. But thank you so much if you'd like to contribute! Just submit a pull request, as I review pull requests thoroughly and would love to see what you can cook up. If you want to just submit an idea instead, feel free to submit an issue instead.

Feedback

If you have any feedback, feel free to take this opportunity to become a contributor and open an issue. Additionally, you can email the maintainer Gideon Tong at gideon@gideontong.com.

Maintainers

Amy is maintained by Gideon Tong, whom you can contact by email at gideon@gideontong.com if you have any private concerns, security disclosures, or would like professional support. If you feel that you have a security disclosure and would like an encrypted form of transport, you may reach out to me with the PGP key listed in the security page of this repository.

Special Thanks

Contributions and feedback from Amy Nguyen, Max Buydakov, Kevin Stubbings, Brian Lam, Leo Zhang, and Jesus Castillo have been implemented into this project.

Their contributions can be found in the contributor's graph, and range from finding typos in strings to creating feature request issues. Special thanks to Amy Nguyen for allowing her namesake to be the inspiration of this project.

Licensing

Amy is licensed under the MIT License and is copyrighted by Β© Gideon Tong 2019-2020. She depends on the Discord.js, node-qrcode, node-canvas, youtube-dl, and log4js Node packages, which are both licensed under the Apache-2.0 License.

About

πŸ±β€πŸ Your personal assistant, reimagined | A text and voice assistant with useful moderation tools for large Discord servers and privacy options

Topics

Resources

License

You can’t perform that action at this time.