Welcome to OpenTriad

This project is a reimplementation of the great card game called "Triple Triad" originally developed by Squaresoft for the Playstation 1 title "Final Fantasy 8".

Architecture

The project is separated into the following subprojects:

• engine - Contains the core components and mechanics for the actual game.
• terminalApp - Contains the terminal implementation (used for implementation purposes, but also for testing)
• fxApp - Contains the JavaFX implementation (because why not?)
• android - Contains the refactored android implementation

Engine

The projects core is the 'engine'-submodule. It consists of various interfaces and default implementations. The engine itself isn't runnable (well the tests are) instead there are different implementations provided.

Model:

• Card - A pojo which contains a name and four values (top, right, bottom, left).
• Deck - Model which contains five cards.
• Player - Simple POJO which contains a name.
• Battlefield - Contains a two-dimensional array of cards and a "GameFinish"-flag.

Controller:

• BattlefieldController - Contains the actual game loop.
• PlayerController - Contains the Player-Entity and the MoveDelegate.

Persistence:

• CardParser - Enables the parsing of cards.
  • LocalJsonParser - Parses JSON-files from the hard-drive.

View:

• No view, these are implemented in the corresponding submodules (terminalApp, fxApp, android).

Interfaces / Implementations:

• CardChooser - Callbacks in order to choose cards before the actual game happens.
  • PreselectedCardChooser - Simply returns a list with five test cards.
  • TerminalCardChooser - Lets a user select five cards via terminal-input.
• BattlefieldDelegate - Callbacks for events during the game.
  • DefaultBattlefieldDelegate - Dummy implementation (for testing purposes) - doesnt actually do anything
  • The other subprojects make use of this.
• MoveDelegate - Callbacks for (engine-events) in order to provide a runtime-independent player-turn. This is needed for telling the engine which card a player sets on the battlefield.
  • RandomMoveDelegate - Mimics the turn of a player by randomly setting cards on the battlefield.
  • TerminalMoveDelegate - Allows a user to input card-, x- and y- information in order to set a card.

Screenshots

Screenshots - Terminal

(outdated) Screenshots - Android

Screenshots - JavaFX

• Coming soon...

Development

How to build & deploy

• Clone this repository: git clone https://github.com/benjaminfoo/OpenTriad.git
• Open IntelliJ IDEA, Select "Open Project" and within the FileDialog, choose the build.gradle file at the project-root - OR - cd into the project and execute "gradle build".
• Install project on emulator or mobile device.
• Thats it!

How to add custom cards

1. Add an entry to the file '/opentriad/engine/src/main/resources/cards.json' like

   {
      "name": "MyCustomCard",
       "topPower": "5",
       "leftPower": "3",
       "rightPower": "1",
       "bottomPower": "1"
    }

2. Within '/OpenTriad/app/src/main/assets/cards/', create an image (jpg!) if your custom card. The name must be the same as you've used in the json file (e.g. for this card, an image called "MyCustomCard.jpg" has to be saved.)
3. Have fun playing with your custom card!

Used Software / Libraries

• Java
• Gradle
• Gson
• JUnit

Note

Final Fantasy, Triple Triad, and all subject material are property of Square-Enix. I am not the owner / maker / author of the provided images / names or trademarks used within this project.