SudokuFX

Contents

• Description
• Build with
• Project
  • Roadmap
  • Mockup
  • Required Application Properties to Run
  • Windows how to run in IntelliJ IDEA
• Installation
• Security
• Use
• Examples
• Update
• Uninstallation
• Documentation
• Contributors
• Feedback
• Licence

Description

SudokuFX is a Sudoku game, allowing you to create several player profiles and save and restore their games. The application allows you to solve the current Sudoku grid, but also other entries manually.

Build with

• Java LTS (e.g. 21)
• JavaFX LTS (e.g. 21)
• WiX Toolset v3.11
• Dependencies :
  • Development
    • javafx-controls
    • javafx-fxml
  • DTOs
    • MapStruct
  • SGBDR & SPRING BOOT
    • HSQLDB
    • Spring boot
      • Starter
      • Gluon Ignite with Spring
      • Starter data JPA
      • Starter validation
    • flyway (database migration)
    • passay (generate and validate secrets)
  • Logs
    • logback from Spring Boot
  • Build dependencies :
    • maven-compiler-plugin
      • annotationProcessorPaths:
        • MapStruct processor (for code generation)
        • Lombok (for generating boilerplate code)
        • Lombok MapStruct Binding (to integrate Lombok with MapStruct)
    • javafx-maven-plugin
    • spring-boot-maven-plugin (create the uber JAR)
    • exec-maven-plugin (for scripts generating the packages)
  • Test dependencies :
    • spring boot starter test (JUnit, Mockito, Hamcrest)
    • surefire
    • jacoco
    • testfx-junit5 (ex. : FxRobot to execute actions within the UI, or custom Hamcrest matchers org.testfx.matcher.*.)
    • System Stubs for isolating tests that redefine system properties (see Required Application Properties to Run)

Project

Roadmap

• The project roadmap

Mockup

• The app mockup (Figma)

Important

Required Application Properties to Run

For the application to work properly, the following application properties must be set at the JVM level:

• app.name: This property specifies the name of the application.
• app.version: This property specifies the version of the application.
  • This SemVer-like format is only numeric MAJOR.MINOR.PATCH (e.g., 1.0.0, 2.1.3).

Windows how to run in IntelliJ IDEA

• Download and install the version LTS (e.g. 21) of the JDK Adoptium Temurin JDK
• Download and install WiX Toolset v3.11 (in order to package the application)
  • Activate .NET framework 3.5.1 (Control Panel > Programs > Programs and Features > Turn Windows features on or off)
  • Launch wix311.exe
• Configured the necessary environment variables
  • JDK
    • name : JAVA_HOME
    • value LTS (e.g. 21) : C:\Program Files\Eclipse Adoptium\jdk-21.0.3.9-hotspot
  • WiX
    • name : WIX
    • value : C:\Program Files (x86)\WiX Toolset v3.11\
• IntelliJ IDEA
  • Clone the repository
  • Select the project's JDK
    • File > Project Structure > SDK > Add SDK from disk (select the JDK)
  • Run the app at top right corner (SudoMain.java is the main class)
    • Run / Debug Configurations > Edit Configurations...

      • Run (in order to run the application)

        • Add New Configuration > Maven > Run: clean javafx:run > Apply

        

        • Run SudokuFX [clean,javafx:run]

      • Run with details (optional)

        • Add New Configuration > Maven > Run: clean -X javafx:run -Dprism.verbose=true -f pom.xml > Apply
        • Run SudokuFX [run details]

      • Run that generate documentation with Doxygen

        • Install Doxygen and GraphViz (Doxygen must be added to the system PATH).
        • Add New Configuration > Maven > Run: clean -X javafx:run prepare-package -P generate-docs -f pom.xml > Apply
        • Run SudokuFX [prepare-package]

Installation

• Windows

  • Application without Java Runtime Environment included (the latest JRE must be installed on your machine)

    Download, unzip, and keep all the files together (SudokuFX-v.v.v.bat to launch), from the latest Windows version of the file SudokuFX-v.v.v_windows.zip, available in Assets.

  • Application with Java Runtime Environment included (latest distribution with x64 architecture)

    Download and install the latest Windows version of the file SudokuFX_JVM-v.v.v.msi, available in Assets.

    The MSI file does not have a code signing certificate (paid service), Microsoft Defender SmartScreen informs you of this during installation; to continue the installation click on additional information, then Run anyway.

  _{This other software may be useful to you to check the integrity of the downloaded file (see the version fingerprints).}

