Skip to content

This project allows you to Generate, Save, Load and Solve some Sudoku Grids.

License

Notifications You must be signed in to change notification settings

AlexBolot/SudokuJava

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SudokuJava

Summary :

  1. About the project
    1. The goal
  2. Package tree organisation
    1. Controller
    2. Model
      1. Case
      2. Grille
    3. Service
      1. App
  3. Coming soon
  4. Libraries
  5. Author

1 - About the project

1.1 - The goal

This project allows you to Generate, Save, Load and Solve some Sudoku Grids.

2 - Package tree organisation

2.1 - Controller

In this package, as the name says it, you will find the java classes working as controller of the JavaFX views (.fxml). There is not much more to say about this package.

2.2 - Model

This package is where the objects and their managers are located.
The Class names are quite self-explanatory in my opinion, except for the ChallengeManager and the PlayerManager.
Their purpose is to handle a list of challenges/players and allow you to manipulate them more easily.
For example in the PlayerManager :

//... Other lines of code ...//

public static Player get (String name) {...}

public static Player getFirst () {...}

public static Player getPrevious (Player player) {...}

public static Player getNext (Player player) {...}

public static Player getRandom () {...}

//... Other lines of code ...//

2.3 - Service

2.3.1 - App

This class starts the JavaFX Application and calls the first GUI (ChallengeTypesView). It also creates the Players (for now, it will change in the next update).

2.3.2 - ChallengeCreator

This class creates all the challenges and adds them to the ChallengeManager if they match the list of selected challenge types.
Note : this class will be removed in the next update.

2.3.3 - Const

This class is composed only of public static fields.
The goal is to centralise most variables, to be able to change them only from here. It reduces typo mistakes and allows quick modifiaction (view size, view path, etc).

3 - Coming soon

Please check the TODO.md file in this repository to find out what updates are planned.

4 - Libraries

Only 3 libraries are used for this Maven QuickStart project

  • Java8 : JDK 1.8.111
  • Maven : JUnit 4.12
  • Maven : hamcrest-core:1.3

Note : those libraries are already included in : org.jetbrains.idea.maven.model.MavenArchetype@88f75e0f

5 - Author

Alexandre BOLOT
My GitHub
My LinkedIn

About

This project allows you to Generate, Save, Load and Solve some Sudoku Grids.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages