𝙁𝙇𝘼𝙂𝙂𝙄

A multiplayer captute-the-flag game

Flaggi is a multiplayer game developed by Samuel and Matěj as a submission for the RHS Videogame Development Club Tournament. It is built with Java 8 and uses Gradle 8.10 for dependency management and builds. This project uses Gradle featured planned to be removed in Gradle 9, and can't be used with Gradle 9. The project can be used with higher versions of Java 8 or higher.

📖 Game Overview

Flaggi is a captue the flag local multiplayer game where two players fight each other with guns, and are trying to pick the opponents flag and deposit it to theirs. If a player dies with a flag, the flag will drop on the ground, and when picked up by the opponent player (who owns the flag) it is returned to it's base. There is a time delay between dying and respawning. When a player collected 3 flags, the game ends.

Warning

Not all features of the game have been implemented yet, as it is in very early stages of development. Expect a different gameplay expirience from the game overview.

🚀 Installation

Download the latest release of the server (Server.jar) and client app from the latest release.

You can choose from the following options for the client:

• .dmg for macOS
• .exe for Windows
• .jar (universal) for any platform with Java installed

Note

This is a multiplayer game that requires a server to run, which is then accesible from all devices in the same network.

🎮 Running the Client

You can run the universal .jar client on any platform with Java 8 or higher installed using:

java -jar Flaggi.jar

Alternatively, use the platform-specific executable (.exe or .dmg) for Windows or macOS.

🖥️ Running the Server

You can run the server using one of the following methods:

1. Using Java

java -jar Server.jar

Once the server starts, it logs the IP address it's running on. Use this IP to connect clients to the server.

2. Using Docker

Clone this repository and execute the following command in the project root directory:

./scripts/run.sh docker

🛠️ Scripts and Packaging

run.sh script

The run.sh script provides multiple ways to execute the project.

• Run the following command for available options:

./run.sh --help

package.sh script

To package the project for specific operating systems, use the package.sh script:

./scripts/package.sh

Note

• The script builds platform-specific executables (.exe for Windows, .dmg for macOS).

• To generate an universal .jar, run gradle shadowjar.

• Build files will be available in:

  • Client: client/app/build/libs|win|mac
  • Server: server/app/build/libs

---

📚 Resources

• Font used in release banners: Ultra Google font
• Prompt and specifications: Game Rules (PDF)

💬 Contact

Have questions or suggestions? Feel free to:

• Create issues or submit pull requests on the GitHub repository.
• Reach out to @_kireiiiiiiii on Instagram.