Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 1.77 KB

README.md

File metadata and controls

44 lines (35 loc) · 1.77 KB

Exploding Kittens

This is a pet project, implementing the popular game Exploding Kittens in OCaml.

This project uses Core and Async heavily and is created to practice the Rpc library.

Running the project

Installation

  1. Ensure you have opam and it is initialised.
  2. Clone this repository with git clone and cd into it.
  3. Install all dependencies with opam install --deps-only ..
    • Alternatively, opam install all dependencies manually as stated in the depends section of exploding_kittens.opam, including ocaml and dune.
  4. Run dune build to build the project to check that it is successful.

Player Command

This command represents the endpoint for a player and interacts with the game by providing input.

  1. Have a process run dune exec -- ./bin/player.exe -port YOUR_PORT_HERE -name YOUR_NAME_HERE, taking note of the host and port that it is running on. A good choice of a port is 8000, 8001, etc.
  2. Repeat the above step as many times for other players.

Server Command

This command starts the game and is the brain of the game.

  1. Start the server by running a process with dune exec -- ./bin/server.exe -player HOST:PORT_1 -player HOST:PORT_2, replacing the host and port accordingly to the players.

How to play

Watch the official tutorial video on YouTube for the basics of the game.

Alternatively, read the official PDF explaining the rules.

Note: Only Nope and Quint is currently unimplemented from the above PDF.