Files
spearhead/docs/GetStarted.md
T
2024-09-26 21:13:32 +02:00

2.1 KiB

Spearhead

Get Started

This guide is to get you started building your first Spearhead mission.
Spearhead was created to enable the mission maker to worry as little about the running, timing and scripting and most about the setting and looks and feel of the mission.

In the example we'll show how you can create a simple island hopping mission

Include Script

Firstly include the script. TODO: include link to release.

Stages

So first of all think about the stages. Read the details about them here: Stages
These are logically ordered zones that will activate one by one based on the mission status in them.
There is a little more to it, but you'll find out.

Stages need to be named according to the convention: MISSIONSTAGE_<OrderNumber>_<FreeForm>
The first stage will be called MISSIONSTAGE_1 or MISSIONSTAGE_1_EAST for example.

For this mission we started with the three stages: MISSIONSTAGE_1_GROUND, MISSIONSTAGE_1_WATER and MISSIONSTAGE_2_AIRBASE as you see in the image.
drawing

In this example _GROUND and _WATER stages will be actived at the start of the mission.
_AIRBASE will however not be activated since the order number is 2
MISSIONSTAGE_3 will be used as part of this example as well. It's a stage even further away.

Setting up CAP

If you don't want to use the CAP managers withing Spearhead you can skip this and continue to setting up the missions.
However CAP is one of the painpoints in a lot of missions and setting up a dynamic feeling airspace can be quite the challenge.
With the CAP managers we've tried to make this a lot easier.

A CAP group needs to follow the following naming convention: CAP_<A|B><CONFIG>_<Free Form>

For details on config read this: CAP Group Config

drawing drawing

Setting up the missions