Ludo Game

Overview

A classic Ludo board game implementation. This version of the popular strategy board game allows 1-4 players to race their tokens from start to finish according to dice rolls.

Features

• Classic Ludo gameplay with 1-4 players
• Beautiful UI
• Single-player mode with AI opponents
• Online multiplayer support for playing with friends
• Customizable player tokens and colors

Getting Started

Download

To play the latest version of Ludo Game, download it from the GitHub releases from GitHub Releases

Installation

1. Download the latest release build zip for your operating system (Currently supports Windows)
2. Extract files from the downloaded zip
3. Run the executable file (Ludo.exe for Windows)

Development Setup

Prerequisites

• Unity 2022.3.56f1
• Visual Studio 2022, VS Code or JetBrains Rider
• Git

Setup Steps

1. Clone the repository

   git clone https://github.com/Artorias17/Ludo.git

2. The project uses Git LFS to store assets. Setup Git LFS

   git lfs install

3. Download the server from the Ludo-Server repository and follow the instruction for setting that up:

   git clone https://github.com/Artorias17/Ludo-Server.git

4. In the Unity project:

   • Copy Assets/_Game/Scripts/Utilities/ServerInfoTemplate.cs to Assets/_Game/Scripts/Utilities/ServerInfo.cs

   • Modify ServerInfo.cs by updating the following:

     • ServerInfoTemplate class name to ServerInfo
     • ServerAddress with your server URL
     • ApiKey with the Api key from appsettings.json in the server project

5. Open the project in Unity Hub by selecting the project folder

6. Restore NuGet packages by navigating to the top menu bar:

   NuGet > Restore Packages
   

7. Build and run the project from Unity Editor using the Play button

Git Configuration

Unity Smart Merge Tool

Configure Git to use Unity's smart merge tool for resolving YAML conflicts by updating .git/config file:

[merge]
tool = unityyamlmerge
[mergetool "unityyamlmerge"]
trustExitCode = false
cmd = '<path to UnityYAMLMerge>' merge -p "$BASE" "$REMOTE" "$LOCAL" "$MERGED"

Replace <path to UnityYAMLMerge> with the actual path to the UnityYAMLMerge tool on your system. The path varies by platform and should typically be at:

• Windows: C:/Program Files/Unity/Hub/Editor/2022.3.56f1/Editor/Data/Tools/UnityYAMLMerge.exe
• macOS: /Applications/Unity/Hub/Editor/2022.3.56f1/Unity.app/Contents/Tools/UnityYAMLMerge
• Linux: ~/Unity/Hub/Editor/2022.3.56f1/Editor/Data/Tools/UnityYAMLMerge

Contributors

Name	Id	Roles
Abhishek Roy	2410320	- Game Design - Project Setup - Main-Menu UI Design and Development - Multiplayer Feature Development - Backend Development and Deployment
Isuri Kariyawasam	2406867	- Game Design - Documentation - Settings Panel UI Design and Development - Testing
Hoang Long Nguyen	2406864	- Lead Game Design - Game Assets Procurement - Core Gameplay Design and Development - Core Gameplay Animation Implementation - Gameplay UI Design and Development - Sound Implementation
Moinul Laskar	2413772	- Game Design - Documentation - Offline Gameplay Feature Development - Debugging

Issue Tracking

Please report bugs and request features using the GitHub issue tracker.

Acknowledgments

• Inspired by the traditional Ludo board game
• Developed as a project for the DTEK2090-3001 Modern User Interfaces course