| blob | 6213f6c395da2196a46650a9eab3f11fdbd70134 |
1 #+TITLE: Spec/plan laboration 4, apjava
2 #+AUTHOR: Anton Johansson, Andreas Jacobsson
3 #+EMAIL: anton.johansson@gmail.com
4 #+DATE: 2008-12-08 Mon
6 * Frågor
7 ** DONE Trådar
8 Vad skulle fördelen kunna vara med att försöka sätta varje Unit i
9 en separat tråd? Vad blir mest beräkningstungt, att göra massa
10 saker i samma tråd mot att hantera varje enhets logik separat?
12 *** Svar: Vi väljer inte separata trådar för varje enhet, detta eftersom det verkar bli mer problem.
14 ** TODO Statiska metoder vs andra
15 Hur ska man på ett bra sätt implementerar Builder/Factory klasser?
16 Vad är fördelen/nackdelen med att dessa enbart innehåller statiska
17 metoder om så är möjligt.
19 * Thinking sessions
20 ** Första
21 CLOCK: [2008-12-10 Wed 20:30]--[2008-12-11 Thu 00:36] => 4:06
23 *** Klasser
24 - Item <|- Health, Teleport, SpeedBoost, Guns 'n' ammo.
25 - Square <|- Stone, Savanna, Road. Idé, varje Square har en
26 instans av Javas Rectangle för att kunna använda dess intersects
27 metod.
28 - Road <|- Sand, Ice.
29 - Intersection en Item? Ett sätt att välja väg vid
30 flervalskorsningar.
31 - Map, JComponent?
32 - Model håller koll på alla enheter.
33 - Controller, The allseeing eye, säger till varje enhet att
34 uppdatera sig själv.
35 - View, ritas upp för varje fram. Kontroller meddelar när det är
36 dags, data hämtas från Model.
37 - Poängräkning skulle kunna ske i separat tråd som sover
38 specificerat antal millisekunder för att sedan vakna upp och
39 räkna av antalet enheter på plan.
40 - Player, synchronized score!
42 *** Interface
43 - Ett interface för att se till att allt som behöver det har en
44 =intersects()= metod för att testa om den överlappar annan klass
45 som implementerar samma interface. Främst för Unit.
47 *** Logik
48 Squares extends JComponent, Observable (Towers ska vara Observers),
49 Units meddelar rutor att de befinner sig i dem. Towers får då en
50 referns till aktuell Unit och lägger denna i en lista för
51 beskjutning.
53 Anledningen till något typ av arv av JComponent är att
54 vi vill ha metoden getComponentAt(Point) från en högre nivå (Map av
55 typ JComponent?) för att Units ska kunna veta vilken ruta de
56 befinner sig på.
58 *** Kartor XML
59 : <map>
60 : <row>
61 : <square type="stone"/>
62 : <square type="road">
63 : <item type="health"/>
64 : </square>
65 : </row>
66 : </map>
68 *** Collision detection
69 Varje Unit kollar om den intersectar med någon annan Unit innan
70 den rör sig. Om den gör det så minskar den flytten tills den
71 hittar en flytt som inte intersectar med någon Unit.
73 *** Flytt av Unit
74 1) Unit leter upp rutan den befinner sig i: Frågar map (JComponent
75 getComponentAt(Point?))
76 2) Fråga ruta om aktuell speedFactor, för att modifiera sin
77 hastighet. 1 är standard, 1 * UnitSpeed.
78 3) Unit meddelar sin ruta att den befinner sig där, Obervable
79 ruta. Rutan meddelar Tower, Tower sparar Unit i kö. Se [[*Logik]]
80 4) Unit har en tidsenhet som intervall på hur ofta den får göra
81 förflyttningar, detta representerar hastighet. Unit tidstämplas
82 vid varje flytt med aktuell tid i millisekunder. Vid nästa flytt
83 kollar den så att satt tidsintervall har förflutit.
84 5) Enumeration håller koll på riktning.
85 6) Se [[*Collision%20detection][*Collision detection]]
87 - Vi använder XMLSchema.
89 *** TODO Till nästa gång
90 **** TODO Ta reda på hur vi svänger i kurvor.
91 **** TODO Metoderna intersects och contains.
92 **** TODO Easter eggs?
94 ** Andra
95 CLOCK: [2008-12-11 Thu 16:07]--[2008-12-11 Thu 19:06] => 2:59
97 *** Path <|- Turnpath
98 Hela Canvas har en mouseListener som lyssnar på musklick, dessa
99 koordinater kollas mot matris för spelplanen och objekt som finns
100 där returneras, Object instanceof Turnpath ger ändring i sväng.
101 *** Flyweight pattern för rutor?
102 *** En matris för spelplanen
103 Spelplanen vet koordinater för varje ruta, Units kan fråga
104 spelplanen efter ruta för aktuell koordinat!
106 *** DoubleBuffering
107 Skapa en instans av bakgrundsbild att rita hämtas till en instans
108 av BufferedImage för att rita upp gubbar på för varje
109 uppritning. Clear Canvas, rita upp BufferedImage och vipps så är
110 där DoubleBuffering.
112 *** Animationtråd
113 Tården kan se ut så här:
114 : while(running) {
115 : for (Unit unit : units) {
116 : unit.update();
117 : }
118 : for (Unit unit : units) {
119 : unit.paint(Graphics g);
120 : }
121 : }
122 *** Gränssnitt
123 Tänk på att knappar kan vara bilder.
124 *** Ett Game
125 - Nytt game startas, spelare finns redan.
126 - Karta skapas
127 - Pengar ges
128 - Poäng är noll
129 - Torn placeras
130 - Game on!
132 *** Levels.xml
133 - Levevels.xml Innerhåller information om hur banan ska byggas
134 upp.
135 - LevelStyle.xml innerhåller information om vilka bilder som hör
136 ihop med vilka ban-element.
137 - UnitStyles.xml innehåller information om vilka bilder som hör
138 ihop med vilka Units.
140 * Working sessions
141 ** Första
142 CLOCK: [2008-12-14 Sun 14:00]--[2008-12-14 Sun 20:36] => 6:36
143 *** DONE Animerade Units
144 Units förflyttar sig över skärmen, statisk bakgrundsbild ligger
145 kvar, är detta dubbelbuffrat?
146 *** DONE Början på hela programmets struktur.
148 ** Andra
149 CLOCK: [2008-12-15 Mon 14:15]
151 * Om spelet
152 Ett Tower Defence-spel är ett spel i vilket användarens uppgift är att
153 skydda sig mot fiender genom att sätta upp torn. Dessa torn ska sedan
154 skjuta ner fienden innan de når ett givet mål, och tornen måste
155 således placeras ut strategiskt.
157 För att göra spelet intressantare brukar det krävas att en viss mängd
158 fienden tar sig i mål för att man ska förlora, och det kan finnas
159 flera sorters fiender och torn (flygande och markgående fienden etc.).
161 * Spelets regler
162 - Att släppa ut trupper ska kosta valuta (nedan kallat kredit), och
163 spelaren får ett antal krediter tilldelade varje bana. När dessa
164 är slut kan inga trupper köpas, och spelaren förlorar om de
165 trupper på banan inte tar sig i mål och ger upphov till vinst.
166 - Vinst är när ett visst antal "målkrediter" tjänats. Detta brukar
167 bara vara ett antal truppmedlemmar, men kan mycket väl viktas med
168 deras hälsa när de kommer in i mål.
169 - Krediter tjänas på något sätt under banans gång, förslagsvis en
170 viss krediter/sekund för varje truppmedlem, samt en viss mängd
171 krediter vid målgång.
172 - Fienden behöver inte vara smarta. Det räcker med att de väljer en
173 varelse inom räckhåll och skjuter på den.
174 - Fienden får ha endast laser (ljusstråle som träffar direkt så ni
175 slipper beräkna en projektils bana).
176 - Utplacering av tornen som skjuter på trupperna behöver endast
177 placeras ut slumpmässigt i tillåtna zoner.
179 * Laborationen
180 Laborationen ska lösas i grupper om 2 (två) personer. Det ses från vår
181 sida som en näst intill omöjlig uppgift att göra laborationen enskilt
182 under kursens gång, därför finns det inga undantag. Parindelningen är
183 upp till er att fixa, men alla grupper ska anmäla sig på denna
184 sida. Vet ni inte om någon att jobba med så skriv in er i en ny grupp
185 , eller om det redan finns en grupp med bara en person så skriv in er
186 i den och kontakta så snart som möjligt personen som redan stod där om
187 att du vill jobba med honnom/henne.
189 Målet med spelet är att skapa en bas för utbyggnad av
190 funktionaliteten. Därför är det väldigt viktigt att ni lägger stor
191 möda på spelets interna struktur för att få en lättnavigerad kodbas
192 med logisk uppbyggnad. Dokumentationen är väldigt viktig den med,
193 vilket innebär att samtliga klasser, samtliga metoder samt
194 medlemsvariabler ska kommenteras med utförliga
195 JavaDoc-kommentarer. JavaDoc är dock inte den enda typen av grundlig
196 dokumentation som krävs, se nedan. Syfte
198 * Syftet med laborationen är att få pröva på och använda:
199 - Trådar
200 - XML / DTD / XMLSchema
201 - GUI (Swing)
202 - Grafik
203 - Öva färdigheten i rapportskrivning med en specifik målgrupp
204 - Följa en given kodkonvention
206 * Er uppgift
207 Er uppgift är inte att implementera ett Tower Defence-spel, utan ett
208 Anti-Tower Defence-spel. Ni ska alltså låta användaren skicka ut
209 fienden som sedan datorn ska skjuta ner. Ett exempel på ett sådant
210 spel är: [[http://www.sugar-free-games.com/playgame.php%3Fgame%3D1127][Anti-TD]] på Sugar Free Games.
211 ** Kravlista
212 För att göra spelet mer intressant ut laborationssynpunkt finns det
213 en del krav på er lösning:
215 *** I alla nivåer gäller:
216 **** TODO Implementera spelet AntiTD i Java
217 **** TODO Följa SUN:s kodkonvention: http://java.sun.com/docs/codeconv/index.html
218 **** TODO Följa god OO- och MDI-stil.
219 **** TODO Källkoden skall ligga i katalogen
220 : ~/edu/apjava/lab4/src/
221 **** TODO En komplierad version i katalogen
222 : ~/edu/apjava/lab4/bin/
223 **** TODO Rapporten skall ligga i katalogen
224 : ~/edu/apjava/lab4/report/
225 **** TODO JavaDoc-sidorna skall ligga i katalogen
226 : ~/edu/apjava/lab4/doc/
228 *** TODO Nivå 1 (grundnivå)
229 **** TODO Klassen "AntiTD"
230 Startar ett Anti Tower Defence-spel utan att ta emot några argument från användaren.
231 **** TODO Trådar
232 Spelet ska använda sig av flera trådar för att låta flera delar jobba parallellt.
233 **** TODO Uppdateringsintervall
234 Spelets uppdateringsintervall skall vara tidsberoende och inte
235 beroende av datorns hastighet.
236 **** TODO Banor
237 Det ska finnas minst en bana längs vilken man kan skicka ut
238 trupper.
239 **** TODO Vinst/Förlust
240 Vid "vinst" eller "förlust" så ska användaren presenteras med
241 valet om att spela igen eller avsluta spelet. Medans detta val
242 pågår så ska inte användaren kunna göra nåt annat, men objekt på
243 spelplanen ska fortsätta röra sig.
244 **** TODO GUI:t skall använda sig av Swing-biblioteket.
245 **** TODO Rendering
246 All rendering skall ske dubbelbuffrat för att undvika flimmer.
247 **** TODO Det ska finnas minst två huvudmenyer:
248 - En meny med valen:
249 + New Game/Restart
250 + Om inget spel har startats så heter menypunkten tex. "New
251 Game" och vid klick så startar den ett nytt spel. Om spelet
252 redan är igång så ska menypunkten heta tex. "Restart" och
253 spelet börjar om från början.
254 + Pause/Resume
255 + Menypunkten kan tex. heta "Pause" om spelet är igång och
256 när man klickar på menypunkten så ska alla trupper och torn
257 stanna och inga knappar ska gå att klicka på. Om spelet är
258 i "Pause"-läge så ska menypunkten byta namn till
259 tex. "Resume" och vid klick så ska spelet återupptas där
260 det sist var, dvs. fordonen skall fortsätta röra på sig
261 samt att användaren kan skicka ut fler trupper.
262 + Mute
263 + Sluta spela upp ljud. Då den här menyn väljs ska
264 menyalternativet bytas till "Unmute" och vice versa.
265 + Quit
266 + Avsluta spelet.
267 - Den andra menyn ska innehålla:
268 + About: Berättar i en dialogruta vem som gjort spelet och när.
269 + Help: Berättar i en dialogruta hur man spelar.
270 **** TODO Zoner i banor
271 Varje bana skall innehålla zoner där datorn kan placera ut torn,
272 vägar längs vilka trupper kan röra sig.
273 **** TODO Grupptyper
274 Minst två typer av trupper ska implementeras med olika förmågor
275 (klarar olika antal träffar, kostar olika mycket, har olika
276 hastighet, etc.).
278 *** TODO Nivå 2 (multipla banor/XML)
279 **** TODO Flera banor
280 Spelet ska klara av flera banor. Banorna ska se olika ut,
281 exempelvis hur trupperna kan röra sig.
282 **** TODO Spara banor i fil levels.xml
283 Flera banor skall lagras i en fil som heter
284 "levels.xml". XML-formatet skall följa en DTD som ni själva
285 specificerar. XML-filen skall valideras mot den DTD (eller XML
286 Schema) ni skriver.
287 **** TODO Banzoner
288 Varje bana skall innehålla zoner där datorn kan placera ut torn,
289 vägar längs vilka trupper kan röra sig, samt regler för banan,
290 exempelvis hur många trupper som måste komma igenom för att
291 användaren ska vinna. Allt detta ska stå i XML-filen under varje
292 bana.
293 **** TODO Vinst/förlust
294 När användaren "vinner" en bana så skall spelet fråga användaren
295 om den vill spela samma bana en gång till eller fortsätta till
296 nästa bana.
297 **** TODO Restart level
298 Den första menyn ska byggas ut med alternativet "restart level".
299 **** TODO Flera vägsträckor per bana
300 Det ska finnas (möjlighet till, samt exempel på) flera möjliga
301 vägsträckor per bana för trupperna.
302 **** TODO Spara resultat till Highscoreservice
303 Alla resultat ska sparas med hjälp av det ni gjorde i
304 lab 3. Highscores ska kunna visas (baserat på tid, poäng, nivå,
305 etc.).
306 **** TODO Parameter som anger levels.xml vid start
307 Ges ett argument vid körning ska detta tolkas som ett filnamn och
308 läsas in istället för levels.xml och på så vis kan fler banor
309 göras och köras utan att modifiera i spelets katalog.
311 *** TODO Nivå 3 (triggers / jar)
312 **** TODO Triggers, vägpekare i vägskäl?
313 Banor ska kunna innehålla (och det ska finnas exempel på banor
314 som innehåller) "växlar" som gör att en väg kan mynna ut i en
315 T-korsning där spelaren klickar på ex. en knapp för att välja åt
316 vilket håll trupperna ska gå.
317 **** TODO Skapa ett interface som har en metod "landOn".
318 **** TODO Banklasser implements landOn
319 De olika områdena på en bana skall finnas i egna klasser. Varje
320 sådan klass kan implementera interfacet beskrivet ovan.
321 **** TODO Läsa in class-filer från XML?
322 Vid start av en ny bana så skall programmet läsa in de
323 class-filer som XML-filen har deklarerat som sina områden och när
324 truppmedlemmarna går på ett visst område så ska denna
325 områdesklass funktion "landOn" anropas och någonting skall hända,
326 förutsatt att den implementerat ovan nämnda interface.
327 **** TODO Områden, ex Teleporters
328 Ett speciellt område utöver de beskrivna hittills skall
329 finnas. Tex: Teleporters, när en truppmedlem går på en viss ruta
330 så flyttas den till en annan på vägen.
331 **** TODO Teleportertrupper
332 Teleportertrupper ska implementeras som kostar mer, men ska kunna
333 lägga ner teleporterplattor när användaren väljer, och på så vis
334 kommer trupperna att kunna slippa förflytta sig lika långt.
335 **** TODO Spelet sparas i AntiTD.jar
336 Spelet samt de filer som behövs för grundspelet skall finnas i en
337 JAR-fil som heter "AntiTD.jar". Spelet ska startas med kommandot:
338 java -jar AntiTD.jar
340 * Redovisning
341 Den här laborationen har inte bara ett fungerande system som mål, utan
342 den ska även vara en bas för vidareutveckling. Därför ska den visas
343 upp för en fiktiv kund som ska köpa spelet av er för en stor hög
344 pengar. Därför är det viktigt att ni gör bra ifrån er på både spelets
345 uppvisning, och dokumentationen som ska lämnas in.
347 ** Milestone DEADLINE: <2008-12-18 Thu 15:00>
348 Innan jul ska ni boka in er för ett tillfälle hos handledarna för
349 att redovisa projektets framskridande. Vid detta möte bör delar av
350 programmet vara implementerat och ni bör kunna redovisa en plan (i
351 form av följande dokument) för hur arbetet ska fortskrida fram till
352 de olika redovisningstillfällena. Ni kommer att kunna boka in er
353 för denna redovisning 18/12 mellan 15-17. Bokning av tid kommer att
354 kunna ske senast veckan innan (info om detta kommer via mail). Om
355 ni av någon anledning vet att ni ej kan delta vid detta tillfälle
356 så hör av er till handledarna i förväg så kan redovisningen
357 genomföras vid något tidigare tillfälle.
359 ** Uppvisning (promotion) DEADLINE: <2009-01-13 Tue>
360 Samtliga lösningar ska visas på gruppövningen den 13e
361 januari. Ungefär 10 minuter per grupp ges. Tar uppvisningen för
362 lång, eller för kort tid, minskar intresset från kunden. Hjälpmedel
363 ni har att tillgå är: OH-apparat, ... Mer info kommer senare.
365 ** Fysisk inlämning av dokumentation
366 Det som i normala fall brukar vara en rapport om själva utvecklandet
367 kommer på den här laborationen ha en annan uppgift.
369 Utöver dokumentationen av programmet så ska ni även lämna in en
370 detaljerad beskrivning av vem som gjort vad i projektet. Detta för att
371 individuell poängbedömning ska kunna göras (var nogrann med
372 denna). Denna del ska ges som en bilaga till rapporten. Till exempel
373 kan en uppdaterad version av dokumentet från milestone tillfället
374 ingpå. Observera att det inte räcker med en mening där ni säger att ni
375 båda varit inblandade i allt och gjort lika mkt (lite mer detaljnivå
376 krävs).
378 * Programdokumentation DEADLINE: <2009-01-13 Tue 15:15>
379 Dokumentation av arbetet ska vara inlämnad senast Tisdag 13/1-09
380 15:15 Den största vikten i rapporten ligger på hur systemet är
381 uppbyggt. Vilka delar ska modifieras för att olika effekter ska
382 uppnås. Här hör ett eller flera UML-diagram hemma,
383 algoritmbeskrivningar i grafisk form, etc.
385 Tänk på att den här delen ska fungera som referenslitteratur. Det
386 ska alltså inte vara uppsatser, utan listor, bilder, grafer,
387 tabeller, träd, etc. Små textstycken behövs med, men en
388 beskrivningar i uppsatsform är inget alternativ.
390 * Bedömning
391 Rapporten kommer betygsättas utifrån dels utseende (teckensnittsval,
392 marginalbredd, sidnumrering), innehåll (styckeuppdelning, förlopp, hur
393 lätt det är att slå upp saker i den), informationsförmedling (vad
394 berättas i rapporten), och slutligen kommer även stavfel,
395 särskrivningar, meningsbyggnadsfel och språkblandningar in i bilden.
397 JavaDoc-sidorna kommer gås igenom och deras innehåll kommer bedömas.
399 Javakoden kommer synas så den följer konventioner och "bra"
400 programmeringsstil. Ex. på mindre bra programmeringsstil är:
402 : if (a.getP() < 4)
403 : return false;
404 : else
405 : return true;
407 En helhetsbedömning av bl.a. ovanstående kommer poängsätta rapporten,
408 kodens dokumentation, redovisning och källkoden. Resultatet kommer
409 bli: Nivå Poäng 1 0 - 7 2 0 - 14 3 0 - 20
411 Dokumentationen kommer stå för runt 1/3 av den totala poängen, så glöm
412 inte att lägga ner tid på den.
414 OBS: Poängsättningen av labben kommer att ske på den först inlämnade
415 versionen. Fel som ger O på labben kommer givetvis att bidra till att
416 minska poängtalet rätt rejält.
418 * Ev otydligheter i specifikationen
419 Är något otydligt i specifikationen så är det upp till er att klargöra
420 vad som gäller. Redovisa även sådana klargörande i rapporten.