Samurai Game

Samurai Game is an exciting samurai-themed platform game developed for mobile platforms using Godot Engine.

The goal of the game is to complete each level by collecting a skull. Players will encounter obstacles, battle enemies, and collect valuable items along the way, while ensuring they don't run out of lives. There will be multiple enemy classes (a total of 6), each with unique attacks and defenses. One of the protagonist's special abilities is the power to deflect arrows shot by enemies, allowing players to reflect them back and defeat the enemies, but only with precise timing.

The game features two demo levels that provide a glimpse into the challenges players will face in the full game. Additionally, online leaderboard functionality has been incorporated, tracking completion times and collected coins during each level.

Two demo levels have been designed to offer players a preview of the challenges they will encounter in the full game. Furthermore, online features have been implemented to provide a competitive element, allowing players to compete for top rankings based on their completion time and the number of collectibles obtained during each level.

Samurai Game was developed and conceived by Luca Gregori for the Mobile Computing course at Roma Tre University (2021/2022). For more information, please refer to the References section.

You can watch a complete gameplay video showcasing all the features of the game at the following link.

---

Table of Contents

• Wiki
  • Objectives
  • Tips
  • Enemies
  • Miscellaneous
  • Levels
  • Leaderboards
• Installation
  • Setting Up Firebase Environment
• References

---

Wiki

In this section, you'll find all the essential information about Samurai Game. From objectives and tips to details about different enemies and other game elements, this wiki serves as a handy guide to navigate through the game's features and challenges.

Objectives

In Samurai Game, the main objectives are as follows:

| Image | Objective | |---------------------|--------------------------------------------------| | | Collect scattered coins throughout the level | | | Collect the skull to conclude the level |

Tips

In the main section of the game, players can access a HOW TO PLAY screen that explains the main objectives in a few words and provides some basic tips.

<img src="docs/screenshot1.png" alt="Tips" style="max-width: 50%;" />

Extra advices

• Execute a melee attack against an incoming arrow to send it back and kill the archer or any enemy in its path.
• If left undisturbed, the swordsman with a shield will not attack you.

Enemies

Samurai Game features various enemies with different characteristics:

<table style="width: 100%;"> <tr> <th>Image</th> <th>Entity</th> <th>Speed</th> <th>Attack</th> <th>Defense</th> <th>Health</th> <th>Description</th> </tr> <tr> <td align="center"><img src="docs/skeleton.gif" alt="Skeleton" style="max-width: 100%;"></td> <td align="center"><strong>Skeleton</strong></td> <td align="center">Fast</td> <td align="center">Melee</td> <td align="center">No</td> <td align="center">1 HP</td> <td>A simple enemy that performs melee attacks.</td> </tr> <tr> <td align="center"><img src="docs/knight.gif" alt="Swordsman" style="max-width: 100%;"></td> <td align="center"><strong>Swordsman</strong></td> <td align="center">Medium</td> <td align="center">Sword</td> <td align="center">No</td> <td align="center">2 HP</td> <td>An enemy that performs attacks with a sword.</td> </tr> <tr> <td align="center"><img src="docs/shield.png" alt="Swordsman with shield" style="max-width: 65%;"></td> <td align="center"><strong>Swordsman with shield</strong></td> <td align="center">Slow</td> <td align="center">Sword</td> <td align="center">Shield</td> <td align="center">3 HP</td> <td> When the player gets close to this enemy, they automatically raise their shield for defense.<br> If you hit the shield, the attack will be blocked, and the enemy will counterattack immediately afterward.<br> If you fail to hit the enemy while the shield is raised, there is a good chance that they will initiate an attack on their own.<br> The probability of the enemy's initiating an attack increases as time passes. </td> </tr> <tr> <td align="center"><img src="docs/archer.gif" alt="Archer" style="max-width: 100%;"></td> <td align="center"><strong>Archer</strong></td> <td align="center">Medium</td> <td align="center">Bow</td> <td align="center">No</td> <td align="center">2 HP</td> <td> As soon as the player enters the archer's line of sight, the archer will shoot an arrow towards them.<br> The arrows can also damage other enemies besides the player. </td> </tr> <tr> <td align="center"><img src="docs/yellow_archer.gif" alt="Yellow Archer" style="max-width: 100%;"></td> <td align="center"><strong>Yellow Archer</strong></td> <td align="center">Medium</td> <td align="center">Bow</td> <td align="center">No</td> <td align="center">2 HP</td> <td>Behaves like a regular archer, but shoots 5 consecutive arrows in rapid succession as a single attack.</td> </tr> <tr> <td align="center"><img src="docs/red_archer.gif" alt="Red Archer" style="max-width: 100%;"></td> <td align="center"><strong>Red Archer</strong></td> <td align="center">Medium</td> <td align="center">Bow</td> <td align="center">No</td> <td align="center">2 HP</td> <td>Behaves like a regular archer, but shoots 3 arrows simultaneously in a single attack.</td> </tr> </table>

