Documentation

Report Layout

This page describes the layout of the report files that OttoMap reads. The current version of the report files is 899-12.

Version 899-12

The report layout changed with the reboot of TribeNet, starting with turn 899-12. OttoMap doesn't support older versions of the report files.

Report files are line-oriented; each line is a single record that provides some information about the turn.

Reports are split into sections. Every unit that the tribe has is given their own section. The sections are ordered by the tribe's number, starting with the clan. OttoMap will not accept a report file that doesn't start with the clan's section.

There are many types of records in each section, but OttoMap only cares about the following:

  • Unit Location
  • Current Turn
  • Unit Movement
  • Scout Results
  • Unit Status

All other records are ignored. (Newer versions of the report parser don't even save those records.)

The Unit Location is required for each and every unit in the report file. The Current Turn is required for the clan's section. All other records are optional.

Unit Location

UnitID , UnitName , CurrentHex , ( PreviousHex )

The Unit Location is the first record in every unit's section of the report. It looks like:


Tribe 0987, , Current Hex = ## 0507, (Previous Hex = ## 0507)

UnitID

Tribe UnitNumber Courier UnitNumber c digit Element UnitNumber e digit Fleet UnitNumber f digit Garrison UnitNumber g digit

This field is required.

The UnitID Field consists of the unit type (Tribe, Courier, Element, Fleet, or Garrison) followed by the four-digit unit number. Non-tribe units have a suffix after the unit-number.

The clan's unit number always starts with a zero, e.g. 0987.

The suffix is required for Courier, Element, Fleet, and Garrison units. It is a single character (c, e, f, or g) followed by a number from 1 to 9. The character must math the type of unit (Courier, Element, Fleet, or Garrison).

It is an error if the Unit ID doesn't match; this will cause OttoMap to ignore the entire section.

Examples for this field are Tribe 0987, Courier 0987c3, Element 1987e1, Fleet 6987f1, and Garrison 1987g1.

WARNING: If there are issues with this field, OttoMap will not realize that the unit is in the report file. All the records for the unit will be ignored or assigned to the prior unit. That is very likely not what you want.

Unit Name

This field is optional and is ignored by OttoMap.

Current Hex

Current Hex = Grid ## Hex

This field is required.

The Current Hex field is the location that the unit ended the turn in.

The grid in the location will be "##" for turns prior to 901-07. The reboot of TribeNet obscured hex grids for several turns.

Previous Hex

Previous Hex = ## Grid Hex N/A

This field is required.

The Previous Hex field is the location that the unit started the turn in.

The grid in the location will almost always be "##." It will be obscured even after turn 901-07. There are plans to fix this in the future.

OttoMap made a mistake in its first release and started plotting the unit's movement from its starting location. That has caused problems for some players because sometimes that location isn't known. When the grid id is obscured (e.g. "##"), OttoMap will guess the starting grid based on the location of the unit's parent. That's not a great guess, but it's better than nothing.

Sometimes the Previous Hex will be "N/A." This means that the TribeNet engine did not record the previous location. That's bad news. OttoMap will have no idea where the unit started the turn and be unable to plot the unit's movement. There's nothing OttoMap can do about that; you must edit the report file and enter the correct location.

Current Turn

This section is required for the Clan and is optional for the remaining units.

Current Turn 900-01 (#1), Spring, FINE	Next Turn 900-02 (#2), 12/11/2023

The record is for Courier, Element, Fleet, Garrison and non-clan Tribe units. If present, the Next Turn and Report Date fields are omitted. It should be ignored, but if it is present, OttoMap will report an error if the turn number is not the current turn.

Current Turn 900-01 (#1), Spring, FINE

Unit Movement

This section is optional.

Tribe Movement

Fleet Movement

Tribe Follows

Tribe Goes To

Scout Result

This section is optional. Most units have no scouts and some units (e.g. Fleets) are not allowed to have scouts. OttoMap doesn't care; if the section has any scout result, OttoMap will plot it.

Unit Status

This section is optional.