Ethan Lane
a3248e978a
# Description Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. #380 ## Type of change Please delete options that are not relevant. - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update # How Has This Been Tested? Please describe the tests that you ran to verify the changes. Provide instructions so we can reproduce. Please also list any relevant details to your test configuration. # Checklist - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that provde my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules Reviewed-on: #419 Reviewed-by: VylpesTester <tester@vylpes.com> Co-authored-by: Ethan Lane <ethan@vylpes.com> Co-committed-by: Ethan Lane <ethan@vylpes.com> |
||
|---|---|---|
| .forgejo/workflows | ||
| .gitea | ||
| database | ||
| docs | ||
| scripts | ||
| src | ||
| tests | ||
| .drone.yml | ||
| .env.example | ||
| .gitignore | ||
| .woodpecker.yml | ||
| docker-compose.yml | ||
| eslint.config.mjs | ||
| jest.config.json | ||
| jest.setup.js | ||
| package.json | ||
| README.md | ||
| renovate.json | ||
| tsconfig.json | ||
| yarn.lock | ||
Card Drop
Card Drop is a Discord Bot designed to allow users to "drop" random cards into a channel and have the ability to claim them for themselves or let others if they so choose.
The cards are randomly chosen based on weights of their card type (i.e. Bronze is more common than Gold). The user who ran the drop command has 5 minutes to choose if they want the card to themselves before its claimable by anyone, or until the drop command is ran again.
Installation
Downloads of the latest version can be found from the GitHub Releases or Forgejo Releases page.
Copy the config template file and fill in the strings.
Requirements
- NodeJS
- Yarn
- Docker
Usage
Install the dependencies and build the app:
yarn Install
yarn build
Setup the database (Recommended to use the docker-compose file
docker compose up -d
Copy and edit the settings file
cp .env.template .env
NOTE: Make sure you do not check in these files! These contain sensitive information and should be treated as private.
If you're not using DB_SYNC=true in .env, make sure to migrate the database
yarn db:up
Start the bot
yarn start