Miscellaneous

Samurai Game also includes various miscellaneous elements:

<table> <tr> <th>Image</th> <th>Description</th> </tr> <tr> <td align="center"><img src="docs/circular_saw.png" alt="Circular Saw" style="max-width: 50%;"></td> <td>Circular saw capable of damaging the player.</td> </tr> <tr> <td align="center"><img src="docs/spuntoni.png" alt="Circular Saw" style="max-width: 100%;"></td> <td>Spikes capable of damaging the player.</td> </tr> </table>

Levels

The game offers two levels: a simpler introductory level and a more challenging second level, featuring a final showdown with the formidable Red Archer. The first level introduces gameplay mechanics, while the second level tests player's skills with increasing difficulty.

Players can select levels from the level selection screen, where infographics display completion status and performance statistics, including time taken, coins collected, and enemies defeated.

<table style="width: 100%;"> <tr> <td align="center"> <img src="docs/screenshot3.png" alt="Level selection screen" style="max-width: 100%;" /> <p><em>Level selection screen</em></p> </td> <td align="center"> <img src="docs/screenshot4.png" alt="First level" style="max-width: 100%;" /> <p><em>First level</em></p> </td> </tr> <tr> <td align="center"> <img src="docs/screenshot5.png" alt="Second level" style="max-width: 100%;" /> <p><em>Second level</em></p> </td> </tr> </table>

Leaderboards

After registering and logging into the online section, players have the opportunity to rank themselves on a global leaderboard upon completing each level.

<table style="width: 100%;"> <tr> <td align="center"> <img src="docs/screenshot6.png" alt="Login screen" style="max-width: 100%;" /> <p><em>Login screen</em></p> </td> <td align="center"> <img src="docs/screenshot7.png" alt="Leaderboard for the second level" style="max-width: 100%;" /> <p><em>Leadboard for second level</em></p> </td> </tr> </table>

The score is calculated considering various factors, including:

| Action | Points Earned | |-----------------------------|---------------------| | Completing the level | 300 - time taken | | Collecting coins | +100 per coin | | Killing skeletons | +20 per skeleton | | Killing knights | +50 per knight | | Killing shield knights | +100 per shield knight | | Killing archers | +50 per archer | | Killing yellow archers | +100 per yellow archer | | Killing red archers | +150 per red archer |

Players can aim to achieve higher scores by completing levels efficiently and defeating more enemies while collecting coins to boost their rankings on the global leaderboard.

---

Installation

To install Samurai Game on android, navigate within this repository to the release section and download the APK file. Copy the APK file to your device and before proceeding with the installation, make sure to enable the function: Install from unknown sources.

Once the game is installed, navigate to the settings to grant the application read and write permissions to files. Without this step, it will not be possible to use in-game statistics.

The game has been tested on Android version 6.0 (Marshmallow). For optimal performance and compatibility, it is recommended to have an Android device running Marshmallow or a more recent version.

Setting Up Firebase Environment

The provided script Firebase.gd is resp