stephanmg / Solitaire

Implementation and solution of 2d/3d Peg solitaire in Kotlin with the Javalin React web UI and JavaFX/TorandoFX

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Peg solitaire

First of all, this is an explorative respectively recreational programming project to gain more experience with Kotlin. You can just go ahead and download the compiled executable and deployed to Bintray to start playing the classic Peg solitaire game. For the interested reader, see the introduction below and the upcoming features requested by users.

Introduction

Peg Solitaire is a well-known single-player board game involving moving pegs between holes in the board. It is said to date back as far as to August 1687 and that Louis XIV or known as Louis the Great was a passionate player. Some sets use sophisticated marble or glass boards for pegs and indentations, others use wooden or plastic boards. In the UK or India it is also known under the synonyms Solitaire or Brainvita. As for the game play a valid move a peg needs to jump orthogonally over an adjacent peg into a hole two positions away which will remove the jumped peg. Depending on the board size and configuration multiple solutions, i.e. sequences of moves, may exist or not, and has attracted many recreational mathematicians and hobbyist around the world, see also game play and board configurations on wikipedia and for a mathematical treatment of the game compare the website on recmath which contains a great deal of monographs and books.

Now using Kotlin and JavaFX/TorandoFX a 2D peg solitaire has been implemented, see code below and compiled binaries on Bintray (fat jar). For upcoming features, see the list below and feel free to open an Issue for additional features.

Solutions are calculated by a level-based DFS which indicate to the user if a solution can still be reached or the game is lost. The user can undo moves and redo moves and save and load the game state. Two boards are available, the classic 33-hole board also known as English board and a 9 by 9 square board. Feel free to feature request another type of board.


Codacy Badge Known Vulnerabilities Build Status Documentation Status Download KDoc

Game view and features

  • Save and load dialog of game state
  • Board selection
  • Undo / redo operations
  • Status bar indicating if game still can be won
  • Number of moves

Howto play the game

Download the game (Solitaire-bundled.jar) from here. The game should execute after double-click on the Solitaire-bundled.jar file you downloaded to your computer as long as you have a Java runtime environment (JRE 7 or later) installed on your computer.

Features requests (Ordered by increasing priority/popularity by players)

  • Serialize history of commands to allow for a replay of a game
  • Adapt 2D solitaire to a 3D game (Add as option)
  • Add more 2D boards
  • Support multiple game states to be saved and loaded in the GUI
  • Improve GUI aesthetics and exchange JavaFX with TornadoFX
  • Add a Javalin webinterface to play the game and deploy as SaaS

Useful links

About

Implementation and solution of 2d/3d Peg solitaire in Kotlin with the Javalin React web UI and JavaFX/TorandoFX

License:GNU General Public License v3.0


Languages

Language:Kotlin 99.0%Language:Shell 1.0%