====== User Guide ======

This is currently a very brief note on how to use the software.

===== Creating Sectors =====

Creation of sectors is handled by the uk.org.glendale.rpg.traveller.sectors.Sector class. The only way to configure this is currently by editing the code.

It will create a new sector, and populate it with stars and planets. The planets will be uninhabited.

Alternatively, sectors can be generated from UWP data. See the page on [[data import]] for details. Such sectors will have populated worlds if the UWP data includes this.

===== Populating Worlds =====

**Class:** uk.org.glendale.rpg.traveller.civilisation.Empire

To populate worlds, use the above class. This takes a sector, and finds all uninhabited systems and tries to stick a colony on them.

===== Creating Maps =====

**Class:** uk.org.glendale.rpg.traveller.worlds.WorldBuilder

To create world maps, use the WorldBuilder class which can be used to create a world map, and a 3D globe, and stick them in the database.

Creation of 3D globes requires the Java3D APIs to be installed.