Flipping Game

Overview

The TestJFX project is a JavaFX application designed to demonstrate a simple user interface with JavaFX. It includes a welcome pane that users first see upon launching the application.

Prerequisites

• Java 11 or higher
• Maven

Technologies Used

• Java
• JavaFX for the GUI
• SQL for database interactions (Note: Specific database setup instructions are not included as this project focuses on the JavaFX interface)
• Maven for dependency management

Setup and Installation

1. Ensure Java 11 or higher is installed on your system.
2. Clone the repository to your local machine.
3. Navigate to the project directory and run mvn clean install to build the project.
4. To start the application, run mvn javafx:run.

Github Actions

• Now able to package into executable file in multi platform.

Features

• Offline Player vs Player.
• Player vs AI.
• Database.
• Customize board size.
• Play with friends (Online Peer-to-Peer / LAN).
• In-game real-time chat.

Project Structure

• src/main/java/com/khanhdew/flipping/Main.java: Entry point of the application that sets up the primary stage.
• src/main/java/com/khanhdew/flipping/view/WelcomePaneController.java: Controller for the welcome pane.
• src/main/resources/assets/css/style.css: CSS file for styling the application.
• src/main/resources/assets/img/icon.png: Icon for the application.
• src/main/resources/com/khanhdew/flipping/welcomepane.fxml: FXML file defining the layout of the welcome pane.

Contributing

Contributions are welcome. Please open an issue to discuss your ideas before making a pull request.

License

This project is open source and available under the GNU License.

Sponsor