AntSim icon indicating copy to clipboard operation
AntSim copied to clipboard

Create a tutorial

Open cpetry opened this issue 8 years ago • 3 comments

The tutorial should have a introduction to quickly give an overview of what AntSim is. (About page?!) Then afterwards have the following topics:

  1. Finding food (walking towards it)
  2. Harvesting food (and bringing it home).
  3. Different genes (introducing "worker ants" which can harvest better) and using pheromones to guide them towards food
  4. How to deal with enemys (guide some "fighters" towards a spider.

Every step of the tutorial should build upon the predecessor. The user-code should then in the end have most of the important topics implemented and should be (kind of) ready for real simulations.

cpetry avatar Jul 18 '17 05:07 cpetry

As the code is modular it is possible to create small interactive tutorials inside the jsdoc user documentation. To be able to pull this off though, the use of require js would seem a good approach ( yeah @akatzmann you were right 😀 ). Instead of including all script files in the index.html, each js file should then require files needed for and in its class.

cpetry avatar Jul 30 '17 17:07 cpetry

The first two tutorials are nearly finished. The approach described above works great.

cpetry avatar Aug 04 '17 09:08 cpetry

"Pheromones" and "attack" are left. After these two have working examples and tutorials, this issue may be closed.

cpetry avatar Aug 14 '17 17:08 cpetry