The Terasology Foundation

Tutorial - ECS

Terasology uses an entity system for just about everything, and our goal is to apply the same library to Destination Sol. While we have a decent amount of documentation on it, we don't have one of our typical tutorials-in-a-repo yet. This task includes creating the very basics of such a tutorial!

This is a task composed of three sub-tasks, since it involves creating (i) a basic ES intro, (i) a tutorial focused around events and interactions, and finally (iii) a tutorial for how to annotate your stuff right for multiplayer. So this card could probably split into 3 separate pseudo-chains each building its own tutorial.

Acceptance Criteria

  • A new module repo named "TutorialEntitySystem" (and "TutorialEventsInteractions", and "TutorialMultiplayerExtras") is created on GitHub with some sample code that works and at least one chapter in its wiki explaining the sample code
  • Include at least one screenshot in the wiki showing the example functioning

Where to start

  • We have several wiki pages already existing on the topic, such as this one or others listed in the original issue
  • Look at other tutorials like the world generation tutorial to see how a tutorial wiki and the associated sample code is lined out
  • Create a new tutorial module locally and make something super simple work! It can be as little as an UpdateSubscriberSystem printing a log statement once a second or a block you can e click to cause an action

See also

Task tags

  • terasology

Students who completed this task

PAndaContron

Task type

  • chrome_reader_mode Documentation / Training
close

2019