Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- ws2021:coronasim [2021/01/13 12:53] – [Corona Sim] vondowntown
+++ ws2021:coronasim [2021/04/15 12:27] (aktuell) – [Roadmap] vondowntown
@@ Zeile 1: / Zeile 1: @@
-# Corona Sim
+# Corona Sim Wiki
-- [Corona Sim](#corona-sim)
+Because we mainly use [Gitlab](https://gitlab.com) for our code and our documentation the latest version is always [here](https://gitlab.com/labprepare/coronasim/coronasim/-/wikis/home).
-  - [Main Goal](#main-goal)
-  - [Current Work](#current-work)
-  - [Main Resources](#main-resources)
-    - [Godot](#godot)
-    - [Model](#model)
-  - [Further Reading](#further-reading)
-    - [Paper](#paper)
-    - [Other Simulations](#other-simulations)
-## Main Goal
+## Main Goal and Motivation
-Our main goal is to write a webapp, which validates and explaines different coutermeasures against covid-19 by gamification.
+The current coronavirus pandemic is impacting the living conditions of most people. Countries tried to slow the spread of the virus by implementing a variety of countermeasures. To give a better understanding on their effectiveness, we want to program a simulation game. We hope, that players will get a deeper understanding of how pandemics are spreading and how to defeat them. Hopefully, many who play our game will understand why some restrictions are neccessary in times like these.
+For our simulation we want to be as close to real life as possible. By doing so we hope to maximise the learning effect and the relatability for our players.
+## Setting
+You (the player) are a mayor of a small city during a pandemic. As a mayor you want to get reelected. For that the response to the pandemic must be adequate or else the population loses their trust in your abilities. Your relatives also live in the City and when you make bad choices, they might suffer from the consequences.
-## Current Work
+## Technical Details
-- Research
+We used Godot as our game engine, partly because it seemed easy to pick up and supports deploying the game as a website. We choosed GDScript as our language of choice, because Godot advertises GDScript (the inhouse developed ScriptLanguage) which has the best compatibility with Godot (Our initial choice was C#, but a note that the support was in beta made us switch). For information regarding the architecture of the simulation, have a look at [the Design Specification](https://gitlab.com/labprepare/coronasim/coronasim/-/wikis/Design).
-  - what tools are useful for doing such a simulator
-  - impact countermeasures have on people
+## Current State
-  - how infectious outbreaks can be modelled
+The project is (at the time of writing) heavily WIP. Therefore not all features are available and things might change. This being said, [the current version is online](https://labprepare.gitlab.io/coronasim/coronasim/).
-  - etc.
-- Course of action.
+Things that already (mostly ^^) work:
-- Setup repository for version control and project management.
-- Designed [the specification](https://gitlab.com/labprepare/coronasim/coronasim/-/wikis/Design) for the simulator.
+- generating a random map every time.
-- We started working on a first prototype and a automation for testing our code and building a release file(CI/CD system).
+- generating a random population with families where each person has their own job and home address.
-- The current status is available on https://gitlab.com/labprepare/coronasim/coronasim/-/tree/develop
+- walking across the map including houses
-## Main Resources
+## Roadmap
+There is still lots to do until we would consider the project to be in a minimum viable state. We set some Milestones to be our different versions of Prototypes, which can be found in [the Design Specification](https://gitlab.com/labprepare/coronasim/coronasim/-/wikis/Design). The second Prototype we wanted to include everything absolutely essential to deliver the core experience. After that there are still more ideas to improve upon, but (for now) that is something future us has to worry about.
+## Problems we encountered
+Working with a new programming language always has its challenges. For context, GDScript offers some support to add type hints, which can help with understanding what variables can be used in which ways. However the support is very minimal and using the feature can also lead to [Cyclical Dependency Errors](https://en.wikipedia.org/wiki/Circular_dependency), which were a headache to resolve.
+Another interesting problem is that the navigation that Godot provides does not work as expected. To give some context, the developer can specify areas where the characters will be able to walk on the map by placing polygons on the tiles.
+![The characters are only supposed to be able to walk on the light blue area.](https://gitlab.com/labprepare/coronasim/coronasim/-/wikis/Pictures/NavigationPoligon.png)
+When Godot builds the whole map by placing the tiles it can then figure out, where a person should be able to go, and how they can get there. However, in what seems to be an optimization effort, Godot ignores some of these polygons. This led to problems, because we wanted the characters to walk through the doors, however they just phased through the walls like a ghost, which, while interesting, is not something ordinary people can do.
+Working with Godot revealed that it itself is still under development and several features that might be expected in a Game Engine are simply not developed yet. This caused several problems which we had to painstakenly resolve manually.
+When making the design specification for the simulator, we knew that we wanted to use Godot, however we did not have any experience with it, so the resulting design had some places where it was incompatible with the architecture of godot. This lead to us having to redo most of the specification, which took a couple of weeks, delaying the project.
+## Lessons learned
+- Only start doing the design specification of projects once the tools that will be used are understood well enough.
+- GDScript (or immature languages in general) do not work well when trying to build complex systems.
+- Developing a game is probably worth more than 3lp. ^^
+## Further Information and useful Links:
 ### Godot
-- Godot Project Page: https://godotengine.org/
-- Documentation: https://docs.godotengine.org/en/stable/
+  - Godot Project Page: https://godotengine.org/
-- Pathfinding in a Tilemap: https://godotengine.org/qa/1790/how-to-implement-pathfinding-with-a-tilemap
+  - Documentation: https://docs.godotengine.org/en/stable/
+  - Pathfinding in a Tilemap: https://godotengine.org/qa/1790/how-to-implement-pathfinding-with-a-tilemap
 ### Model
-- Networksscience with focus on epidemics: http://networksciencebook.com/chapter/10#introduction10
-## Further Reading
+  - Networksscience with focus on epidemics: http://networksciencebook.com/chapter/10#introduction10
-### Paper
-- [Wirksamkeit nicht-pharmazeutischer Interventionen](https://gitlab.com/labprepare/coronasim/coronasim/uploads/e0ff2f07d5cb1884f5bf2e2138c5be96/Rapid-Review-NPIs.pdf)
+### Papers
+  - [Wirksamkeit nicht-pharmazeutischer Interventionen](https://gitlab.com/labprepare/coronasim/coronasim/uploads/e0ff2f07d5cb1884f5bf2e2138c5be96/Rapid-Review-NPIs.pdf)
 ### Other Simulations
-- https://github.com/cool-RR/grid_royale
-- 3Blue1Brown Simulations:
+  - https://github.com/cool-RR/grid_royale
-  - https://www.youtube.com/watch?v=gxAaO2rsdIs
+  - 3Blue1Brown Simulations:
-  - https://www.youtube.com/watch?v=Kas0tIxDvrg
+    - https://www.youtube.com/watch?v=gxAaO2rsdIs
-- https://player.vimeo.com/video/6590604
+    - https://www.youtube.com/watch?v=Kas0tIxDvrg
-- https://covid-simulator.com/
+  - https://player.vimeo.com/video/6590604
-- Gleamviz predict the future based on real world data: http://www.gleamviz.org/
+  - https://covid-simulator.com/
-- [TU COMA Homework](https://gitlab.com/labprepare/coronasim/coronasim/uploads/87e36b42135c0d2955f6d7b61826a9bd/Projekt.pdf)
+  - Gleamviz predict the future based on real world data: http://www.gleamviz.org/
-- https://isis.tu-berlin.de/course/view.php?id=18850
+  - [TU COMA Homework](https://gitlab.com/labprepare/coronasim/coronasim/uploads/87e36b42135c0d2955f6d7b61826a9bd/Projekt.pdf)
+  - https://isis.tu-berlin.de/course/view.php?id=18850