abarichello / gamine

Mobile game recreating the Enigma Machine in the Wolfenstein II The New Order.

GAMINE

GAMINE Inspired by the Enigma Machine in the Wolfenstein II game, to be released to Android, IOS, Windows and Linux.

---

GAMINE


Screenshot from Wolfenstein II

Download / Play Online

• Play online here.
• Download through GitLab CI's releases or PlayStore.

Objective

This game replicates the minigame found in Wolfenstein's II Enigma Machine. You are given 7 figures(levels) and your objective is to match their halves on the selector below.

This picture shows the center selector matching the first level, pressing enter progresses you to level 2.

How to Play

Use your arrow keys or on screen buttons to move the upper and lower selectors at the bottom of the screen, if you think highlighted middle row matches your current level press Enter (or the row itself on mobile) to advance to the next level.
The game is completed after finishing all 7 levels.

Highscores

Acess the game leaderboard using this link: leaderboard.barichello.me

Running

To play the game you can check the Releases tab and download the wanted version that matches your OS.
To modify the game locally download Godot Engine and open the game/project.godot file.
To run the server locally:

1. Copy server/.env.example to server/.env
   
2. Setup database tables with ./db-migrate up
   
3. Install dependencies with yarn
   
4. Run using yarn run start.
   

Game Structure

Godot's main tree scene structure during playtime:

root:
  Main:
    - Menu:
      - Leaderboard
    - Network
    - GLOBALS
    - Game:
      - Data

Scenes/Scripts

About.gd - About menu located in the main menu.
Bit.tscn - The bit scene represents a dot, used inside the Piece scene.
Database.gd - File used to save/load your highscores to your device.
Data.gd - Game logic and structures.
Game.gd - Game frontend logic.
GLOBALS.gd - Paths and constants.
Leaderboard.gd - Leaderboard popup.
Main.gd - Root node of the project.
Menu.gd - Main menu frontend.
Network.gd - Network related queries.
Nickname.gd - Popup that handles nickname registering.
PauseMenu.gd - Game popup used for pause.
Piece.gd - A piece represents a 'square' in the game, it's composed of 9 bits.
ResultsMenu.gd - Popup used to send your highscores to the game server.
SocialMediaBox.gd - My reusable social media buttons.
Themes.gd - Popup handling themes and color switching.

Thanks

Thanks to @Batarian711 for providing the logo for the game. Check #4

gamine's Issues

Issues with web deploy

Web deploying using godot-ci 3.0.2 can't get past main menu. Probably a Godot 3.0.2 since 3.0.6 works normally.
Waiting for #16949 to close to use 3.0.6 with docker.

Logo design

Hi. I am a graphic designer. I volunteer to design a logo for open source projects. I can design it for you to use it in the readme file. What dou you say?

Create test procedures

Create GDScripts that externally instantiate a node of the other script being tested. This way functions can be called (and tested) externally.
Run these tests in a folder using Lua to call godot CLI with the -s flag as shown here

Fix generating double pieces on select row

File for constants and configs

Consider use of express-validator

https://express-validator.github.io/docs/