3. Software Requirements Specification for Eloha View Page 1
1. Introduction
1.1 Purpose
The purpose of this document is to describe the Eloha View (EV) product with the release
number 0.1. The SRS contains the functional and non-functional requirements of the
project.
This document contains the guidelines for the stakeholders (especially Section 2) and the
developers (particularly Section 3) respectively.
1.2 Scope
The EV Product is a graphical user interface, specifically designed for the use with the
Implementation of the Eloha Card Game.
Even though the Product is adapted to fulfill the needs of the Eloha Card Game, it may be
possible to use it as a GUI for any other card game, as long as the functionality our
product provides is sufficient for this kind of card game.
This SRS describes only the required functionality of the EV, not the functionality of
external systems.
1.3 Definitions, acronyms and abbreviations
Table 1 explains the terms and abbreviations used in this document
Term / Abbreviation Explanation
SRS Software Requirement Specification
EV Eloha View
GUI Graphical User Interface
SUN JRE SUN Java Runtime Environment
Table 1
1.4 Glossary
Table 2 contains the key terms and concepts mentioned and used in this SRS
Word Explanation
player A participant of the Eloha Card Game
user The user of the EV program
card A game card from a standard playing card deck
table The playing board with the stack and the other players
stack Place where the cards which are played will be put
deck The view of a user, including his hand and buttons
hand The cards of a player
slot A placeholder for a card in a hand or in the stack
button A control which the user can activate
Table 2
4. Software Requirements Specification for Eloha View Page 2
1.5 References
The following table defines the list of all documents referenced elsewhere in these
requirements or have been used as a source to create this SRS.
Reference and Applicable Reference and Version
Document Title
Eloha Card Game https://svn.origo.ethz.ch/jid08-
SRS team17/trunk/srs_team_model/Eloha_model_SRS.pdf
IEEE 830-1998 http://se.inf.ethz.ch/teaching/2008-
standard [IEEE-830] S/0284/exercise/project_docs_step1.zip
SRS template http://www.processimpact.com/process_assets/srs_template.doc
SRS for the Virtual http://www.cs.utexas.edu/users/s2s/latest/pond2/doc/SRS.html
Pond project
Table 3
1.6 Overview
Chapter 2 defines the general functions of EV, the intended application and constraints
which must be respected.
Chapter 3 specifies functional (Section 3.1) and non functional requirements (all other
sections), including usability, reliability and security considerations and requirements. All of
them are described to a level of detail sufficient for designers to design a system to satisfy
these requirements and enable testers to test that the system satisfies these requirements.
This document is structured according to the IEEE 830-1998 standard [IEEE-830].
5. Software Requirements Specification for Eloha View Page 3
2. Overall Description
2.1 Product Perspective
The EV will provide a nice GUI for the Eloha Card Game, which will be easy and intuitive
to use.
2.2 Product Features
2.2.1 Supported functions
- intuitive control over the game through mouse and hotkeys
- support for at least 4 players
- changeable Skins of cards and table
2.2.2 Unsupported functions
- The EV will not implement any functionality of the Eloha Card Game itself. Please
consult the ECG SRS regarding these issues.
2.3 Operating Environment
The EV will work on any Platform where the SUN Java Runtime Environment is running.
6. Software Requirements Specification for Eloha View Page 4
3. Specific Requirements
This Section contains all software requirements, both functional and non-functional.
A requirement has the following properties:
Requirement ID Uniquely identifies the requirement within all EV documents.
Title Gives the requirement a symbolic name, and defines functional
property.
Description Gives the definition of the requirement.
Priority Defines the order in which requirements should be implemented.
Priorities are designated (highest to lowest) “1”, “2”, and “3”.
Requirements of priority 1 must be implemented in the first productive
system release. The requirements of priority 2 and lower are subject of
special release-agreement, which is out of scope of this document.
References Gives links to related requirements.
3.1 Functionality
This Section describes the main functional requirements of the EV. The requirements are
structured into an Event Group and a Action Group, where they are grouped into logical
clusters.
3.1.1 Events
3.1.1.1 Hand
Requirement ID R1.01.01
Title card clicked (card)
Description This event shall be triggered when the user activates a card on his
hand.
Priority 1
Prerequisites
Requirement ID R1.01.02
Title card switch (card1, card2)
Description This event shall be triggered when the user switches two cards per
drag and drop.
Priority 1
Prerequisites
3.1.1.2 Deck
Requirement ID R1.02.01
Title kill clicked
Description This event shall be triggered when the user activates the kill button.
Priority 1
Prerequisites The kill button is available (R2.03.02).
7. Software Requirements Specification for Eloha View Page 5
Requirement ID R1.02.02
Title play clicked
Description This event shall be triggered when the user activates the play button.
Priority 1
Prerequisites The play button is available (R2.03.03).
Requirement ID R1.02.03
Title pass clicked
Description This event shall be triggered when the user activates the pass button.
Priority 1
Prerequisites The pass button is available (R2.03.04).
Requirement ID R1.02.04
Title give clicked
Description This event shall be triggered when the user activates the give button.
Priority 1
Prerequisites The give button is available (R2.03.05).
3.1.1.3 General
Requirement ID R1.03.01
Title Serve game
Description This event shall be triggered when the user activates the serve game
button
Priority 1
Prerequisites serve game button is available (R2.05.01)
Requirement ID R1.03.02
Title Connect (Host)
Description This event shall be triggered when the user enters a host to connect to
and confirms.
Priority 1
Prerequisites connect button is available (R2.05.02).
Requirement ID R1.03.03
Title New game
Description This event shall be triggered when the user activates the new game
button.
Priority 1
Prerequisites new game button is available (R2.05.03).
Requirement ID R1.03.04
Title Leave game
Description This event shall be triggered when the user activates the leave game
button.
Priority 1
Prerequisites leave game button is available (R2.05.04).
Requirement ID R1.03.05
Title Quit game
8. Software Requirements Specification for Eloha View Page 6
Description This event shall be triggered when the user activates the quit game
button.
Priority 1
Prerequisites quit game button is available (R2.05.05).
Requirement ID R1.03.06
Title Change skin (skin)
Description This event shall be triggered when the user activates the change skin
button.
Priority 3
Prerequisites change skin button is available (R2.05.06).
Requirement ID R1.03.07
Title Change name (name)
Description This event shall be triggered when the user changes his name.
Priority 1
Prerequisites change skin button is available (R2.05.06).
Requirement ID R1.03.08
Title Start game
Description This event shall be triggered when the user activates the start game
button.
Priority 1
Prerequisites change skin button is available (R2.05.06).
3.1.2 Actions
3.1.2.1 Other Players
Requirement ID R2.01.01
Title add (player)
Description This action shall add a player to the table.
Priority 1
Prerequisites The maximal number of players is not reached.
Requirement ID R2.01.02
Title remove (player)
Description This action shall remove a player from the table.
Priority 1
Prerequisites The Player is at the table (R2.01.01).
Requirement ID R2.01.03
Title set card count (player, card count)
Description This action shall set the number of cards a player has on his hand.
Priority 1
Prerequisites The player is at the table (R2.01.01).
Requirement ID R2.01.04
9. Software Requirements Specification for Eloha View Page 7
Title set points (player, points)
Description This action shall set the points of a player.
Priority 1
Prerequisites The player is at the table (R2.01.01).
Requirement ID R2.01.05
Title set turn (player, turn)
Description This action shall set whether it is the players turn.
Priority 1
Prerequisites The player is at the table (R2.01.01).
Requirement ID R2.01.06
Title set role (player, role)
Description This action shall set the role of the player.
Priority 1
Prerequisites The player is at the table (R2.01.01).
3.1.2.2 Hand
Requirement ID R2.02.01
Title set size (size)
Description This action shall set number of card slots the user has.
Priority 1
Prerequisites
Requirement ID R2.02.02
Title set card (slot, card)
Description This action shall set a given slot to a specific card
Priority 1
Prerequisites The slot exists (R2.02.01).
Requirement ID R2.02.03
Title highlight card (slots)
Description This action shall highlight the card at the specific slot.
Priority 1
Prerequisites The slot exists (R2.02.01), there is a card in the slot (R2.02.02), and
the hand needs to be active (R2.02.05)
Requirement ID R2.02.04
Title un-highlight card (slots)
Description This action shall un-highlight the card at the specific slot.
Priority 1
Prerequisites The slot exists (R2.02.01), there is a card in the slot (R2.02.02), and
the hand needs to be active (R2.02.05)
Requirement ID R2.02.05
Title set active
Description This action shall set the hand to active
Priority 1
Prerequisites
10. Software Requirements Specification for Eloha View Page 8
Requirement ID R2.02.06
Title set inactive
Description This action shall set the hand to inactive
Priority 1
Prerequisites The hand was active (R2.02.05).
Requirement ID R2.02.07
Title play cards (slots)
Description This action shall play the cards from the given slots.
Priority 1
Prerequisites The slots exist (R2.02.01) and there are cards in them (R2.02.02).
Requirement ID R2.02.08
Title give cards (slots, player)
Description This action shall give the cards to another player.
Priority 1
Prerequisites The slots exist (R2.02.01), there are cards in them (R2.02.02), and the
player is at the table (R2.01.01)
3.1.2.3 Deck
Requirement ID R2.03.01
Title set turn (turn)
Description This action shall whether the user is on turn.
Priority 1
Prerequisites
Requirement ID R2.03.02
Title set kill available (available)
Description This action shall set the availability of the kill button.
Priority 1
Prerequisites
Requirement ID R2.03.03
Title set play available (available)
Description This action shall set the availability of the play button.
Priority 1
Prerequisites
Requirement ID R2.03.04
Title set pass available (available)
Description This action shall set the availability of the pass button.
Priority 1
Prerequisites
Requirement ID R2.03.05
Title set give available (available)
Description This action shall set the availability of the give button.
Priority 1
Prerequisites
11. Software Requirements Specification for Eloha View Page 9
Requirement ID R2.03.06
Title set message (message)
Description This action shall set a specific message on the message field of the
user.
Priority 1
Prerequisites
Requirement ID R2.03.07
Title clear message
Description This action shall clear the message field of the user.
Priority 1
Prerequisites
Requirement ID R2.03.08
Title set role (role)
Description This action shall set the role of the user.
Priority 1
Prerequisites
3.1.2.4 Stack
Requirement ID R2.04.01
Title set size (size)
Description This action shall set the number of slots of the stack.
Priority 1
Prerequisites
Requirement ID R2.04.02
Title set card (stack position, card)
Description This action shall set a given slot of the stack to a specific card.
Priority 1
Prerequisites The card and the slot of the stack exist (R2.04.01).
Requirement ID R2.04.03
Title clear stack
Description This action shall remove all cards and slots from the stack.
Priority 1
Prerequisites
3.1.2.5 General
Requirement ID R2.05.01
Title set serve game available
Description This action shall set the availability of the set serve game button.
Priority 1
Prerequisites
Requirement ID R2.05.02
Title set connect available
Description This action shall set the availability of the set connect button.
12. Software Requirements Specification for Eloha View Page 10
Priority 1
Prerequisites
Requirement ID R2.05.03
Title set new game available
Description This action shall set the availability of the set new game button.
Priority 1
Prerequisites
Requirement ID R2.05.04
Title set leave available
Description This action shall set the availability of the set leave button.
Priority 1
Prerequisites
Requirement ID R2.05.05
Title set quit game available
Description This action shall set the availability of the set quit game button.
Priority 1
Prerequisites
Requirement ID R2.05.06
Title set skins available
Description This action shall set the availability of the change skin button.
Priority 3
Prerequisites
Requirement ID R2.05.07
Title set start game available
Description This action shall set the availability of the start game button.
Priority 1
Prerequisites
3.2 Usability
3.2.1 Documentation
Requirement ID R_NF1.01.01
Group UsabilityDocumentation
Description The system documentation shall be sufficient to start using the EV
immediately after the first reading. The documentation shall describe
all implemented system functionality.
Priority 1
References
3.2.2 Language
Requirement ID R_NF1.02.01
13. Software Requirements Specification for Eloha View Page 11
Group UsabilityLanguage
Description All system messages, texts and the help documentation must be in
English.
Priority 1
References
Requirement ID R_NF1.02.02
Group UsabilityLocalization
Description The system shall be designed in that way, that the localization
(translation of the GUI, all system messages, documentation and help
into other languages) can be done within 3 days by 1 persons under
condition that all text strings are translated into the goal language.
Priority 2
References
3.3 Reliability
3.3.1 Error handling
Requirement ID R_NF1.03.01
Group ReliabilityError handling
Description The system shall provide full information about failures and errors. The
information shall include: time of failure, origin (subsystem or
component) where a failure occurred and description of error or failure.
Priority 3
References
3.4 Deployment
3.4.1 Installation
Requirement ID R_NF1.04.01
Group DeploymentInstallation
Description The EV shall run on the SUN JRE and therefore must not need any
specific installation
Priority 1
References
14. Software Requirements Specification for Eloha View Page 12
3.5 System
3.5.1 Supported Operating Systems
Requirement ID R6.01.01
Group SystemSupported OS
Description The EV shall run on any OS that supports the SUN JRE
Priority 1
References