• Linux

  • Application without Java Runtime Environment included (the latest JRE must be installed on your machine)

    Download, untar, and keep all the files together (SudokuFX-v.v.v.sh to launch), from the latest Linux version of the file SudokuFX-v.v.v_linux.tar.gz, available in Assets.

  • Application with Java Runtime Environment included (Debian-based distribution with AMD64 architecture)

    Download and install the latest Linux version of the file sudokufx-jvm_v.v.v_amd64.deb, available in Assets.

sudo apt install ./sudokufx-jvm_v.v.v_amd64.deb

• MacOS

  • Arm64 package by default and x86_64 is specified if needed

  • Application without Java Runtime Environment included (the latest JRE must be installed on your machine)

    Download, unzip, and keep all the files together (SudokuFX-v.v.v.sh to launch), from the latest MacOS version of the file SudokuFX-v.v.v_macos.zip, available in Assets.

  • Application with Java Runtime Environment included (latest distribution with ARM64 architecture)

    Download and install the latest MacOS version of the file SudokuFX-JVM-1.0.0.dmg, available in Assets.

Use

Examples

Update

• Windows

  • Application without Java Runtime Environment included (ZIP file with the .bat file and the JAR)
    • Delete your old unzipped folder from SudokuFX-v.v.v_windows.zip, and follow the installation instructions
  • Application with Java Runtime Environment included (from MSI file)
    • Follow the installation instructions

• Linux

  • Application without Java Runtime Environment included (TAR file with the .sh file and the JAR)
    • Delete your old untarred folder from SudokuFX-v.v.v_linux.tar.gz, and follow the installation instructions
  • Application with Java Runtime Environment included (from .deb file)
    • Follow the installation instructions

• MacOS

  • Arm64 package by default and x86_64 is specified if needed
  • Application without Java Runtime Environment included (ZIP file with the .sh file and the JAR)
    • Delete your old unzipped folder from SudokuFX-v.v.v_macos.zip, and follow the installation instructions
  • Application with Java Runtime Environment included (from .dmg file)
    • Follow the installation instructions

Uninstallation

• Windows
  • Application without Java Runtime Environment included (ZIP file with the .bat file and the JAR)
    • Delete your unzipped folder from SudokuFX-v.v.v_windows.zip
  • Application with Java Runtime Environment included (from MSI file)
    • Uninstall from the Control Panel (for programs)
      1. In the search box on the taskbar, type Control Panel and select it from the results.
      2. Select Programs > Programs and Features.
      3. Press and hold (or right-click) on the program you want to remove and select Uninstall or * Uninstall/Change*. Then follow the directions on the screen.
• Linux
  • Application without Java Runtime Environment included (TAR file with the .sh file and the JAR)
    • Delete your untarred folder from SudokuFX-v.v.v_linux.tar.gz
  • Application with Java Runtime Environment included (from .deb file)

sudo apt purge sudokufx-jvm

• MacOS
  • Arm64 package by default and x86_64 is specified if needed
  • Application without Java Runtime Environment included (ZIP file with the .sh file and the JAR)
    • Delete your unzipped folder from SudokuFX-v.v.v_macos.zip
  • Application with Java Runtime Environment included (from .dmg file)
    • Drag the application to the Trash

Important

• Windows

  • To completely delete your app data and logs, you need to manually delete this folder:

    C:/Users/<USERNAME>¹/AppData/Local/Soft64.fr/SudokuFX/.

• Linux

  • To completely delete your app data and logs, you need to manually delete this folder:

    /home/<USERNAME>¹/.local/share/Soft64.fr/SudokuFX.

• MacOS

  • To completely delete your app data and logs, you need to manually delete this folder:

    /Users/<USERNAME>¹/Library/Application Support/Soft64.fr/SudokuFX.

Contributors

Lob2018

Feedback

• File an issue
  • If you want you can attach the application logs you find :
    • Windows
      • Inside C:/Users/<USERNAME>¹/AppData/Local/Soft64.fr/SudokuFX/logs-sudokufx
    • Linux
      • Inside /home/<USERNAME>¹/.local/share/Soft64.fr/SudokuFX/logs-sudokufx
    • MacOS
      • Inside /Users/<USERNAME>¹/Library/Application Support/Soft64.fr/SudokuFX/logs-sudokufx

Footnotes

1. Replace <USERNAME> with your currently logged-in username. ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