In one minute
This assumes a server set up as in Host a dedicated server, and writes commands as that guide does: project-reclaimer dedicated …, run in the server folder.
-
Copy the campaign's files
On a PC with the game, fill the server folder from your own installation. Here Halo 3's campaign and Halo: CE's; what each game needs is below:
Shell
project-reclaimer dedicated init . --from "your game's folder" --maps campaign,halo1-campaign -
Give a server one
campaignline Indedicated.toml, in place of the server'splaylist,variantormapandgame:dedicated.toml[[server]] name = "Combat Evolved Co-op" port = 49176 max_players = 4 campaign = { campaign = "halo1", mission = "a10", difficulty = "heroic" } -
Check, then start
Shell
project-reclaimer dedicated check project-reclaimer dedicatedchecksays which mission the line was found to be, such as Mission: The Pillar of Autumn of Halo: Combat Evolved, or why it was refused, with the names it could have been.
To see everything the server can host, with the exact names to write, ask it. Words narrow the list:
project-reclaimer dedicated content # everything
project-reclaimer dedicated content autumn # what matches a word
Players find the server in the Server Browser, or join it by address, as they join any co-op lobby: see campaign servers in the player guide.
The campaign line
campaign = { campaign = "halo1", mission = "a10", difficulty = "heroic" }
| Field | What it is | Left out |
|---|---|---|
mission | The mission the server starts from: its file's name, its title or its number. See naming. | Required |
campaign | Whose mission it is: a game's key or a mod's campaign's title. | The campaign the mission is found in |
difficulty | "easy", "normal", "heroic" or "legendary". | "normal" |
insertion | The first mission's start (rally point), 0 for its beginning. | 0 |
modifiers | Skulls, scoring, sprint, enemy health and damage, the camera. See modifiers. | None |
custom_characters, customization, no_vanilla_characters, character_mode | Who the players play. See the players' own characters. | Each mission's own characters |
A server with campaign plays nothing else: it can't also have a playlist, variant, map, game, base_map, odst or reach. Another [[server]] in the same file can play something else, so one machine can host a campaign beside multiplayer servers.
Naming the campaign and the mission
The campaign is one of the five games' keys, or a mod's campaign:
campaign | Campaign |
|---|---|
"halo3" | Halo 3. Also what a Halo 3 mission means with campaign left out. |
"halo1" | Halo: Combat Evolved |
"halo2" | Halo 2 |
"odst" | Halo 3: ODST |
"reach" | Halo: Reach |
"Cursed Halo Again" | A mod's campaign, by its title, its package's title, or the key dedicated content lists. See mods' campaigns. |
The mission can be written three ways, in any case:
- its file's name:
"a10","010_jungle","sc100","m10", with or without.map; - its title:
"The Pillar of Autumn","Sierra 117","Tayari Plaza"; - its number, without quotes:
3010.
Names are the easy way. Halo: CE's and Halo 2's mission numbers are long ones made from the file's name (The Pillar of Autumn is 1221498293), and a Halo 3 number such as 3010 names nothing in another game's campaign.
Leaving campaign out works when the mission says enough:
- a number of Halo 3's, CE's, Halo 2's or ODST's own missions is that game's mission. Reach's missions need
campaign = "reach"or a name; - a name is looked for in the five games' own campaigns first, then in the mods'.
mission = "a10"is CE's own even when a CE mod has ana10too.
When a name is in more than one campaign, the server asks for the campaign. mission = "Halo" is both Halo 3's last mission and CE's second, and mission = "Epilogue" is Halo 3's and ODST's. The refusal names each one:
"Epilogue" is a mission of several campaigns (campaign = "halo3" (Halo 3), campaign = "odst" (Halo 3: ODST)): name the campaign too, as campaign = { campaign = "halo3", mission = "Epilogue" }
What the server folder needs
A server plays from its own game folder (game in dedicated.toml), which dedicated init --from your game's folder --maps … fills from your own installation. Pointing game at the whole game folder works too, and needs none of this.
Every campaign plays through Halo 3's campaign files, so every campaign server needs campaign in --maps: Halo 3's missions and its campaign.map.
| Campaign | --maps |
|---|---|
| Halo 3 | campaign |
| Halo: Combat Evolved | campaign,halo1-campaign |
| Halo 2 | campaign,halo2-campaign |
| Halo 3: ODST | campaign,odst |
| Halo: Reach | reach-campaign,campaign |
- Several can be named at once, such as
--maps campaign,halo1-campaign,odst, and runningdedicated initagain on the same folder adds what's missing and keeps yourdedicated.toml, playlists and bans. --maps halo1and--maps halo2, without-campaign, copy only those games' multiplayer maps and shared files. A server made that way says Halo: Combat Evolved's campaign is not installed (init --maps halo1-campaign), or Halo 2's. The-campaignnames copy the multiplayer maps as well.- A server goes on only to the missions it has, so copy the whole campaign for a server that plays through it.
- For Docker, run
dedicated initon a PC with the game and upload the folder, as in that guide's quick start. - Players need the game whose campaign is played, installed in their own MCC: the server sends no game files.
Every game's missions
As dedicated content lists them. Write the mission's title, its file or its number as mission.
Halo 3 ("halo3", or left out)
| Mission | File | Number |
|---|---|---|
| Arrival | 005_intro | 3005 |
| Sierra 117 | 010_jungle | 3010 |
| Crow's Nest | 020_base | 3020 |
| Tsavo Highway | 030_outskirts | 3030 |
| The Storm | 040_voi | 3040 |
| Floodgate | 050_floodvoi | 3050 |
| The Ark | 070_waste | 3070 |
| The Covenant | 100_citadel | 3100 |
| Cortana | 110_hc | 3110 |
| Halo | 120_halo | 3120 |
| Epilogue | 130_epilogue | 3130 |
Halo: Combat Evolved ("halo1")
| Mission | File | Number |
|---|---|---|
| The Pillar of Autumn | a10 | 1221498293 |
| Halo | a30 | 1221848903 |
| The Truth and Reconciliation | a50 | 1220861553 |
| The Silent Cartographer | b30 | 1216524182 |
| Assault on the Control Room | b40 | 1215737929 |
| 343 Guilty Spark | c10 | 1223392203 |
| The Library | c20 | 1222892080 |
| Two Betrayals | c40 | 1223879430 |
| Keyes | d20 | 1220800985 |
| The Maw | d40 | 1221788335 |
Halo 2 ("halo2")
In the order the campaign plays them.
| Mission | File | Number |
|---|---|---|
| The Heretic | 00a_introduction | 854659685 |
| Armory | 01a_tutorial | 838904492 |
| Cairo Station | 01b_spacestation | 843387939 |
| Outskirts | 03a_oldmombasa | 851757777 |
| Metropolis | 03b_newmombasa | 842925083 |
| The Arbiter | 04a_gasgiant | 839971163 |
| Oracle | 04b_floodlab | 843492445 |
| Delta Halo | 05a_deltaapproach | 849394508 |
| Regret | 05b_deltatowers | 842106227 |
| Sacred Icon | 06a_sentinelwalls | 852486560 |
| Quarantine Zone | 06b_floodzone | 847947006 |
| Gravemind | 07a_highcharity | 853031928 |
| Uprising | 08a_deltacliffs | 851642782 |
| High Charity | 07b_forerunnership | 845126981 |
| The Great Journey | 08b_deltacontrol | 844227917 |
Halo 3: ODST ("odst")
| Mission | File | Number |
|---|---|---|
| Prepare to Drop | c100 | 4100 |
| Mombasa Streets | h100 | 5000 |
| Tayari Plaza | sc100 | 6100 |
| Uplift Reserve | sc110 | 6110 |
| Kizingo Boulevard | sc120 | 6120 |
| ONI Alpha Site | sc130 | 6130 |
| NMPD HQ | sc140 | 6140 |
| Kikowani Station | sc150 | 6150 |
| Data Hive | l200 | 5200 |
| Coastal Highway | l300 | 5300 |
| Epilogue | c200 | 4200 |
Halo: Reach ("reach")
Name Reach's missions by file or title.
| Mission | File |
|---|---|
| NOBLE Actual | m05 |
| Winter Contingency | m10 |
| ONI: Sword Base | m20 |
| Nightfall | m30 |
| Tip of the Spear | m35 |
| Long Night of Solace | m45 |
| Exodus | m50 |
| New Alexandria | m52 |
| The Package | m60 |
| The Pillar of Autumn | m70 |
| Lone Wolf | m70_bonus |
Mods' campaigns
A mod's campaign, from an MCC mod package with a campaign for any of the five games, is hosted like a game's own:
- Copy the mod into the server's content folderCopy the mod's folder, the one with
ModInfo.json(a Steam Workshop item's numbered folder is one), intocontent/Mods. See Mods in the hosting guide. -
See its title and missions
dedicated contentshows them as the server reads them:Shellproject-reclaimer dedicated content cursedOutputCampaigns (campaign = { campaign = "...", mission = "..." }): Cursed Halo Again its key The Pillar of Autumn a10_f9b8c8e0 (ID 1209981751) Halo a30_c34ea632 (ID 1222281963) … -
Name the campaign by its title, and the mission by its file or title
dedicated.toml
campaign = { campaign = "Cursed Halo Again", mission = "a10" } campaign = { campaign = "A Halo 2 mod's title", mission = "Cairo Station" } campaign = { campaign = "A Reach mod's title", mission = "m10" }
- The mission's file name is enough (
"a10"). The longer namecontentshows (a10_f9b8c8e0) is the same mission, for when you want to be exact. A CE, Halo 2 or Reach mod's missions have numbers of their own, never those of the game's own missions. - Where a mod's campaign has a plain title of its own (an ODST mod's may be called "Campaign"), its package's title names it too.
contentshows both, and the key it lists always works. - A mod's campaign needs what its game's own campaign needs in the server folder (above): the game itself and Halo 3's campaign files.
- The server plays the mod's missions one after another, in the mod's own order.
- Players need the mod. A player who has it installed joins as on any co-op server.
The players' own characters
By default every mission is played as its own characters: the Master Chief and the Arbiter, the Rookie and his squad, Noble Six. The same options change that on every game's campaign:
campaign = { mission = "Sierra 117", custom_characters = true }
campaign = { campaign = "odst", mission = "sc100", custom_characters = true, customization = ["Halo: Reach"] }
campaign = { campaign = "reach", mission = "m10", custom_characters = true, customization = ["Halo 3: ODST"] }
The second plays ODST's missions as the players' own troopers, with Reach's Spartan and Elite offered too; the third plays Reach's missions as the players' own characters instead of Noble Six, with ODST's trooper offered.
| Option | What it does |
|---|---|
custom_characters = true | The players play as their own characters, their Spartan or Elite or their ODST trooper, in the look they made in Customize. |
customization = […] | With it, the character mods whose characters players may pick too, each by the name Customize shows, its folder's name or its ID. Three names need no mod: "Halo 3", "Halo 3: ODST" and "Halo: Reach" are those games' own characters. |
no_vanilla_characters = true | With customization: nobody plays the game's own characters, only the mods'. |
character_mode | The same choice in one word: "original", the mission's own characters; "customized", the mission's characters in the players' look; or "load_order", their own characters, as custom_characters = true. |
check names a character mod it can't find, with the folders it looked in.
Difficulty, start and modifiers
campaign = { mission = "The Storm", difficulty = "legendary", insertion = 1, modifiers = { scoring = "team", skulls = 257 } }
difficulty:"easy","normal","heroic"or"legendary". It stays for the missions that follow.insertion: the start (rally point) of the first mission, counted from 0. The missions that follow start from their beginning. A start the mission doesn't have is refused: The selected insertion point is not available on this mission.modifiers, a table of its own, sets what the Campaign page's Modifiers do:
| Modifier | Values |
|---|---|
scoring | Campaign scoring: "off" (the default), "team" or "free_for_all". |
skulls | The skulls that are on, as one number: add up the values below. |
sprint, sprint_speed_percent, sprint_stamina_seconds | true lets every player sprint; its speed, 110 to 200 percent in steps of 10 (150 unless set); how long a full meter lasts, up to 30 seconds, or 0 for unlimited (5 unless set). |
health_percent, damage_percent | The enemies' health and damage, 25 to 1000 in steps of 25; 100 is the game's own. |
health_per_player_percent, damage_per_player_percent | Added for each player beyond the first, 0 to 100 in steps of 5. |
disable_friendly_fire | true: players can't hurt each other. |
third_person, players_choose_camera | true: everyone in third person, or each player's own choice with their Switch camera key. |
Skulls to add up: Iron 1, Black Eye 2, Tough Luck 4, Catch 8, Fog 16, Famine 32, Thunderstorm 64, Tilt 128, Mythic 256, Assassin 512, Blind 1024, Cowbell 2048, Grunt Birthday Party 4096 and IWHBYD 8192. Iron and Mythic together are skulls = 257. These are Halo 3's and ODST's; on another game's missions, only the skulls that game plays stay on.
The server's own settings that matter for a campaign, in [defaults] or the [[server]]:
| Setting | For a campaign |
|---|---|
max_players | At most 16. |
min_players | How many must be in the lobby before a mission starts. |
start_countdown_seconds | The countdown once they are. |
post_game_seconds | The pause in the lobby between missions. |
campaign_skip_vote_percent | The share of players whose votes skip a cinematic, 33 unless set. See skipping cinematics. |
friendly_fire | As for any game. See friendly fire. |
coop_network | How co-op plays: lockstep, the default, or host-authoritative. See networking. |
How a campaign server runs
- The lobby. The server waits in a co-op lobby showing its mission, and the Server Browser lists it as a campaign at its difficulty, such as Campaign (Heroic), on that mission.
- The start. Once
min_playersplayers are in, and everyone connected has arrived, or 30 seconds after the last one joined, the lobby counts down and the mission starts. Players can join a mission under way: they catch up with the server's game while everyone else plays on. - After a win, everyone is back in the lobby, which shows the next mission (Sierra 117 complete. Next: Crow's Nest.) and starts it after
post_game_seconds, at the same difficulty, with the same modifiers and characters. - After the last mission, the server starts again from the mission in its file.
- A mission that ends without a win, because everyone left or the remote console's
endgameended it, is played again. - ODST follows its own story. After a flashback mission the server goes back to Mombasa Streets, at the point that mission returns to, and the squad's progress in the city is carried along. After the city come Data Hive, Coastal Highway and the Epilogue.
- Loading: a mission loads for every player together, and nobody is removed while it does.
- Cinematics are skipped by vote: players press skip, and the server skips once
campaign_skip_vote_percentof them have. - Co-op games aren't ranked, so a campaign server reports no stats. Checkpoints stay in the server's memory, for players who join and for reverts; restarting the server starts the mission in its file afresh.
- The remote console's
statusnames the mission;map,mode,load,nextmap,nextandreplayanswer that the server plays a campaign. To play something else, change thecampaignline: the server restarts with it once it has no players.
Not yet proven on a server:
- Halo 3's own missions played with the players' own characters (
custom_characters): such a server's lobby may take no joiner. - A Halo 3 mod's campaign named by its title, and a player who lacks a campaign mod getting it from the server as they join.
- An ODST flashback that the players start from a beacon in the city, which is meant to be the next mission, as in a game hosted from the menus.
- Passenger seats, on the Halo 3 missions that have them, can be wrong for a player who stayed through the end of the campaign when the server plays its first mission again.
ODST, Reach, Firefight and playlists
campaign = { campaign = "odst", … } and campaign = { campaign = "reach", … } are the full way to host those two campaigns. Each game also has a key of its own, which is how Firefight is hosted:
odst = { mission = "sc100", difficulty = "heroic" } # a mission
odst = { mode = "firefight", mission = 6100, insertion = 4 } # Firefight on Crater
reach = { map = "Winter Contingency", campaign = true } # a mission, on Normal
reach = { map = "ff20_courtyard", campaign = true, firefight = "firefight_new" } # Firefight
odst'smissiontakes a file's name, a title or a number, ascampaign's does. Its own options arestory_characters,customization,no_vanilla_characters,character_mode,modifiersand, for Firefight,variantandoptions. See Halo 3: ODST in the hosting guide.reach'smaptakes a file's name or a title, or a mod's mission or Firefight map by its title or key. It has no difficulty or character options of its own: usecampaign = { campaign = "reach", … }for those. See Reach co-op and Firefight.- A playlist can hold co-op games among its entries:
{ "campaign": { "mission": 3010 } }, Halo 3's own campaign only, and{ "odst": { "mission": "sc100" } }. There the playlist's next game follows a finished mission, not the campaign's next mission. See co-op games in a playlist.
When something is refused
dedicated check and the server's start say the same things.
| It says | Why, and what to do |
|---|---|
| Campaign mission 3010 is not installed. Halo: Combat Evolved's missions: a10 "The Pillar of Autumn" (ID …), … | The mission isn't one of that campaign's, here a Halo 3 number with campaign = "halo1". Use one of the names listed. |
| Campaign mission "x" is not installed. This server can host: … | No campaign has a mission of that name. The line lists the campaigns the server found; dedicated content lists their missions. |
| "Halo" is a mission of several campaigns (…): name the campaign too | Add campaign = "…" with one of the names given. |
| No campaign "x" is installed and turned on. This server can host: … | The campaign's name is wrong, its game isn't in the server folder, or its mod isn't in content/Mods or is turned off. |
| Halo: Combat Evolved's campaign is not installed (init --maps halo1-campaign), or Halo 2's | The game's missions aren't in the server folder: --maps halo1 copies only its multiplayer maps. See what the server folder needs. |
| Campaign hosting requires halo3/maps/campaign.map | Make the folder with campaign in --maps: every campaign plays through Halo 3's campaign files. |
| This needs Halo 3: ODST, which isn't installed…, or Halo: Reach's missions are not installed | The game isn't in the server folder: --maps campaign,odst or --maps reach-campaign,campaign. |
| No mission of Halo 3: ODST's is named "x". Its missions: … | odst = { mission = … } names none of ODST's missions. |
| Halo: Reach has no map "x". Its missions: … | reach = { map = … } names none of Reach's maps, nor a mod's. |
| campaign cannot be combined with … | Give the campaign a [[server]] of its own. |
| Campaign co-op supports at most 16 players | Lower max_players, also under [defaults]. |
| The selected insertion point is not available on this mission | Lower insertion, or leave it out. |
| no customization mod named "x" is installed… | A name in customization is no mod in content/Mods. The three games' own are "Halo 3", "Halo 3: ODST" and "Halo: Reach". |
| Unknown campaign mission | A number with no campaign that is no game's own mission: name the campaign, or the mission by name. |
When reporting a problem, include the server's log from data/<server>/server.log, as the hosting guide's troubleshooting says.
