Csoport neve: Segmentation_Fault

Feladat sorszáma: 6

Feladat címe: Stratégiai játék

Szoftver követelmény specifikáció

Gyakorlatvezető::

Repási Tibor

Csoport tagok:

2006.03.23

Történet

Tartalomjegyzék

1. Bevezetés

2. Áttekintés

3. A rendszer funkciói

3.1. Menü
3.2. Főképernyő
3.3. Város képernyő
3.4. Csapat képernyő
3.5. Csata képernyő
3.6. Állapot kezelő modul
3.7. Hálózati interfész

4. Használhatóság

5. Megbízhatóság

6. Teljesítmény

7. Támogatottság

8. Tervezési korlátozások

9. On-line dokumentáció és Help rendszer

10. Felhasznált kész komponensek

11. Interfészek

11.1. Felhasználói interfészek
11.2. Hardware interfészek
11.3. Software interfészek
11.4. Kommunikációs interfészek

12. Alkalmazott szabványok

12.1. Kötelezően alkalmazandó szabványok
12.2. Választás alapján alkalmazott szabványok

13. Mellékletek

1. Bevezetés (Introduction)

Ez a dokumentum a tervezéshez szükséges részletességgel foglalja össze a megírandó szoftverrel szemben támasztott funkcionális és nem funkcionális követelményeket. A dokumentum fő célja a szoftver által biztosított szolgáltatások leírása. A dokumentumot a megrendelő képviselőinek és magunknak, a fejlesztő gárdának szánjuk.A dokumentum tartalmaz egy áttekintést a termékről, leírja a rendszer alapvető funkcióit és azok kapcsolatait. Információkat nyújt a szoftver használhatóságáról, megbízhatóságáról, feltételezett teljesítményéről, támogatottságáról, tervezési korlátairól. Ezenfelül megtalálhatók a szoftverhez kötődő interfészek és alkalmazott szabványok listája.
Ez a dokumentum készíti elő a készülendő rendszer objektumainak, osztályinak, közöttük lévő kapcsolatok leírását. A rendszer viselkedése és futása közbeni számítások is itt kezdenek kibontakozni.

2. Áttekintés (Overview)

• A termék környezete:
  
  - Körökre osztott stratégia játék, amely Microsoft Windows XP/2000 operációs rendszeren fut, esetleg opcionálisan Linuxon.
  - Szórakozás nyújtása a játékosoknak szabadidejük eltöltésére.
  
  

• Legfontosabb funkciók:
  
  - Menü funkciói: új játék, vissza a játékhoz, játék mentése, játék betöltése, segítség, készítők, kilépés..
  - Játéktér lekezelése, mozgás, csata ( új képernyőn ), bányászat, fejlesztések.
  - Előre gyártott futtatható telepítő fájl, a program automatikus felinstallálása.
  - Előre definiált fájl segítségével a programhoz tartozó építőelemek letörlése, a módosított rendszerváltozók visszaállítása.
  
  

• A felhasználók jellemzői:
  
  - A felhasználó tudjon írni, olvasni. ( kisgyermekek miatt került bele ez a kritérium )
  - Fontos, a számítógép alapvető ismerete, kezelése.
  - Egér,.billentyűzet használata.
  - Szoftver telepítésének képessége, esetleges beállításai.
  - Alapvető alkalmazkodási képesség. ( Játék funkcióinak megtanulásához ).
  - Újdonságok iránti vonzalom.
  
  

• Korlátozások:
  
  - Nem megfelelő hardver használat (az un. "kalapács módszer").
  - Nem megfelelő szoftver használat (a szoftverelemek kézi módosítása, letörlése).
  - Minimum hardver követelmény.
  - Operációs rendszer függősége.
  
  

• Feltételezések és függőségek: 
  
  - Feltételezzük, hogy a közeljövőben a számítástechnikában nem következik be olyan fejlettségbeli ugrás, amely a szoftverünk mint hardveres mind szoftveres szempontból elavulttá teszi.
  - A szoftver nagyban függ az operációs rendszertől, amelyre íródik.
  - Továbbá a függünk a felhasználói igény szinttől.
  

