Skip to content

Latest commit

 

History

History
228 lines (156 loc) · 6.48 KB

README.md

File metadata and controls

228 lines (156 loc) · 6.48 KB

Royal Game of Ur

Royal Game of Ur Console

Introduction

The Royal Game of Ur is one of the oldest known board games, dating back to around 2600 BCE. This project implements a digital version of the game.

Features

  • Implements the Irving Finkel ruleset
  • Command-line interface
  • State machine design for game logic
  • Configurable AI strategies
  • Simulation mode for running multiple games with different strategies
  • Cross-platform compatibility (Clojure and ClojureScript)
  • Docker support for easy deployment and cross-platform compatibility

Board Layout

The game board consists of 20 squares arranged in a specific pattern. The following image shows the board layout and how the squares are numbered:

Board Layout

Game State Machine

The game logic follows a finite state machine design. The following diagram illustrates the different states and transitions in the game:

Game State Machine

AI Strategies

This project implements several AI strategies for playing the Royal Game of Ur:

  1. Minimax: Looks ahead several moves, considering both its own opportunities and the opponent's potential responses.
  2. Monte Carlo Tree Search (MCTS): A probabilistic algorithm that balances exploration and exploitation to find optimal moves. (in development)
  3. Random: Chooses moves randomly.
  4. First-in-list: Always chooses the first available move.
  5. Strategic: Uses a simple heuristic to prioritize moves.

For detailed explanations of how these algorithms work, please refer to the documentation:

Technologies Used

This project utilizes a variety of technologies and tools:

  • Clojure: A dynamic, functional programming language for the JVM
  • ClojureScript: A compiler for Clojure that targets JavaScript
  • nbb: A scripting environment for ClojureScript
  • Malli: A data-driven schema library for Clojure(Script)
  • core.async: A Clojure(Script) library for asynchronous programming
  • just: A command runner for various development tasks
  • asdf: A version manager for multiple runtime versions
  • yarn: A package manager for JavaScript
  • GraalVM: A high-performance JDK distribution
  • Graphviz: An open-source graph visualization software
  • Docker: A platform for developing, shipping, and running applications in containers

Getting Started

Prerequisites

This project was developed on a Mac (M1). Users on different operating systems may need to adapt these instructions to their environment.

At present, the native build targets ARM64 only.

Installation

  1. Install Homebrew (if not already installed):

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

    Follow the terminal instructions to add Homebrew to your PATH.

  2. Install Git:

    brew install git

  3. Clone the repository:

    git clone https://github.com/yourusername/royal-game-of-ur.git
cd royal-game-of-ur

  4. Make the setup script executable:

    chmod +x scripts/setup.sh

  5. Run the setup script:

    ./scripts/setup.sh

    This script will install the remaining dependencies (Docker, Just, asdf).

  6. Initialize the project:

    just init

    This command will set up the development environment and install project dependencies.

Development

This project uses just as a command runner. To see all available commands, run:

just

Key commands include:

  • just nbb: Run the CLI application (using nbb)
  • just clj: Run the CLI application (using Clojure)
  • just test: Run unit tests (using nbb)
  • just test-clj: Run unit tests (using Clojure)
  • just watch: Run unit tests and watch for changes (using nbb)
  • just fmt: Format Clojure files
  • just build: Build the project (creates uberjar and native image)
  • just repl: Start a Clojure REPL

To update all tools:

just update-tools

Usage

Running the Game

To start a new game:

just nbb

This will launch the game in your terminal. Follow the on-screen instructions to play.

Running Simulations

To run a simulation of multiple games with different strategies:

just nbb sim [parameters]

or for the Clojure version:

just clj sim [parameters]

Available parameters:

  • num-games: Number of games to simulate
  • strategy-A: Strategy for Player A
  • strategy-B: Strategy for Player B
  • debug: Enable debug mode (true/false)
  • show: Show game state (true/false)
  • parallel: Number of parallel threads to use
  • validate: Enable validation of the board after each move (true/false)

Strategy-specific parameters can be set using the format strategy-X-param=value, where X is A or B, and param is the parameter name.

Example:

just nbb sim num-games=100 strategy-A=minimax strategy-A-depth=3 strategy-B=first-in-list debug=false show=false parallel=6 validate=false

This will run 100 games with the minimax strategy (depth 3) for Player A against the 'first in list' strategy for Player B, using 6 parallel threads.

For more detailed information about available strategies and their parameters, please refer to the Strategies Documentation.

Docker Usage

To build and run the game using Docker:

just docker-build-run [parameters]

This command will build the Docker image and run the game or simulation with the specified parameters.

Example:

just docker-build-run sim num-games=100 strategy-A=minimax strategy-A-depth=3 strategy-B=first-in-list

Testing

To run the test suite:

just test-clj

For continuous testing during development (using nbb):

just watch

Building

To build the project (create uberjar and native ARM64 image):

just build

Run the built game:

./royal-game-of-ur

Contributing

This is just a personal project for learning and fun. If you want to submit a pull request, I might look at it someday. Feel free to fork the repository or use any ideas from it in your own projects.

License

This project is open source and available under the MIT License.