https://github.com/beyond-all-reason/enginesynctestlocal

A set of tools and scripts to test for sync locally.
https://github.com/beyond-all-reason/enginesynctestlocal

Last synced: 9 days ago
JSON representation

A set of tools and scripts to test for sync locally.

• Host: GitHub
• URL: https://github.com/beyond-all-reason/enginesynctestlocal
• Owner: beyond-all-reason
• Created: 2024-01-11T09:23:16.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-01-12T08:02:45.000Z (10 months ago)
• Last Synced: 2024-01-13T06:42:01.595Z (10 months ago)
• Language: Batchfile
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# EngineSyncTestLocal

Author: Beherith

A set of tools and scripts to test for sync locally. 

When working on the engine, it is often non-trivial to set up a test case for running two engines on the same machine to perform a sync test. 

These instructions initially for Windows, using the MSVC Compiler, but can be adapted to Linux, or docker builds as well. 

## Engine, Games and Maps Setup

1. Build the engine with your desired changes. For example on windows build for RELWITHDEBINFO. Make sure you have all the base content required in the build folder too (if in doubt, just grab a release from the engine github and copy all files from there, except the executable)

2. Your built engine should be in: `build\RelWithDebInfo`

3. Game: Make sure you have [Beyond-All-Reason](https://github.com/beyond-all-reason/Beyond-All-Reason) checked out to `build\RelWithDebInfo\games\BAR.ssd`

4. Map: The map is **Archsimkats_Valley_V1**, because it has water too. Download it into `\build\RelWithDebInfo\maps\` from https://springfiles.springrts.com/?type=2&filter=62c2c99223e88cba504593bc3bc36c36 

5. Copy the files in this repo next to the `spring.exe` executable

6. Make sure you set windowed mode in your `springsettings.cfg`, as it will open windows for each instance of the engine

## Start Script

The script will set up a simple two player game, with the "Host" being a spectator, and the "Client" being a player, and a NullAI enemy. 

See below for this minimal start script, this is the one included in this repo. 

```

[game]

{

	[allyteam0]

	{

		numallies=0;

	}

	[allyteam1]

	{

		numallies=0;

	}

	[team0]

	{

		teamleader=0;

		allyteam=0;

	}

	[team1]

	{

		teamleader=0;

		allyteam=1;

	}

	[ai0]

	{

		team=1;

		host=0;

		version=0.1;

		name=Enemy;

		shortname=NullAI;

	}

	[player0]

	{

		team=0;

		name=Player;

	}

	[player1]

	{

		name=synctesthost;

		spectator=1;

	}

	[modoptions]

	{

	}

	myplayername=synctesthost;

	gametype=Beyond All Reason $VERSION;

	mapname=Archsimkats_Valley_V1;

	hostip=127.0.0.1;

	ishost=1;

	startpostype=0;

	hostport=8458;

}

```

## Usage

Launch `enginesync_host_spectator.bat` for the host

Launch `enginesync_client_player.bat` for the player

Test at your hearts content!

## Using headless engine builds

Simply replace `spring.exe` with `spring-headless.exe` in the batch files.