hackclub / bag

A Slack based RPG system!
https://bag.hackclub.com
8 stars 2 forks source link

Bag

A whole RPG system within the Hack Club Slack!

Setup

To run locally, make sure you have the following installed:

Once you have these, you'll need to git clone this repo, and then:

  1. yarn install && yarn run db:migrate-deploy
  2. Fill out .env.sample and rename it to .env.
  3. Add yourself to the the list of maintainers in maintainers.yaml.
  4. Run yarn dev!
  5. Add the bot to the #bag-approvals channel.
  6. Start playing with the Slack bot! The first thing you should do is run /bot and create an ADMIN app, then approve its request.
  7. Clone the rivques/bag-manifest repo (hopefully merged into mainline soon). Make a .env in the workflow directory and set APP_ID and APP_KEY from the bot you just made, and set BASE_URL to port 3000 of wherever your bag instance is running (probably http://localhost:3000).
  8. cd into the workflow directory and run npm i, then node update.js. This will pull all the items into your DB.
  9. You should now have a local copy of Bag, ready to play with!