Google Code-in

The modularity of Terasology enables the creation of a wide range of modules. Many of them are constantly in development, with new features and bugfixes being applied. Other than engine limitations however, our main bottleneck is defining high-level designs of new or existing modules. Your task is to describe an existing module in your own words, defining its' purpose, structure, functionality and so on.

Definition of 'Done'

• A 300-500 word description of an existing module is submitted. It should cover the following questions:
  • Purpose: What is the module for? Why would players be interested in it?
  • Structure: What does the module contain? (components, systems, events)
  • Extensibility: How can the module be extended by other developers?
• You can add screenshots, diagrams, or other artifacts to the description if they help with "painting the bigger picture".

Where to start?

• Check out the Javadoc comments in the src folders of the Alchemy and Potions for examples of well-documented modules.
• You should have a look at the module's README, its JavaDoc comments, as well as the code itself to get an overview of its' intended use.