Requirements Document (Version 1) - LayeredPlatformer/LayeredPlatformerUnity GitHub Wiki

1 General Information

1.1 Overview

The Layered Platformer project purpose is to create a mobile game using the Unity3D game development tool. The game will be developed as a 2D platformer game with an additional depth aspect. This game will be released to the major mobile app markets.

1.2 Document Scope

This Requirements Document outlines the Business Requirements, Functional Requirements, and Traceability for the this project. It also describes a Minimum Viable Product and a Semester Milestone goal.

2 Business Requirements

The Layered Platformer project will release a mobile game. This game will be released to both the Android and iOS app stores.

3 Functional Requirements

3.1 Minimum Viable Product

3.1.1 Summary

In order for the product to be released to the market, it needs to be a complete game. This means that there needs to be a specific beginning and end to the game. There will be a normal game interface, which includes a start screen and a pause screen. There needs to be user controls, which correctly controls the movement, attacks, and special abilities of the character. The game needs to include at least one attack and one special ability. This special ability will be the ability to switch between the different layers. The game needs to be able to pause. There will be dialogue telling the story that the game develops. There needs to be functionality to be able to skip different dialogue screens.

  • Game beginning (3.1.1.1)
  • Game end (3.1.1.2)
  • Interface
    • Start screen (3.1.1.3)
    • Pause screen (3.1.1.4)
  • Dialog skip (3.1.1.5)
  • Player abilities
    • Left/right movement (3.1.1.6)
    • Jump: The player can jump when grounded. (3.1.1.7)
    • Basic attack: The player can basic attack targetable objects to damage them. (3.1.1.8)
    • Layer cycle: The player can cycle through time layers in a single direction, linearly. (3.1.1.9)
    • Shadow
      • Shadow trail: The player has a time shadow of himself trail behind him. (3.1.1.10)
      • Shadow blink: The player can teleport to the layer and position of his shadow. (3.1.1.11)

3.1.2 Introduction

There will be an introduction to the game which teaches the player how to play. It will provide an overview for the different controls in the game.

3.1.3 Plot Summary

The game tells the story of a group of people who are Watchers, beings whose purpose it is to protect the sanctity of time. The main character of the game is an apprentice to the Master Watcher. This apprentice sees something wrong on the planet Earth and begins to explore further. This exploration reveals that one of the Watchers has taken it upon himself to alter the original timeline, changing things wherever he goes. The main character follows the Watcher’s clockwork minions into the past (where he will then proceed to fight against them in search of the Watcher responsible for the alterations in the timeline), ultimately coming across the Watcher of Charity. The main character then fights with the watcher. As the main character wins the fight, he decides to either spare or kill the former ally, at which point the events that Watcher altered revert back to normal.

3.1.4 Ending Credits

At the end of the game, the ending credits are shown. Afterwards, the start screen loads and the user can choose to play a new game.

3.1.5 Cross-Platform

This game will be released to both the Android and the iOS markets. This will allow a variety of users to download and enjoy playing the game.

4 Semester Milestone

After the Minimum Viable Product is complete, the team will implement a full story. This story will feature additional Watchers (4.1) to be defeated and the Master Watcher who will represent the end boss. The game will be divided into levels (4.2), with a different Watcher that is encountered at the end of each level. Different layers will be introduced representing different time periods and the user will be able to switch between these layers throughout the game. Additionally, the user will have more special abilities and the enemies will be more effective against the user. (4.3)

  • Additional Watchers (Inspired by the 7 Virtues)
  • Temperance (4.1.1)
  • Chastity (4.1.2)
  • Diligence (4.1.3)
  • Patience (4.1.4)
  • Kindness (4.1.5)
  • Humility (4.1.6)

5 Traceability

In order to track the implementation of the requirements, the detailed requirements will be added to Trello, which is an app that monitors the execution of different tasks represented by cards and lists of cards. These cards will be moved through the different lists, providing a timestamp as they are moved. Additional information can be added to each card including comments or screenshots.