• A követelmények csoportosításának szempontjai:
  

3. A rendszer funkciói (Specific Requirements)

3.1. Menü

• Prekondíciók:
  
  • A játék elindulása, a main() indítja.
  • Az intró lefutása.

• Postcondíciók:
  Itt több lehetséges állapot lehet a menüpont választásától függően.
  
  • Megjelenik a főképernyő.
  • Visszatérés operációs rendszerbe.

• Szokásos működés / kapcsolatok leírása:
  Megjelenik a főmenü, majd egérrel kiválaszthatók a menüpontok.
  
  • Vissza a játékhoz: befejeződik a modul működése, és elindul a főképernyőé.
  • Mentés: utasítja az állapotkezelő modult, hogy mentse fájlba a játék állását.
  • Betöltés: kikereshető a megfelelő mentés, majd ezután az állapot kezelő modul beállítja aktuális állapotnak.
  • Beállítások: itt a grafikai és audio beállítások állíthatóak.
  • Segítség: megjelenít egy helpet.
  • Készítők: megjeleníti a készítőket, azok tulajdonságait, és a szoftver elérhetőségeit.
  • Kilépés: befejeződik a futás, majd visszatér az operációs rendszerbe.

• Alternatív esetek:
• Nem ismertek

• Kivételes esetek:
  
  • Ha nincs joga a mentés létrehozásához, kivételes eseményt generál ( hibaüzenetet ad ).

3.2. Főképernyő

• Prekondíciók:
• Menü indítja el.
• Futnia kell már az Állapot kezelő modulnak.

• Postcondíciók:
• Ha futása befejeződik, elindul a menü.

• Szokásos működés / kapcsolatok leírása:
  
  • Folyamatosan kommunikál az állapotkezelő modullal. Indulása után kirajzolja a képernyőt ( kezelőpult objektumait, játékteret ), majd folyamatosan frissíti, az állapotkezelő állapotüzenetei alapján (delegált objektum). Reagál az egérkattintásokra (OnMouseOver(), OnClick(), OnDoubleClick(), OnRightClick() eseménykezelőket futtatja).

• Alternatív esetek:
  
  • Nem ismertek.

• Kivételes esetek:
  
  • Ha az adatkezelő objektum feldolgozhatatlan üzenetet küld, kivételes esemény keletkezik.

3.3. Város képernyő

• Prekondíciók:
  
  • A főképernyő indítja. Szüksége van a futó állapot kezelő modulra.

• Postcondíciók:
• Kilépés esetén visszatér a főképernyő.

• Szokásos működés / kapcsolatok leírása:
• Lekéri a városra vonatkozó adatokat az állapot kezelőtől, majd megjeleníti a városképet a képernyőn. Változtatások esetén, az adatokat visszaküldi a állapot kezelőnek.

• Alternatív esetek:
• Nem ismertek.

• Kivételes esetek:
• Ha az állapot kezelő nem megfelelően reagál kivételes esemény keletkezik.

3.4. Csapat képernyő

• Prekondíciók:
• A főképernyő indítja. Szüksége van a futó, állapot kezelő modulra.

• Postcondíciók:
• Kilépés esetén visszatér a főképernyő.

• Szokásos működés / kapcsolatok leírása:
  
  • Lekéri a csapatra vonatkozó adatokat, és megjeleníti. Csak olvas a állapotkezelőből, nem ír.
  • Ha két csapat egymás mellett van a csapatok közötti egységcserét bonyolítja le. Ebben az esetben ír az állapotkezelőre.
    

• Alternatív esetek:
  
  • Nem ismertek.

• Kivételes esetek:
  
  • Ha az állapot kezelő nem megfelően reagál kivételes esemény keletkezik.

3.5. Csata képernyő

• Prekondíciók:
  
  • A főképernyő indítja. Szüksége van a futó, állapot kezelő modulra.

