Software Requirement Specification
Software Requirement Specification
Revision History
Document Approval
The following Software Requirements Specification has been accepted and approved by the
following:
Signature Printed Name Title Date
Table of Contents
REVISION HISTORY ............................................................................................................................................... 3
DOCUMENT APPROVAL ............................................................................................................................................... 3
1. INTRODUCTION .................................................................................................................................................. 1
1.1 PURPOSE ............................................................................................................................................................. 1
1.2 SCOPE ................................................................................................................................................................. 1
1.3 DEFINITIONS, ACRONYMS, AND ABBREVIATIONS ............................................................................................... 1
1.4 REFERENCES ....................................................................................................................................................... 2
1.5 OVERVIEW .......................................................................................................................................................... 2
2. GENERAL DESCRIPTION .................................................................................................................................. 2
2.1 PRODUCT PERSPECTIVE ...................................................................................................................................... 2
2.2 PRODUCT FUNCTIONS ......................................................................................................................................... 3
2.3 USER CHARACTERISTICS .................................................................................................................................... 3
2.4 GENERAL CONSTRAINTS ..................................................................................................................................... 3
2.5 ASSUMPTIONS AND DEPENDENCIES .................................................................................................................... 3
2.6 FLOWCHART FOR GAME FLOW ............................................................................................................................ 3
2.7 DETAILS OF THE GAME SEQUENCES.................................................................................................................... 5
The Main Screen: ................................................................................................................................................ 5
Game Progress Screen:....................................................................................................................................... 5
Mission 1: Planting the trees .............................................................................................................................. 5
Mission 2: Helping the injured people ................................................................................................................ 6
Mission 3: Town Planning .................................................................................................................................. 6
Mission 4: Quiz ................................................................................................................................................... 6
3. SPECIFIC REQUIREMENTS .............................................................................................................................. 7
3.1 EXTERNAL INTERFACE REQUIREMENTS .............................................................................................................. 7
3.1.1 User Interfaces ........................................................................................................................................... 7
3.1.2 Hardware and Software Interfaces ............................................................................................................ 7
3.2 FUNCTIONAL REQUIREMENTS ............................................................................................................................. 7
3.2.1 Overview of Functional Requirements ....................................................................................................... 7
3.2.2 Template for Describing Functional Requirements ................................................................................... 7
3.2.3 Introductory Movie..................................................................................................................................... 8
3.2.4 Main Menu ................................................................................................................................................. 8
3.2.5 Game Sequence .......................................................................................................................................... 8
3.2.6 Ending Scene .............................................................................................................................................. 9
3.3 NON-FUNCTIONAL REQUIREMENTS .................................................................................................................... 9
3.3.1 Performance ............................................................................................................................................... 9
3.3.2 Availability ................................................................................................................................................. 9
3.3.3 Security ...................................................................................................................................................... 9
3.3.4 Maintainability ........................................................................................................................................... 9
3.3.5 Portability ................................................................................................................................................ 10
3.4 DESIGN CONSTRAINTS ...................................................................................................................................... 10
3.5 OTHER LOGICAL REQUIREMENTS ..................................................................................................................... 10
1. Introduction
This document lays out a project plan for the development of the game-Salvos. This game is
intended to promote the awareness on landslides. This document defines the purpose, the
scope along with the general description of the game. This document also states the hardware
constraints along with the functional and non-functional requirements expected from the
software.
1.1 Purpose
The purpose of this document is to describe the proposed functionality of the software product
requested by Dr. Neelima Satyam of The Department of Civil Engineering, IIT Indore. The SRS
will include the details of the project's requirements, interface, design issues, and components.
The intended readers of this document are the current and future developers working on the
project and proposer of this project. The document is the collection of all assorted ideas that
have come up to define the system, its requirements with respect to help our clients in their
research. Few ideas may get evolved or may get discarded as the project develops.
In short, the purpose of this SRS document is to provide a detailed overview of our software
product, its parameters and goals. This document describes the project's target audience and
its user interface, hardware and software requirements. It defines how our client, team and
audience see the product and its functionality.
1.2 Scope
The Salvos game project is a learning tool created to help improve the awareness among the
children in age group from 6 to 10 years. The product will be an interactive windows game. The
Application will be released as a native Windows desktop application. The main objective of the
game is to spread awareness among children as the frequency of landslides in the Himalayan
region of northeast India is high. At the end of the game, students will be given feedback based
on their game scores. The game will focus on the teaching of both prevention (pre-disaster
stage) and survival during the landslide. The game will focus on learning through visualization
and simulation. The game scoring will be based on the activity player performs and its
correctness according to scientifically proven ways.
OS Operating System
CPU Central Processing Unit
GUI Graphical User Interface
Unity3d Game Engine for game development
DX DirectX
SP Service Pack
SSE Streaming SIMD Extensions
Character The player will play the game as some character having name as given
by user.
Mission Level of the game focusing on consolidation of one concept. This is in
the form of task.
Stars Scores given at the end of each level (maximum number 3)
Soil Erosion Soil erosion is defined as the wearing of topsoil. Topsoil is the top layer
of soil and is the most fertile because it contains the most organic,
nutrient-rich materials
1.4 References
Dr. Neelima Satyam, Department of Civil Engineering, IIT Indore
Dr. Abhishek Srivastav, Department of Computer Science & Engineering, IIT Indore
Project Repository:https://github.com/Niranjan-J/Group-H-Project-4/
Overview of Game Design:https://github.com/Niranjan-J/Group-H-Project-
4/blob/master/Documentation/Game_design.md
Literature on Landslides:https://github.com/Niranjan-J/Group-H-Project-
4/blob/master/Documentation/literature.md
Game development:https://unity3d.com/
1.5 Overview
This document is designed to provide information to both the client and the technical designers
of the software. Section one is a brief overview of the product, including definitions and
references. The definitions section is intended to assist the technical designers as well as the
client in clarifying the terms used throughout the document. Section two is a general
description of the product requirements from a user's perspective. This section includes
information such as functional and data requirements, general constraints, and assumptions.
Section three is a detailed requirements specification targeted to technical designers. Specific
requirements and expectations regarding the components of the product are given in this
portion of the SRS document.
2. General Description
2.1 Product Perspective
The game is interactive and comes as native desktop application for Windows. The program
requires an internet connection only for downloading the application. The game can run offline.
The game aids teaching through simulation, providing tutorials, hints, video clips and promoting
competitive learning by offering stars for good scores. This encourages learning through
understanding of the concept. The focus is on teaching concepts that have a research level
scientific understanding to the children. Simulation will provide an effective way of visualization
and also enhances the user experience.
This program can run offline on any computer that satisfies the above mentioned
requirements.
3. Specific Requirements
3.1 External Interface Requirements
3.1.1 User Interfaces
We will have to provide a 3D video interface to the user so that he can get himself immersed
into the game. A first player controller, hence, would be the best suited for the game.
Outputs The form, shape, destination, and volume of the output; output timing;
range of parameters in the output; a unit measure of the output;
process by which the output is stored or destroyed; process for handling
error messages produced as output.
Purpose A short movie to set up the storyline of the game and provide
information to help the user about landslides
Inputs If the user clicks the introductory movie button, the movie will start. If
the user clicks the SKIP button while in this component, they will skip
the movie and proceed to the main menu.
Processing Upon selecting this component, the introductory movie will start
playing. If the SKIP button is pressed, this component will terminate the
movie and forward the user to the main menu component. Otherwise,
the movie will continue to its completion and the user will be moved to
the main menu.
Outputs A movie is displayed on the screen.
Purpose A menu that displays a brief section offering various options such as
PLAY GAME, SETTINGS, QUIT, INTRODUCTORY MOVIE.
Inputs The user can click on the corresponding button to perform that function
Processing This component will stay until the user selects an option. After the
selection, the user will be forwarded to the game sequence component,
depending on the button selected.
Outputs This component will output the selection function.
Outputs This component will output plot-based missions that are customizable
by the game administrator and offer feedback to the user based on their
performance on individual missions.
3.3.1 Performance
All the modules should be in a single game and should be followed by a single story or theme of
the game. Different tasks in the game require the above-mentioned parameters. Responses
should be added by mouse or keyboard and a log file should be generated having the score
information.
3.3.2 Availability
The game should be of distributable over different PCs. Since we are publishing it on the web, it
will be accessible and available for download.
3.3.3 Security
The game will be entirely offline. So, there are no threats to user privacy and from potential
hackers.
3.3.4 Maintainability
Collaboration using version control systems like Git and storage of the code on the cloud of Git
Hub and proper comments and description for every code will ensure that a new programmer
who gets to work or improve this very piece of code faces minimal hurdles. A proper
documentation for every module shall be included.
3.3.5 Portability
All the laptop/PC machines that possess Windows 10 or versions newer than that are capable
to run this product.