MineparkOnline

Technology   |    Setup   |    Contribute   |    License

🔖 About

A JavaFX multiplayer implementation of the classic Minesweeper game with a South Park™ theme.

🚀 Technology

This project has been developed and tested with the following technologies:

• Java :: Oracle Java™ Language | OpenJDK JRE
• JavaFX :: JavaFX Framework | OpenJFX SDK (>= 17)
• Maven :: Apache Maven Plug-in (>= 3.8.4)
• ...Work in progress

⤵ Setup

These instructions will take you to a copy of the project running on your local machine for testing and development purposes.

    - git clone https://github.com/magujun/MineparkOnline.git
    - cd MineparkOnline

NOTE: You will need to download the javaFX libs and Apache Maven to run the application.

The following commands are an example for a GNU/Linux x86_64 environment (Debian-based).

    - sudo apt-get install unzip
    - mkdir tmp/
    - curl -L https://download2.gluonhq.com/openjfx/18/openjfx-18_linux-x64_bin-sdk.zip > tmp/openjfx-18_linux-x64_bin-sdk.zip
    - unzip tmp/openjfx-18_linux-x64_bin-sdk.zip -d tmp/

For other platforms, please check openJFX.io and download the openjfx SDK for your system.

COMPILE

   - mkdir bin/
   - javac -d bin --module-path tmp/javafx-sdk-18/lib --add-modules=javafx.controls,javafx.media,javafx.graphics -classpath bin:tmp/javafx-sdk-18/lib/javafx-swt.jar:tmp/javafx-sdk-18/lib/javafx.base.jar:tmp/javafx-sdk-18/lib/javafx.controls.jar:tmp/javafx-sdk-18/lib/javafx.graphics.jar:tmp/javafx-sdk-18/lib/javafx.media.jar:tmp/javafx-sdk-18/lib/javafx.swing.jar:tmp/javafx-sdk-18/lib/javafx.web.jar src/*

RUN

    - java --module-path tmp/javafx-sdk-18/lib --add-modules=javafx.controls,javafx.media,javafx.graphics -classpath bin:tmp/javafx-sdk-18/lib/javafx-swt.jar:tmp/javafx-sdk-18/lib/javafx.base.jar:tmp/javafx-sdk-18/lib/javafx.controls.jar:tmp/javafx-sdk-18/lib/javafx.graphics.jar:tmp/javafx-sdk-18/lib/javafx.media.jar:tmp/javafx-sdk-18/lib/javafx.swing.jar:tmp/javafx-sdk-18/lib/javafx.web.jar Minepark

Alternative: Using Maven

Install Apache Maven and run from project root

MAVEN Compile & Run

• MineparkOnline (Server) mvn exec:java
• Minepark (Game) mvn javafx:run

MAVEN Compile & Package

• MineparkOnline (Server) mvn clean compile jlink:java jpackage:jpackage
• Minepark (Game) mvn clean compile jlink:javafx jpackage:jpackage

🎓 Who taught?

The Java and JavaFX courses that led me to develop this project are part of Okanagan College's Computer Information Systems Diploma Program.

Daniel Ling COSC318 :: Network Programming

🤔 Contribute

• Fork this repository;
• Create a branch with your feature: git checkout -b my-feature;
• Commit your changes: git commit -m 'feat: My new feature';
• Push to your branch: git push origin my-feature.

After the merge of your pull request is done, you can delete your branch.

📝 License

This project is under the MIT license.
See the LICENSE file for more details.

---

Done with ❤ by Marcelo Guimarães Junior.