Nubt — A Village is Born

The entire mission — configuration block, variables, and all event handlers — lives in one file:

src/scripts/mission_0_nubt.js

This file is imported by src/scripts/missions.js which loads all 38 campaign scripts. The mission0 { … } block at the top of the file is the static configuration parsed at startup:

// lines 3 – 45  (mission_0_nubt.js)
mission0 {
  start_message : "message_housing_and_roads"   // first popup (ID 249)
  env {
    has_animals       : true
    gods_least_mood   : 50
    marshland_grow    : default_marshland_grow
    tree_grow         : default_tree_grow
    hide_nilometer    : true        // hides flood meter
  }
  religion_enabled  : false
  hide_won_screen   : true         // skip victory screen, go straight to next mission
  player_rank       : 0

  initial_funds  [7500, 5000, 3750, 2500, 2000]  // Very Easy … Very Hard
  rescue_loans   [7500, 5000, 3750, 2500, 2000]

  buildings [                        // only these are available at start
    BUILDING_HOUSE_VACANT_LOT,
    BUILDING_CLEAR_LAND,
    BUILDING_ROAD
  ]

  win_criteria {
    housing_count { enabled : true, goal : 6 }
    housing_level { enabled : true, goal : 2 }  // level 2 = Sturdy Hut
  }

  vars {
    granary_open_population          : 150
    population_cap_firstfire         : 0
    granary_meat_stored              : 400
    victory_last_action_delay        : 4
    population_to_start_fire_event   : 120
    population_cap                   : 250
    // boolean flags persist across saves (resume mid-tutorial)
    tutorial_fire_handled      : false
    tutorial_collapsed_handled : false
    tutorial_firehouse_built   : false
    tutorial_granary_opened    : false
    tutorial_gamemeat_stored   : false
    granary_built              : false
    last_action_time           : 0
  }
}

To change difficulty starting money, edit the initial_funds array (index 0 = Very Easy, 4 = Very Hard). To adjust the population thresholds that trigger tutorial steps, edit the corresponding vars entries.

Each function is bound to a game event via an attribute annotation on the line above it. Handlers are called by the scripting engine whenever that event fires, but only when mission=mission0 is active.

• event_mission_start line 48 Restores mid-tutorial state on load/restart — re-unlocks any buildings whose tutorial step was already completed, so resuming a save never leaves the player without previously earned buildings. mission0_on_start
• event_register_mission_animals line 80 Clears default animal spawns and places 4 ostriches at map position (40, 60) with a roam radius of 16 tiles. Edit here to move or change the prey type. mission0_register_animals
• event_advance_week line 103 Polls weekly once population ≥ 120. Adds 2 000 fire damage to a random house to trigger the fire tutorial. Runs only once (guard on tutorial_fire_handled). mission0_handle_fire_event
• event_fire_damage line 125 Responds to the fire; unlocks BUILDING_FIREHOUSE and shows message_fire_in_the_village (ID 252). Sets tutorial_fire_handled = true. mission0_handle_fire
• event_collase_damage line 138 Unlocks BUILDING_ARCHITECT_POST and shows collapse tutorial message (ID 253) the first time any building collapses. Note: the event name has a typo in the engine (collase not collapse). mission0_handle_collapse
• event_population_changed line 151 Triggers at population ≥ 150 (configurable via granary_open_population). Unlocks Hunting Lodge, Granary, and Bazaar; shows food tutorial (message ID 239); makes Population Advisor available. mission0_handle_population_for_granary
• event_advance_day · build granary line 171 Watches daily for the first Granary to be placed. When found, enables the Population Advisor panel. mission0_on_build_granary
• event_granary_resource_added line 188 Fires when food is added to any Granary. Once game meat in a single granary reaches 400 units (configurable via granary_meat_stored), unlocks BUILDING_WATER_SUPPLY and shows clean water tutorial (message ID 255). mission0_on_filled_granary
• event_update_victory_state line 208 Called each tick to compute whether the win conditions are met. All four tutorial flags plus a cooldown since the last tutorial action must be true before victory is granted. Change victory_last_action_delay to shorten or lengthen the delay. mission0_handle_victory_state
• event_migration_update line 219 Caps unemployment swing at ±10 percentage points, preventing the early city from stalling on a bad immigration roll. mission0_handle_population_cap

All popup dialogs and the opening history panel are defined in src/scripts/game_messages_en.js. Each entry has a numeric ID used by the C++ engine to look up translated strings. To edit text, find the entry by name and change the text: field inside content { … }.

The classical-name variant of the history message (Naqada instead of Nubt) is a separate entry at line 4712, shown when the player enables classical city names in options.

The original Pharaoh save file that provides the map layout, terrain, and starting positions for Nubt is:

bin_x64/Missions/mission_00.sav

This binary file is loaded by the engine before the JS script runs. It encodes the tile map, Nile course, predefined animal spawn zones (overridden by event_register_mission_animals in the script), and the kingdom road entry point. To replace the map entirely, swap the .sav file; the JS script will still apply on top of it.

The scripting system is loaded from src/scripts/missions.js, which imports mission_0_nubt.js by path. If you rename or move the file, update the import there.