https://github.com/kireiiiiiiii/flaggi
A local multiplayer capture the flag game. Built with Java 8 and Gradle 8.10, featuring cross-platform support and Docker-based servers.
https://github.com/kireiiiiiiii/flaggi
docker game game-development lan-multiplayer multiplayer tournament two-player
Last synced: over 1 year ago
JSON representation
A local multiplayer capture the flag game. Built with Java 8 and Gradle 8.10, featuring cross-platform support and Docker-based servers.
- Host: GitHub
- URL: https://github.com/kireiiiiiiii/flaggi
- Owner: kireiiiiiiii
- Created: 2024-10-28T15:14:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-18T02:47:51.000Z (over 1 year ago)
- Last Synced: 2025-02-18T03:29:49.300Z (over 1 year ago)
- Topics: docker, game, game-development, lan-multiplayer, multiplayer, tournament, two-player
- Language: Java
- Homepage:
- Size: 7.49 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: licenses/OFL.txt
Awesome Lists containing this project
README
# ๐๐๐ผ๐๐๐
**A multiplayer captute-the-flag game**
Flaggi is a multiplayer game developed by [Samuel](https://github.com/Snapshot20) and [Matฤj](https://github.com/kireiiiiiiii) 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](https://github.com/kireiiiiiiii/flaggi/releases/latest).
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:
```bash
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**
```bash
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](docker.com)**
Clone this repository and execute the following command in the project root directory:
```bash
./scripts/run.sh docker
```
## ๐ ๏ธ Scripts and Packaging
### **[run.sh](./scripts/run.sh) script**
The `run.sh` script provides multiple ways to execute the project.
- Run the following command for available options:
```bash
./run.sh --help
```
### **[package.sh](./scripts/package.sh) script**
To package the project for specific operating systems, use the `package.sh` script:
```bash
./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](https://fonts.google.com/specimen/Ultra)
- **Prompt and specifications:** [Game Rules (PDF)](./public/TTT-game-rules.pdf)
## ๐ฌ Contact
Have questions or suggestions? Feel free to:
- **Create issues** or **submit pull requests** on the [GitHub repository](https://github.com/kireiiiiiiii/Flaggi).
- **Reach out** to [@\_kireiiiiiiii](https://www.instagram.com/_kireiiiiiiii) on Instagram.