Content

1) Release

2) Architecture

3) Status

4) Details

5) Story

6) Assets

1. Game Docker Container

TODO : OPTIMIZE THE CONTAINER BUILD

Description

This Docker container provides a Debian-based environment with the latest version of the game sourced from GitHub. It comes with all the necessary libraries and dependencies preinstalled. The container is configured to have access to the X11 TCP protocol, enabling the game window to be displayed on your machine.

Availability

This Docker container is available for the following operating systems:

• Ubuntu
• Debian
• Fedora
• CentOS

Docker Image

The Docker image for this container is hosted on DockerHub. It is automatically updated whenever a commit is made to the GitHub repository, ensuring that the container always reflects the latest version of the game.

CI/CD with Jenkins

This setup utilizes a local server running Jenkins, which is also a Docker container based on Ubuntu. Here's an overview of the CI/CD pipeline process:

1. When triggered, Jenkins clones the GitHub repository containing the game source code.
2. Jenkins then executes a bash script that updates the game image from DockerHub.
3. This ensures that the game image within the Docker container is always up to date with the latest changes from the GitHub repository.

Video with the CI CD project implementation:

Screencast.from.2023-05-14.13-55-28.webm

Install

• Download the 'setup' folder and make the scrips executables :

  chmod 777 docker.sh
  chmod 777 cyberpunk.sh

• Run the script that installs the docker on your linux distribution :

  ./docker.sh --install    

• Now it's time to download the newest game container :

  ./cyberpunk.sh --pull

• If you want to restart the game run :

  ./cyberpunk.sh --start

• If you want to delete the container and its image run :

  ./cyberpunk.sh --delete

Uninstall

  ./docker.sh --uninstall

2. Architecture

• The project is based on two behavioral design patterns: State and Mediator.

• Additionally, Singleton and Flyweight are used as needed.

1. Game interfaces : StaticComponent, Interactive, Notifiable, Serializable

• StaticComponent: allows implementing a frame by frame-modifiable and drawable component.
• Interactive: allows interacting with an Object.
• Notifiable: allows receiving a Message(Sender,Message,SenderId).
• Serializable: built-in in java and allows an object to be serialized.(transient—specifies which fields are ignored)
  
  

2. State & Mediator

• The SceneHandler class is designed to manage multiple scenes, allowing it to activate or deactivate scenes based on incoming requests.
• Additionally, by implementing the Notifiable interface, it is capable of notifying a specific scene when changes are made in another scene.
  
  
• The Scene abstract class not only implements the Notifiable interface but also serves as a mediator between its associated StaticComponents.
• The Scene class is extended by subclasses such as PlayScene, LevelPauseScene, MainMenuScene, LoadScene, and so on. Each of these subclasses has different types of components.
• For example, menu-related scenes will have Button and TextComponents, while PlayScene will have a series of DynamicComponents.
  
  
• The DynamicComponent class is an abstract class that implements the Notifiable, Interactive and Serializable interfaces and is extended by classes such as Player, Enemy, GameMap, Gun, Bullet, Platform, Helicopter, and Chest.
• In the PlayScene, when a component is added, it needs to be upcasted to StaticComponent. When the component needs to be notified or to interact with an object, it needs to be downcasted to DynamicComponent.
• Here is an UML diagram with the structure described :
  

3. Status

• Loading and saving from the database
• Enemy behavior
• Menu functionality
• Interactive objects like Platforms, Helicopters, Guns, and Chests
• Player inventory

---

Screencast.from.2023-05-25.11-27-33.webm

4. Details

• The game loads its assets via an XML (tmx) file generated by a Tiled app, which is parsed using DomParser. The extracted assets are then organized into the AssetsStorage class, including animations, images, positions, and more.
• The game also uses a series of enum classes such as MessageType, ComponentType, AnimationsType, and others, and has a dedicated Timer package with a Timer class and a TimerHandler to handle the created timers.
• Additionally, the game has a Utils package that includes Coordinate, Rectangle, Pair, Constants, and RandomIdGenerator classes, and dedicated classes for Window, Camera, and Input.
• The game database has a Saves table containing a text reference to a series of Save tables and a timestamp. Each Save table has an auto-increment ID to maintain order, a component type ID, and a BLOB field.

Saves	Save

5. Story

• Introduction

In a dystopian world ruled by the Illuminati, Blaze takes on the role of a lone fighter with extraordinary abilities. The fighter's mission is to stop the Illuminati from launching a mass destruction rocket that would devastate society.

• Dangers

To achieve this, Blaze must battle through various enemies, including gangsters, cyber gunners, drones, and robots, all while navigating traps and dangerous terrain. The fighter must also save innocent people caught in the crossfire, making tough decisions along the way.

• Challenges

To obtain the key codes needed to stop the rocket launch, the fighter must defeat the Illuminati general, a former American football player, and the boss of the Illuminati, a man with a powerful machine. Each of these battles presents a unique challenge, with the boss battle being particularly difficult.

• Saving the world

Once Blaze has collected all the key codes, he must race to the rocket's launch site, battling soldiers who try to stop him. With his fighting skills and determination, Blaze deactivates the rocket just in time, saving society from certain destruction.

• Happy end

As the fighter rides off into the sunset, he knows that his mission was worth the risks. Blaze have proven that even in a world ruled by the Illuminati, there is still hope for a better future.

6. Assets

• Assets were downloaded from CRAPIX.NET