Snakes & Ladders - Simulator

A program for simulate Snakes & Ladders matches
Explore the docs »

View Demo · Report Bug · Request Feature . Discussions

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A program for simulate Snakes & Ladders matches with different layer of customization like custom board, different rules and many more.

(back to top)

Built With

(back to top)

Getting Started

For compiling the project you just need to run the Gradle task: build and than extract the file form the app.zip file in the folder app/build/distributions, or just run the Gradle task: run for executing the application directly.

Prerequisites

• Java 17+ (Developed in Java 21)
• JavaFX 21 (Gradle dependency)
• Jackson 2.17.2 (Gradle dependency)
• Logback 1.5.6 (Gradle dependency)
• Lombok 1.18.34 (Gradle dependency)

Installation

1. Use the .jar file from the build

(back to top)

Usage

For running the program run the following command in the repository folder:

• Powershell: .\gradlew run
• Linux: gradlew run

(back to top)

Roadmap

• Main menu (NFR)
• New simulation menu
  • Save settings (FR)
  • Load settings (FR)
    • Multithread (NFR)
• Simulation
  • Main simulation windows (FR)
  • Manual advancement (FR)
  • Automatic advancement (FR)
    • Simulation speed (NFR)
  • Game board (FR)
    • Custom board dimensions (FR)
    • Board cell settings (FR)
    • Snakes & Ladders cell (FR)
    • Special cell type (FR)
      • "Parking" cell (Bench or Inn) (FR)
      • "Price" cell (Dice or Spring) (FR)
      • "Draw a Card" cell (FR)
  • Players (FR)
  • Dice (FR)
    • Dice number (NFR)
    • Dice type (NFR)
    • Sigle dice rule (FR)
    • Doble six rule (FR)
  • Deck of cards (FR)
    • Standard cards (Bench, Inn, Dice and Spring) (FR)
    • Extra cards (Do Not Stop) (FR)
  • End of simulation results (FR)
    • Report log (NFR)
• DEBUG
  • Logger
    • Setup logger settings
  • Test

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this project better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License License. See LICENSE for more information.

(back to top)

Contact

S. Scarcelli - xblayz.github@protonmail.com.com

Project Link: https://github.com/XBlayz/Snakes_n_Ladders_sim

(back to top)

Acknowledgments

• Prof. A. Furfaro - (UNICAL, Professore corso Ing. del Software)
• Prof. F. Blefari - (UNICAL, Esercitatore corso Ing. del Software)
• Bro Code - (JavaFX tutorial)
• Tom Gregory Tech - (Gradle tutorial)
• Icons made by Reion from Flaticon.com

(back to top)