• Postcondíciók:
  
  • Ha futása végetér visszatér a főképernyőre. Ha ez volt az utólsó csata ( utólsó csapatunk/városunk, vagy utólsó ellenséges csapat/város ), akkor vesztes/nyertes képernyőt jelenít meg, majd indítja a menüt.

• Szokásos működés / kapcsolatok leírása:
  
  • Lekéri az adatokat az állapotkezelő modulból ( a mi csapatunkét, és az ellenséges csapatét is ). Inicializálja a csataképernyőt. Onclick() metódusra reagál (egységek kijelölése). És a támadás gombra kattintva sebzéseket számol, majd új körbe léptet. Csata vége esetén végállapotot visszaírja az állapotkezelő modulba, és csata nyertes/vesztes képernyőt mutat.

• Alternatív esetek:
  
  • Nem ismertek.

• Kivételes esetek:
  
  • Ha az állapot kezelő nem megfelően reagál kivételes esemény keletkezik.

3.6. Állapot kezelő modul

• Prekondíciók:
  
  • A játék indulása után közvetlenül inicializálódik.

• Postcondíciók:
  
  • Futása befejeztével a program futása mindenképpen végetér.

• Szokásos működés / kapcsolatok leírása:
  
  • A program indulása után közvetlenül inicializálódik. Külön szálon fut. Kapcsolatot tart a játék fő moduljaival. Kezeli az adatokat, tárolja az aktuális játékállapotot a memóriában, mentést végez a merevlemezbe, betölt egy régebbi mentést aktuális állapottá téve. Külön objektumban tárolja a mi adatainkat, és az összes ellenségünk adatait( egyenként ). Szükség esetén a hálózati modullal szinkronizál ( delegált objektumon keresztül ), illetve fogadja az információ kéréseket/adásokat a különböző objektumoktól.

• Alternatív esetek:
  
  • Nem ismertek.

• Kivételes esetek:
  
  • Ha nincs joga a merevlemezre írni, hibát generál.
  • Ha nem megfelelő adatokat küld a hálózati interfész, kivételes esemény keletkezik.
  • Ha nem megfelelő adatokat kap a többi modultól, kivételes esemény keletkezik.

3.7. Hálózati interfész

• Prekondíciók:
• Csak hálózati játék esetén indul, a menü indítja a főképernyővel egyetemben. Szüksége van a futó állapotkezelő modulra.

• Postcondíciók:
• Leállása esetén indul a menü, mindenképpen leáll, ha a főképernyő futása befejeződik, és viszont.

• Szokásos működés / kapcsolatok leírása:
  
  • Az állapotkezelőtől kéri a hálózati kapcsolat felépítéséhez szükséges adatokat. Azok alapján felépíti a kapcsolatokat. A bejövő adatokat küldi az állapot kezelő modulnak, és a tőle kapott adatokat szétküldi a peer-eknek.

• Alternatív esetek:
  
  • Nem ismertek.

• Kivételes esetek:
  
  • Hálózati kapcsolat hiba esetén kivételes eseményt generál.

4. Használhatóság (Usability)

• A betanulás ideje:

• A kezdő felhasználót segítő rendszertulajdonságok:

• A játék Segítség menüpontja:

• A játék tippadása:

• Egyéb betanulási lehetőségek:

• A játék Felhasználói kézikönyve:

• A játék honlapjának fórum menüpontja:

• A játék honlapjának problémabejelentés menüpontja:

• A felhasználói felület és használati módjának hasonlósága és eltérése más játékokhoz képest:

• Párhuzamosan használt hasonló alkalmazások kérdése:

5. Megbízhatóság (Reliability)

• Megbízhatóság:

• Rendelkezésre állás:

• Karbantartási igény:

• Korlátozott használhatóság:

• MTBF(Mean Time Between Failures=hibák között eltelt átlagos idő):

• MTTR(Mean Time To Repair=egy hiba utáni javítás átlagos ideje):

