296 lines
20 KiB
HTML
296 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" data-theme="dark">
|
|
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Spearhead Tutorials</title>
|
|
|
|
<link rel="stylesheet" href="/style/prism.css">
|
|
<link rel="stylesheet" href="/style/style.css">
|
|
|
|
<script src="/js/prism.js"></script>
|
|
<script src="/js/site.js"></script>
|
|
<style>
|
|
.side-nav a.active {
|
|
font-weight: bold;
|
|
color: #4fc3f7;
|
|
}
|
|
</style>
|
|
<script type="module" src="../js/components.js"></script>
|
|
</head>
|
|
|
|
<body>
|
|
<header>
|
|
<app-header></app-header>
|
|
</header> <main>
|
|
<div class="reference-container">
|
|
<app-sidebar></app-sidebar>
|
|
|
|
<div class="content-wrapper">
|
|
<h1>Tutorials</h1>
|
|
<p>
|
|
This guide is to get you started building your first Spearhead mission. <br />
|
|
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. <br />
|
|
In the example we'll show how you can create a simple island hopping mission
|
|
</p>
|
|
|
|
<h2 id="include-the-script">Include the Script</h2>
|
|
<p>
|
|
Download the latest version of Spearhead. You can choose which version you feel comfortable with. <br />
|
|
Versions that end in -rc are not stable. Versions that do not have the "release candidate" (rc) tag are.
|
|
<br />
|
|
<a style="text-decoration: underline;" target="_blank" href="https://github.com/dutchie031/Spearhead/releases">See All releases here</a>
|
|
</p>
|
|
|
|
<p>
|
|
Then run the script in the mission. <br />
|
|
Please do exactly as it's done below. <br />
|
|
</p>
|
|
<div style="width: 100%;">
|
|
<img style="width: 100%;" src="../img/script_install.png"></img>
|
|
</div>
|
|
|
|
<note-box type="info" title="Note">
|
|
Spearhead does not require any dependencies (eg. MIST or MOOSE). Compatibility with other frameworks is
|
|
not tested at this time, so cannot be guaranteed, but there should be no conflicts if they are not
|
|
controlling the same units.
|
|
</note-box>
|
|
|
|
<h2 id="stages">Stages</h2>
|
|
|
|
|
|
<p>
|
|
So first of all think about the stages.<br />
|
|
These are logically ordered zones that will activate one by one based on the mission status in them. <br />
|
|
There is a little more to it, but you'll find out. <br />
|
|
|
|
Stages need to be named according to the convention: <span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_[OrderNumber]_[FreeForm]</span></span> <br />
|
|
The first stage will be called <span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_1</span></span> or <span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_1_EAST</span></span> for example. <br />
|
|
<br /><br />
|
|
Stages are divided in primary stages: <span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_[number]</span></span> <br />
|
|
or secondary stages: <span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_x[number]</span></span> <br />
|
|
Note the x before the number. This marks it as "extra"
|
|
</p>
|
|
|
|
<p>
|
|
For this mission we started with the three stages: <span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_1_GROUND</span></span>,
|
|
<span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_2_WATER</span></span> and <span
|
|
class="inline-lua"><span class="lua-variable">MISSIONSTAGE_1_AIRBASE</span></span> as you see in the image.
|
|
</p>
|
|
<img src="../img/starting_stages.png" style="width: 100%;"></img>
|
|
<p>
|
|
<span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_1_GROUND</span></span> will be activated when the mission starts <br />
|
|
<span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_1_WATER</span></span> will be also be activated <br />
|
|
<span class="inline-lua"><span class="lua-variable">MISSIONSTAGE_2_AIRBASE</span></span> will be activated when the player enters the zone.
|
|
<br />
|
|
</p>
|
|
|
|
<h2 id="setting-up-cap">Setting up CAP</h2>
|
|
<p>
|
|
If you don't want to use the CAP managers withing Spearhead you can skip this and continue to <a href="#setting-up-the-missions">Setting up Missions</a>. <br />
|
|
However CAP is one of the painpoints in a lot of missions and setting up a dynamic feeling airspace can be
|
|
quite the challenge. <br />
|
|
With the CAP managers we've tried to make this a lot easier. <br />
|
|
|
|
A CAP group needs to follow the following naming convention: <span
|
|
class="inline-lua"><span class="lua-variable">CAP_[A|B][CONFIG]_[Free Form]</span></span>
|
|
|
|
For details on config read this: <span class="inline-ref">CAP Group Config</span>
|
|
|
|
For now I set up 3 groups with the following names. <span class="inline-lua"><span class="lua-variable">CAP_A[1]1_Rota1</span></span>, <span class="inline-lua"><span class="lua-variable">CAP_A[1]1_Rota1-1</span></span>,
|
|
<span class="inline-lua"><span class="lua-variable">CAP_B[1]1_Rota1</span></span> <br />
|
|
The first two are marked with <span class="inline-lua"><span class="lua-variable">A</span></span> and will therefore be primary CAP units. They will be
|
|
scheduled and make up for the total count. <br />
|
|
Meaning that for this airbase there is 2 CAP units max at a time flying out. <br />
|
|
In this case all groups have <span class="inline-lua"><span class="lua-variable">[1]1</span></span> in the name, (This would be the same as <span class="inline-lua"><span class="lua-variable">[1]A</span></span>) which means
|
|
that when stage 1 is active the groups will activate and fly out to stage 1.
|
|
|
|
I also set up a few groups further back. One example: <span class="inline-lua"><span class="lua-variable">CAP_A[1-3]3_Group1</span></span>. This group will
|
|
protect zone 3 when zones 1 through 3 are active.
|
|
|
|
CAP units fly out, fly their CAP zone for x amount of minutes and will then RTB. <br />
|
|
Before they actually RTB an event is triggered 10 minutes before the actual RTB task. This event
|
|
will trigger a backup unit to startup and fly out to take over. <br />
|
|
</p>
|
|
|
|
<note-box type="info" title="Tip">
|
|
You can start a mission, speed up the simulation and make the CAP fly out to see what happens
|
|
</note-box>
|
|
|
|
<h3 id="creating-cap-routes">Creating CAP Routes</h3>
|
|
<p>
|
|
Creating CAP routes is not needed per se, but with a multi-stage stage (we have 2 stages with <span class="inline-lua"><span class="lua-variable">_1_</span></span>) it is recommended. <br/>
|
|
Similarly with huge stages. <br/>
|
|
If there is multiple zones it will "round-robin" over them. <br/>
|
|
</p>
|
|
<p>
|
|
If no CAP route is present the unit will fly a route generated differently per zone: <br/>
|
|
<span class="inline-lua"><span class="lua-variable">quad zone</span></span> => race-track between the corner closest to the origin airbase to the center point of the zone <br/>
|
|
<span class="inline-lua"><span class="lua-variable">circle zone</span></span> => race-track between the closest point on circle to the origin airbase to the center <br/>
|
|
</p>
|
|
<p>
|
|
If you want to create your own CAP Routes you can! <br/>
|
|
For this example I created 2 CAP routes inside of the 2 <span class="inline-lua"><span class="lua-variable">_1_</span></span> stages. <br/>
|
|
</p>
|
|
<p>
|
|
As you can see below there's a nice feature you can exploit. As long as the <span class="inline-lua"><span class="lua-variable">X</span></span> of the zone is inside of the the <span class="inline-lua"><span class="lua-variable">CAPROUTE</span></span> will be used for that stage!
|
|
</p>
|
|
<img src="../img/cap_routes.png" alt="CAP Routes Image" style="width: 100%;"></img>
|
|
|
|
<p>
|
|
Well, nice, we're done setting up the initial CAP effort. <br/>
|
|
If you want to change values for the CAP routes please read about how to configure it here: <a href="./Reference.html#cap-config">Cap Config</a>
|
|
</p>
|
|
|
|
<h2 id="setting-up-the-missions">Setting up Missions</h2>
|
|
<p>
|
|
Now the part where you as a mission maker can really get into the nitty gritty. <br/>
|
|
Missions are managed and monitored by Spearhead. <br/>
|
|
Statics, groups and single units all alike. <br/>
|
|
</p>
|
|
<note-box type="info" title="Note">
|
|
While static are the same as groups in this context, they are not within DCS, please refrain from artificially created static groups. A <code-inline>static</code-inline> in DCS has a 1:1 relation for group:unit. <br>
|
|
By default DCS will always keep 1 static object in 1 groups.
|
|
</note-box>
|
|
<p>
|
|
For this example I'll set up two missions. The first one is <span class="inline-lua"><span class="lua-variable">DEAD</span></span> mission and will consist of an SA-2 site with an additional "control center".
|
|
</p>
|
|
|
|
<h3 id="mission-1-dead">Mission: DEAD</h3>
|
|
<p>
|
|
As you can see on the left image the template of the SA-2 was placed. Then dragged around to only face south. <br/>
|
|
An additional track radar and search radar was added and all launchers were surrounded by sandbags. <br/>
|
|
On top of this there was a sort of control center added with walls, vehicles and some tents.
|
|
</p>
|
|
<div style="display: flex; width: 100%;">
|
|
<div style="flex: 50%">
|
|
<img style="width: 100%;" src="../img/sa2_mission_editor.png"/>
|
|
</div>
|
|
<div style="flex: 50%">
|
|
<img style="width: 100%;" src="../img/sa2_result.png"/>
|
|
</div>
|
|
</div>
|
|
<p>
|
|
Important to note. It's all inside the triggerzone <span class="inline-lua"><span class="lua-variable">MISSION_DEAD_BYRON</span></span>. Which means it's a <span class="inline-lua"><span class="lua-variable">MISSION</span></span> of type <span class="inline-lua"><span class="lua-variable">DEAD</span></span> and with name <span class="inline-lua"><span class="lua-variable">BYRON</span></span>. <br/>
|
|
At the start Spearhead will detect the triggerzone, take all units and despawn them and only spawn when needed for better performance. <br/>
|
|
</p>
|
|
<p>
|
|
The current list of mission types are:
|
|
<span class="inline-lua"><span class="lua-variable">DEAD</span></span>
|
|
<span class="inline-lua"><span class="lua-variable">STRIKE</span></span>
|
|
<span class="inline-lua"><span class="lua-variable">BAI</span></span>
|
|
<span class="inline-lua"><span class="lua-variable">SAM</span></span> <br/>
|
|
For specific differences, please check the reference page.
|
|
</p>
|
|
<p>
|
|
Each type has some additional completion logic to it. <br/>
|
|
<span class="inline-lua"><span class="lua-variable">DEAD</span></span> and <span class="inline-lua"><span class="lua-variable">SAM</span></span> missions will be marked complete when all air defences are destroyed. This includes Tracking Radars, Self tracking launchers and AAA guns if they are inside the zone. <br/>
|
|
If you want to add the Search radar or another random unit like the command tent to the target list you can add a <span class="inline-lua"><span class="lua-variable">TGT_</span></span> prefix to the unit or group you want destroyed. <br/>
|
|
Please be aware that adding <span class="inline-lua"><span class="lua-variable">TGT_</span></span> to a group will make the entire group a target and therefore each unit needs to be destroyed. <br/>
|
|
</p>
|
|
|
|
<h3 id="mission-2-strike">Mission: STRIKE</h3>
|
|
<p>
|
|
To show the power of <span class="inline-lua"><span class="lua-variable">TGT_</span></span> targets I'll create a strike mission next.
|
|
</p>
|
|
<p>
|
|
A nice supply strike mission will do. Add a ship, some containers and some additional units. <br/>
|
|
Even some SHORADS to spice the whole thing up. <br/>
|
|
In the picture below all units that are selected and who show up as white (they are actually red) have the prefix <span class="inline-lua"><span class="lua-variable">TGT_</span></span> in front of their name. <br/>
|
|
</p>
|
|
|
|
<p>
|
|
This will make it so the mission will be marked as complete when those units are destroyed. The rest of the units will exist until the entire stage is cleaned up. <br/>
|
|
</p>
|
|
<img src="../img/strike_target.png"/><br/>
|
|
|
|
<h3 id="mission-cas">Mision: CAS</h3>
|
|
<p>
|
|
A CAS mission will add an additional layer to the mission. <br/>
|
|
Whereas BAI, Strike and DEAD missions are somewhat clean, CAS missions are where the chaos starts. <br/>
|
|
<br/>
|
|
With CAS missions an additional BattleManager will be activated. <br/>
|
|
This BattleManager will scan for units and force them to fire at other units in the zone. <br/>
|
|
Great efforts are made to make AI miss. In the end we want players to be they key factor to mission success. <br/>
|
|
If AI do seem to be hitting more than 1 or 2 unfortunate targets, it is most likely you either have another script controlling the units, or you have placed the units too staggered. <br/>
|
|
Please make sure to also read the "Notes" section below the image. <br/>
|
|
|
|
<img src="../img/cas_mission.png" style="width: 100%;"></img>
|
|
|
|
Notes: <br/>
|
|
<ul>
|
|
<li>
|
|
AAA units will sometimes also follow their lead and fire at targets on the ground.<br/>
|
|
They will however always prioritize AIR targets as at that point they have a threat themselves and won't follow their lead's targets. <br/>
|
|
If you really don't like this, it's best to put the AAA units in a separate group.
|
|
</li>
|
|
<li>
|
|
Units will purposely aim past a target. <br/>
|
|
This simulates a fight, but doesn't actually do anything, so the player is the only person that can complete a mission. <br/>
|
|
Be aware that if you stagger groups too much, shooting past a target might hit another. <br/>
|
|
Best would be to always test it. <br/>
|
|
You can also enable debugging. <br/>
|
|
This will draw all boxes and lines. <br/>
|
|
NOTE: Keep DEBUG disabled on an actual mission.
|
|
</li>
|
|
<li>
|
|
When you want AI to shoot through gaps a distance of approx 150ft is required between the two outer units. <br/>
|
|
These gaps will be automatically detected and can even exist within a group itself. <br/>
|
|
</li>
|
|
<li>
|
|
Line of sight is important, dependent on which type of unit. <br/>
|
|
Units won't shoot when they can't fire at a certain point. <br/>
|
|
As a mission editor it's up to you to set the range, line of sight and cover. <br/>
|
|
</li>
|
|
<li>
|
|
As Performance is something that's on any multiplayer mission maker's mind, this is a very optimised way.
|
|
AI does not have to know, scan, priorise targets every second. <br/>
|
|
It does not really have to think or move. <br/>
|
|
Ofcourse, there is a balance and too many can be too much. <br/>
|
|
For now it has been tested with 60+ units in 3 seperate CAS zones active at a time. <br/>
|
|
No performance degradation was seen at all. <br/>
|
|
</li>
|
|
</ul>
|
|
|
|
</p>
|
|
|
|
<h2 id="mission-briefings">Mission Briefings</h2>
|
|
<p>
|
|
So now we've created some missions we also want to add briefings to them. This is pretty easy with Spearhead. <br/>
|
|
</p>
|
|
<p>
|
|
To do so click on <span class="inline-ref">draw</span> on the left hand pane in the mission editor. This opens up the drawing tools in the editor. <br/>
|
|
On the right click <span class="inline-ref">TextBox</span> and click somewhere inside the zone to which you want to add the briefing. <br/>
|
|
Give the briefing a name (It's not used, but can be nice to use to reference the briefing later) and add the briefing. <br/>
|
|
The text box is quite small, but can have a lot of text. Easiest is to edit the text in an editor of choice and paste it into the box afterwards. <br/>
|
|
</p>
|
|
<p>
|
|
Keep the binding layer to "Author" only. That way it doesn't show up for anyone other than in the mission editor.
|
|
</p>
|
|
<p>
|
|
See the two images below. The left shows the <span class="inline-ref">Text Box</span> drawing. The right shows the briefing as shown in the mission.
|
|
</p>
|
|
<div style="display: flex">
|
|
<div style="flex: 50%">
|
|
<img src="../img/briefing_me.png"/>
|
|
</div>
|
|
<div style="flex: 50%">
|
|
<img src="../img/briefing_mission.png"/>
|
|
</div>
|
|
</div>
|
|
<p>
|
|
We are now done creating a first mission. Hit fly and test it. <br/>
|
|
Check all references for way more features and keep up to date with the latest changes as they come along! <br/>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
</main>
|
|
<footer>
|
|
<p>© 2025 Spearhead Project</p>
|
|
</footer>
|
|
</body>
|
|
|
|
</html> |