Amusement Club 3.0 is under heavy rewrite work, this repo is not meant to be used for normal play until this notice is removed

Amusement Club is a global card collecting game for Discord with thousands of cute and fancy cards made by the bot's community. You can get started on any server by typing /claim cards in a bot channel.

Each claim will cost you more 🍅 tomatoes (in-game currency), using /daily will reset your claim cost and give you extra tomatoes.

• If you are new, get started here
• For setting up bot on your server check out this page
• If you are upgrading from previous version, check out this guide
• If you are self-hosting a version of this bot, please read Hosting

Invite the bot here. Get your bot issues resolved on the Amusement Cafe support server.

Contributing

After cloning this repository you can run the bot in development mode. Under test/ you can find sample data and a startup script. Please DO NOT commit any changes to those files.

• Copy test/config.dest.json and remove the .dest to test/config.json
• Open test/config.json with your preferred text editor and set your bot token and database url (if it is different on your system). By default, the bot will access cards from the Amusement Club CDN.
• Open Terminal or PowerShell and run npm i to install all dependencies.
• Run npm i -g nodemon.
• Run npm start to start the bot. Every time you run the bot directly (without using Ayano) it will run in development mode.

Test out your features and when you are ready make a Pull Request into the feature branch (e.g. cinnabar).

Hosting

Before starting, please do all starting steps from contributing stage.

Make sure you are not violating anything in the LICENSE when you are hosting. You must mention that parts of your bot are licensed under MPL-2.0 on the help/info page of your bot like this:

Parts of the project are licensed under the MPL-2.0 and can be obtained here: https://github.com/Amusement-Cafe/amusementclub3.0/

To host your bot on a small amount of servers, you can just run bot in development mode. However, if you need sharding, vote webhooks, and card management support, consider using Ayano.