6. Teljesítmény (Performance)

• A hardver minimum feltételei:

• A hardver normál feltételei:

7. Támogatottság (Supportability)

8. Tervezési korlátozások (Design Constrainst)

• A fejlesztéskor felmerülő korlátok egyike az architektúrákra vonatkozó követelményekből származik. A tervezéskor figyelembe kell venni mind a termék, mind a kívánt operációs rendszer igényeit. Ilyen igények lehetnek mondjuk a grafikus kártyára és a 32 bites alkalmazásokra vonatkozó követelmények.

• A terméket x86 processzorokra szánjuk, legalábbis addig míg a megrendelő más architektúrára nem kívánja az alkalmazás megvalósítását. Ennek oka többek között az elterjedtsége.

• A fejlesztőcsapat igen sokrétű és ebből következően igen sok programozási nyelvet ismerünk. A probléma, hogy általában mindenki mást. A társaságon belül vannak tapasztalatok a Java, Delphi és PhP nyelvek terén is, bár egyenlőre nem ezek a jellemzőek, ezért a tagok közös megegyezéssel jutottak arra a döntésre, hogy C++ nyelven történjen az implementálás. Azért is tartottuk jó ötletnek mert a fejlesztőeszközöket ingyen is be lehet szerezni. Különben meg kellene venni a fejlesztőeszközöket és meg kellene várni míg megtanulunk egy új nyelvet.

• A fejlesztőeszközöket tekintve lehetnek az ingyenes Dev C++, Visual C++ valamint a Linux operációs rendszer GNU C++ compilere, és valamilyen linuxos editor.Ezek azok a fejlesztőeszközök amik rendelkezésünkre állnak. Egyébb fejlesztőeszköz beszerzésének költsége a megrendelőre hárul.

• A fejlesztés során a grafikus elemek elkészítésének és mozgatásának segítésére felhasználjuk az OpenGL kibővített grafikus könyvtárát (glut) ami szintén ingyen elérhető. Ezenfelül igénybe vesszük a standard függvény- és osztály- könyvtárt valamint minden olyan beépíthető kész kódot és osztálykönyvtárt ami rendelkezésünkre áll és hasznos lehet a fejlesztési munkában. Ezzel is elősegítve az implementálás gyorsaságát és hatékonyságát.

9. On-line dokumentáció és Help rendszer
(Online User Documentation and Help System Requirements)

Mivel a kész terméket nyílt forráskódúra tervezzük, ezért szükséges az on-line dokumentáció azok számára akik bővíteni, fejleszteni szeretnék a terméket, esetleg felhasználni azok függvény- és osztály könyvtárait saját célra. Ez a dokumentum tartalmazni fogja az általunk implementált osztályok leírását, kommunikációs interfészüket, a tartalmazott függvények paraméterlistájára és visszatérési értékeikre vonatkozó információkat, ezenfelül minden olyan feltételt aminek teljesülnie kell az egyes függvények alkalmazhatóságához. Feltüntetjük azokat az előre megírt forrásokat és származásukat is amiket segítségül hívunk a saját munkánkban.
A Help rendszer szükséges a felhasználók számára, segítségével tudják egyszerűen és gyorsan elsajátítani a játék menetével kapcsolatos tudnivalókat és a rendszer kezelését. A játék menete többek között a fejlődéshez szükséges feltételeket és a csatával kapcsolatos információkat tartalmazza. Aki nem játszott azelőtt kártyás szerepjátékokat azoknak mindenképpen jól fog jönni.
Tartalmaz egy struktúrált, részletes leírást a játék folyamán „felbukkanó„ objektumokról, azok funkcionalitásáról (Milyen szerepe van a játék folyamán, mit gyárt(ha gyárt), fejlesztése milyen új objektumok esetleg egyedek alkotását teszi lehetővé ).
Ismertetésre kerülnek az egyes menüpontok, azok funkciói és gyorsbillentyüi.(például: gyorsmentés, mentés vagy egyedek csoportjához azonosító rendelése .).

