Journal: Naming Conventions
This page covers our internal naming conventions for quests, subquests, objectives, steps, and markers. We recommend adhering to these conventions to maintain an organised and intuitive journal.
Overview
These are naming conventions in script, not player-facing text. In general:
- Keep names as short as possible.
- Don't use definitive articles and prepositions (
the,of, etc.). - Don't use redundant or already-implied words.
- Try not to use terms and names that are placeholders or may change in the future to avoid having to rename them later.
Quest ID
The Quest ID is the quest's name and is globally unique.
Format: <RegionPrefix>_<SituationDesignName>
Example: GAL_WaterShortage
Subquest ID
The Subquest ID descriptor doesn’t have to be globally unique. The descriptor should be the main topic of the subquest. It's typically a noun or a verb.
Format: <ParentQuestID>_<SUB>_<Descriptor>
Example: GAL_WaterShortage_SUB_Lockdown
Objective ID
For the Objective ID, use the present tense as the objective is what needs to be done next. Closing objectives need a little extra formatting to ensure they're handled correctly.
Format: <QuestID/SubquestID>_<StepToTake>
Closing objective format: <QuestID/SubquestID>_COMPLETION
Example: GAL_WaterShortage_SUB_Lockdown_COMPLETION
Step ID
For the Step ID, use the past tense to describe the step taken.
Format: <Optional region/function>_<StepTaken>
Example: LandedSafe
Marker ID
Most markers are named after the object they are pointing to. The goal for Marker IDs is to reduce the amount of duplicates since the same marker may be used in several quests. This applies to most location markers and quest markers.
Some markers are quest-exclusive. If your marker should be used only in your situation and shouldn't makes sense in another situation, it needs to be quest-exclusive. This applies to most secret markers too.
Normal marker: <objectname>
Exclusive marker: <QuestID/SubquestID>_<Descriptor>
Area marker: <QuestID/SubquestID>_<Descriptor>_Area
