Skip to content

Latest commit

 

History

History
116 lines (76 loc) · 3.33 KB

README.md

File metadata and controls

116 lines (76 loc) · 3.33 KB
Raw

duel-masters

duel-masters is a multiplayer simulator for the Duel Masters Trading Card Game for play in the browser.

It aims to simulate how you would be playing the card game in real life, but with enforced rules and automations for the effects of each individual card.

Run with docker

# Login to the github package registry
docker login ghcr.io

# Run the container
docker run -d \
    --name duel-masters \
    --restart unless-stopped \
    -p 80:80 \
    -e port=80 \
    -e mongo_name=<mongodb_name> \
    -e mongo_uri=<mongodb_connection_string> \
    ghcr.io/sindreslungaard/duel-masters/production:latest

Setting up for development

Run the server, webapp and db locally (recommended)

  1. Fork the duel-masters repo on GitHub.
  2. Clone your fork locally:
git clone https://github.com/sindreslungaard/duel-masters.git
  1. Set up MongoDB locally or use a cloud provider.
  2. Create a .env file based on the .env.default file in the repository. Example:
port=80
mongo_uri=mongodb://127.0.0.1:27017
mongo_name='duel-masters'
restart_after=

  1. Navigate to the webapp directory and run npm install. Then run either npm run build or npm run watch to build or watch the files.

  2. Run the application. If you're using Vscode simply hit F5 or Run -> Start Debugging. To run manually use go run cmd/duel-masters/main.go. Note that debugging with vscode will automatically pick up environment variables from the .env file. If you're not using vscode's debug mode or if you use a different editor you will have to set up the environment variables yourself.

  3. Go to http://localhost and create a user as well as a deck. To set the deck as a standard deck, find it in MongoDB and change the standard field to true.



Run only the webapp locally

  1. git clone https://github.com/sindreslungaard/duel-masters.git

  2. Navigate to the webapp directory and run npm install and npm run serve

  3. Override your host config

localStorage.setItem(
    "config",
    JSON.stringify({
        host: "shobu.io",
        ws_protocol: "wss://",
        api: "https://shobu.io/api"
    })
)



Run the server, webapp and db locally with docker compose

  1. Fork the duel-masters repo on GitHub.
  2. Clone your fork locally:
git clone https://github.com/sindreslungaard/duel-masters.git
  1. go into your cloned directory
  2. Start the containers via:
docker compose up --build
  1. Go to http://localhost:9080 and create a user and a deck



Development tips

For testing cards locally there is a neat chat command that spawns in any card to the hand of the persons turn it is even if it's not in your deck /add {cardUid} (e.g /add 4459f97b-8927-4231-a11d-f4f88175b71c). The card uid can be found in repository.go.

To add all cards from your hand to the mana zone, use /mana

To get access to the command you need to add the role admin to the permissions array on your user in the database.

Changelog

A changelog starting from 11/11/2021 can be found here