10. Felhasznált kész komponensek (Third-party Components)

A program dokumentálásához használt alkalmazások:

• OpenOffice.org 2.0.0
  A program GNU/GPL licenszes (open source ), amelyet az internetről töltöttünk le ( www.openoffice.org ).
  

• Mozilla Composer
  A Mozilla programcsomag része, amelyet az internetről szereztünk be ( www.mozilla.org ).
  
  
• Microsoft Windows XP
  A Miskolci Egyetem tanulmányi szerződése által szereztük be. E szerződés az operációs rendszer tanulmányi célokra történő felhasználását ingyenessé teszi minden hallgatónak.
  
  
• Gentleware Poseidon
  A szoftvert a http://gentleware.com honlapról szereztük be. A program kereskedelmi célokra történő felhasználása anyagi vonzattal jár, de mivel mi tanulmányi célokra használjuk, így ingyenes.
  
  

• Visual C++ fejlesztőkörnyezet
  A Miskolci Egyetem tanulmányi szerződése által szereztük be. E szerződés a fejlesztőkörnyezet tanulmányi célokra történő felhasználását ingyenessé teszi a hallgatóknak

11. Interfészek (Interfaces)

11.1. Felhasználói interfészek (User Interfaces)

• 1.CD autorun
  Funkció: megjelenik egy popup ablak amint a játék CD-t beolvassa a meghajtó.
  Menüpontok: Install,Uninstall,Readme-help,exit.
  Használandó szabvány: WinAPI használata.
  Stilus: Tank-Féreg csata háttér,start zene.
  

• 2.Install (fullscreen)
  Funkció:A játék telepitése.
  Menüpontok: Licence elfogadása,directory választás,startmenübeli hely választás,start,megszakitas,exit.
  Használandó szabvány: WinAPI,Istall Shield.
  Stilus: Sivatag-dzsungel átmenet a  statuszjelző csik irányában,start zene.
  

• 3.Uninstall
  Funkció: A játék eltávolítása.
  Használandó szabvány: WinAPI,install shield.
  Stilus: Dsungel-sivatag átmenet a  státuszjelző csík irányában.
  

• 4.Readme-Help
  Funkció: Információk,elérhetőségek.
  Menüpontok:Readme,Licence,Users manual,Kontakt.
  Használandó szabvány:HTML.
  Stilus: Az összes játékbeli menmüelem.
  

• 5.Ingame menü (fullscreen)
  Funkció: A játék beállitása,mentés,betöltés.
  Menüpontok: később részletezzük.
  Használandó szabvány: WinAPI használata.
  Stilus:  később részletezzük.

• 6. Játék képernyő
  Lásd: 3-as pont.

11.2. Hardware interfészek (Hardware Interfaces)

• A szabvány hardver csatolók:
  - egér
  - billentyűzet
  - képernyő
  - audio eszköz csatlakozók.
  

• Speciális hardver csatolók:
  - Grafikus gyorsító kártya csatoló felülete. Lásd: 11.3 pont.

11.3. Software interfészek (Software Interfaces)

11.4. Kommunikációs interfészek (Communications Interfaces)

A tervezett multiplayer funkció esetében TCP/IP. Mivel a program csak a többi ugyanilyen programmal kommunikál a hálózaton, ezért az interface dokumentálása nem szükséges. A kommunikáció socketes alapon működik( esetleg alternatív esetként http kérés-válasz formában a NAT mögül játszóknak ). A megadott ip-kre socket-et nyit a 33567-es portra ( megváltoztatható ), majd folyamatosan kommunikál.

12. Alkalmazott szabványok (Applicable Standards)

12.1. Kötelezően alkalmazandó szabványok (Mandatory Standards)

12.2. Választás alapján alkalmazott szabványok (Optional Standars)

13. Mellékletek (Appendix)

• Hivatkozás saját dokumentumokra:

• Hivatkozás más dokumentumokra: