Pig (card game)

Pig is a simple, collecting card game of 20th century American origin suitable for three to thirteen players that is played with a 52-card French-suited pack.

Forked from this commit of pig-dice-game (I entered the wrong commit message).

Development

1. npm install
2. docker-compose up -d - For local redis environment
3. npm start
4. Navigate to one of the following:
   • http://localhost:3232/test.html
   • http://localhost:3232/test-ws.html

Forking (on different GitHub account)

1. Click the fork button

Forking (on same or different GitHub account)

1. Create new empty repository on GitHub (or whatever)
2. git clone https://github.com/nick-ng/pig-card-game.git <new-repo> && cd <new-repo>
3. Change pig-card-game to whatever you want and change my name to your name or something.
4. git add . && git commit -m "anything. this will get squashed in the next step"
5. git reset $(git commit-tree HEAD^{tree} -m "forked https://github.com/nick-ng/pig-card-game")
6. git remote remove origin
7. git remote add origin <url-of-repo-you-made>
8. git push --set-upstream origin main
9. Change branch permissions etc.

Deploying to Heroku

1. Create an empty Heroku App. Note the app's name
2. Get your Heroku API key from https://dashboard.heroku.com/account
3. On GitHub repo for your fork, go to the Settings and click on Secrets > Actions
4. Add 3 new repository secrets
   • HEROKU_API_KEY: API key from above
   • HEROKU_APP_NAME: App name from above
   • HEROKU_EMAIL: Email address of your Heroku account
5. Push a commit to the main branch.

ToDos

Check this GitHub Project for details.

Notes

Game State

On the server

{
  "id": "1234-12345-12345-1234",
  "host": "player-1's-uuid",
  "maxPlayers": 26,
  "players": [
    { "id": "player-1's-uuid", "name": "Alice" },
    { "id": "player-2's-uuid", "name": "Bob" },
    { "id": "player-3's-uuid", "name": "Charlie" }
  ],
  "gameSettings": {
    "cardsPerPlayer": 4
  },
  "gameSecrets": {
    "player-1's-uuid": {
      "password": "asdf",
      "chosenCard": "",
      "cardsInHand": [
        "card-1's-uuid",
        "card-4's-uuid",
        "card-8's-uuid",
        "card-12's-uuid"
      ]
    },
    "player-2's-uuid": {
      "password": "bsdf",
      "chosenCard": "card-2's-uuid",
      "cardsInHand": [
        "card-2's-uuid",
        "card-3's-uuid",
        "card-7's-uuid",
        "card-11's-uuid"
      ]
    }
  },
  "gameSecrets": {
    "fullDeck": ["card-1's-uuid", "card-2's-uuid"]
  },
  "gameState": {
    "state": "main",
    "seatOrder": ["player-1's-uuid", "player-3's-uuid", "player-2's-uuid"],
    "chosenCardPlayers": ["player-2's-uuid"],
    "cardMap": {
      "card-1's-uuid": "A",
      "card-5's-uuid": "B",
      "card-9's-uuid": "C"
    }
  },
  "lastActionId": "0-0"
}

Sent to Alice

{
  "id": "1234-12345-12345-1234",
  "host": "player-1's-uuid",
  "maxPlayers": 26,
  "players": [
    { "id": "player-1's-uuid", "name": "Alice" },
    { "id": "player-2's-uuid", "name": "Bob" },
    { "id": "player-3's-uuid", "name": "Charlie" }
  ],
  "gameSettings": {
    "cardsPerPlayer": 4
  },
  "yourSecrets": {
    "password": "asdf",
    "chosenCard": "",
    "cardsInHand": [
      "card-1's-uuid",
      "card-4's-uuid",
      "card-8's-uuid",
      "card-12's-uuid"
    ]
  },
  "gameState": {
    "state": "main",
    "seatOrder": ["player-1's-uuid", "player-3's-uuid", "player-2's-uuid"],
    "chosenCardPlayers": ["player-2's-uuid"],
    "cardMap": {
      "card-1's-uuid": "A",
      "card-5's-uuid": "B",
      "card-9's-uuid": "C"
    }
  }
}

WebSocket API

If you get disconnected, you need to reconnect and re-listen to the game. You'll still be in the game so you don't need to rejoin it.