sourcehold-ai

AI focused sourcehold repo for Stronghold Crusader as created by Firefly Studios

Check the wiki!

Getting started

An AIV file is divided into data sections.

The relevant sections to know about are the following:

ID	Name	Description
2007	constructions	100x100 matrix of type uint16, containing the construction type
2008	steps	100x100 matrix of type uint32, containing the steps
2010	step count	Amount of steps in total
2011	pauses	Ten int32 indicating which step has a pause
2012	units	Unit (and brazier and flag) locations. Structure is int[24][10] => int[unitType][slotID], so every unit type has 10 slots available
2014	pause	uint32 how long the pause is

Installation of tools

Prerequisites

Python 3 is required.

(x86 is required if you want to hack around with the memory of the game or the AIV editor https://www.python.org/ftp/python/3.12.6/python-3.12.6.exe )

Sourcehold

If you want to use sourcehold from the command line

python -m pip install git+https://github.com/sourcehold/sourcehold-maps

Or this if you want to use the examples

git clone https://github.com/sourcehold/sourcehold-maps
cd sourcehold-maps
python -m pip install pymem Pillow dclimplode numpy matplotlib

Example 1

Open up examples/aiv_example_one.py from the sourcehold-maps repo for guidance

Viewing an AIV file

from sourcehold.aivs import AIV

aiv = AIV().from_file("C:\\Program Files (x86)\\Steam\\steamapps\\common\\Stronghold Crusader Extreme\\aiv\\saladin1.aiv")

# View the constructions
aiv.directory[2007].show()

Example 2

Hacking around the editor

from sourcehold.debugtools.memory.access import Village
process = Village()

process.show('2007')

# Read in data
rawdata = process.read_section('2007')
constructions = np.frombuffer(rawdata, dtype='uint16').copy().reshape((100,100))

# Make modifications

# Write the data to process memory
process.write_section('2007', constructions.tobytes())

Example 3

import struct

import numpy as np

from sourcehold.aivs import AIV

aiv = AIV().from_file("C:\\Program Files (x86)\\Steam\\steamapps\\common\\Stronghold Crusader Extreme\\aiv\\saladin1.aiv")

rawdata = aiv.directory[2007].get_data()
constructions = np.frombuffer(rawdata, dtype='uint16').copy().reshape((100,100))

# Insert your modifications here

# When done, do this:
aiv.directory[2007].set_data(constructions.to_bytes())
aiv.to_file("your_aiv.aiv")