A Total War Saga: THRONES OF BRITANNIA 1.0.0

pts/thronesofbritannia-1.0.0 - 08 June 2018 - Initial commit from Feral Interactive of new Linux game port.

install.sh

#!/bin/bash -e
# Install A Total War Saga: THRONES OF BRITANNIA on Linux and generate launcher scripts and preference templates

# Base constants
#
export STEAM_GAME_ID=712100
export GAME_PREFS="$DEBUG_REAL_HOME/.local/share/feral-interactive/Thrones of Britannia"
export GAME_INSTALL_DIR_BASE="steamapps/common/Total War Saga Thrones of Britannia/"
export DEFAULT_STEAM_INSTALL_BASE="$DEBUG_REAL_HOME/.steam/steam"


# Try and install the game in case it isn't already
#
echo "Ensuring game is installed"
HOME="$DEBUG_REAL_HOME" steam "steam://install/$STEAM_GAME_ID"


# Work out the steam install directory
#
export CONFIG_PATH="$DEBUG_REAL_HOME/.steam/steam/config/config.vdf"
echo "Searching ${CONFIG_PATH} for install directories"
_INSTALL_PATHS=$( awk '/BaseInstallFolder/ { gsub(/"/, "", $2); print $2 }' "${CONFIG_PATH}" )

# Find one that contains the game
while read -r STEAM_PATH; do
    _NEW_FULL_PATH="${STEAM_PATH}/${GAME_INSTALL_DIR_BASE}"
    echo "Checking for game install: ${_NEW_FULL_PATH}"
    if [ -d "${_NEW_FULL_PATH}" ]; then
        echo "Found game install: ${_NEW_FULL_PATH}"
        export GAME_INSTALL_DIR="${_NEW_FULL_PATH}"
    fi
done <<< "${_INSTALL_PATHS}"

# Allow the default location as well
if [ ! -d "${GAME_INSTALL_DIR}" ]; then
    export GAME_INSTALL_DIR="${DEFAULT_STEAM_INSTALL_BASE}/${GAME_INSTALL_DIR_BASE}"
    echo "Using default directory for game install: ${GAME_INSTALL_DIR}"
fi

# Bail if we still couldn't find the game
if [ ! -f "${GAME_INSTALL_DIR}/ThronesOfBritannia.sh" ]; then
    >&2 echo "Missing run script in install dir - ${GAME_INSTALL_DIR}/ThronesOfBritannia.sh"
    exit 1
fi

# Gather the steam env variables the game runs with
#
echo "Gathering environment variables for game"
HOME="$DEBUG_REAL_HOME" steam steam://run/$STEAM_GAME_ID &
sleep 6
GAME_PID=$( pidof ThronesOfBritannia | cut -d' ' -f1 )
if [ -z "$GAME_PID" ]; then
    echo "Could not find process ThronesOfBritannia"
    exit 1
fi

echo '#!/bin/bash' > steam-env-vars.sh
echo "# Collected steam environment for A Total War Saga: THRONES OF BRITANNIA\n# PID : $GAME_PID" >> steam-env-vars.sh
while read -rd $'\0' ENV ; do
    NAME=$(echo "$ENV" | cut -zd= -f1); VAL=$(echo "$ENV" | cut -zd= -f2)
    case $NAME in
	*DBUS*) true
	;;
	*)
        echo "export $NAME=\"$VAL\""
	;;
    esac
done < "/proc/$GAME_PID/environ" >> steam-env-vars.sh
killall -9 ThronesOfBritannia
sleep 6


# Create the game launching script
#
echo "Generating run script"
cat > thronesofbritannia <<- EOM
#!/bin/bash
# Generated run script for A Total War Saga: THRONES OF BRITANNIA
# $( date )

# Source the steam runtime environment
#
. steam-env-vars.sh

# Run the game
#
cd "${GAME_INSTALL_DIR}"
./ThronesOfBritannia.sh

# Grab the output (most recent non _frametimes txt file)
RESULTS_DIR="${GAME_PREFS}/VFS/User/AppData/Roaming/The Creative Assembly/ThronesofBritannia/benchmarks/"
mkdir -p "\${RESULTS_DIR}"
cd "\${RESULTS_DIR}"
true > "\$LOG_FILE"
FPS_VALUES=\$( grep -A3 "frames per second" \$(ls -t | grep -P "benchmark_.*[0-9]+.txt" | head -n 1) | tail -n 3 )
cat benchmark_*.txt >>  "\$LOG_FILE"
echo "\${FPS_VALUES}" >> "\$LOG_FILE"
EOM
chmod +x thronesofbritannia


# Create the template preferences file
#
echo "Generating settings template"
cat > preferences.template.xml <<- EOM
<?xml version="1.0" encoding="UTF-8"?>
<registry>
    <key name="HKEY_CLASSES_ROOT">
    </key>
    <key name="HKEY_CURRENT_CONFIG">
    </key>
    <key name="HKEY_CURRENT_USER">
        <key name="Software">
            <key name="Feral Interactive">
                <key name="Thrones of Britannia">
                    <key name="Setup">
                        <!-- screen resolutions -->
                        <value name="ScreenH" type="integer">@ScreenH@</value>
                        <value name="ScreenW" type="integer">@ScreenW@</value>

                        <value name="FullScreen" type="integer">1</value>

                        <!-- disable all forms of pausing -->
                        <value name="PauseMoviesOnPause" type="integer">0</value>
                        <value name="PauseOnSuspend" type="integer">0</value>
                        <value name="PauseSoundOnPause" type="integer">0</value>
                        <value name="PauseTimersOnPause" type="integer">0</value>
                        <value name="AllowPausing" type="integer">0</value>

                        <!-- don't send data without consent -->
                        <value name="AllowSendUsageData" type="integer">0</value>

                        <!-- stop the game options dialogue showing -->
                        <value name="GameOptionsDialogShouldShow" type="integer">0</value>
                        <value name="GameOptionsDialogShouldShowBigPicture" type="integer">0</value>
                        <value name="GameOptionsDialogShown" type="integer">1</value>

                        <!-- stop any potential warnings -->
                        <value name="SoftwareUpdatedAskedUser" type="integer">1</value>
                        <value name="SoftwareUpdatedCanCheck" type="integer">0</value>
                        <value name="SkipDriverWarnings" type="integer">1</value>
                        <value name="SkipOSWarnings" type="integer">1</value>
                        <key name="SpecificationAlerts">
                            <!-- NOTE: Un-comment this if comparing the effects of the CPU governor -->
                            <!-- <value name="LnxCPUGovernorSubOptimal" type="integer">1</value> -->
                        </key>
                        
                        <!-- surpress per device graphics settings, otherwise the settings below will be ignored  -->
                        <value name="SeenSpecificationAlertUUIDPerRendererMappedSettings" type="integer">1</value>

                        <key name="GraphicsSettings">
                        <!-- Default Graphics Settings -->
                            <value name="gfx_aa" type="integer">@gfx_aa@</value>
                            <value name="gfx_building_quality" type="integer">@gfx_building_quality@</value>
                            <value name="gfx_depth_of_field" type="integer">@gfx_depth_of_field@</value>
                            <value name="gfx_distortion" type="integer">@gfx_distortion@</value>
                            <value name="gfx_effects_quality" type="integer">@gfx_effects_quality@</value>
                            <value name="gfx_fleet_size" type="integer">@gfx_fleet_size@</value>
                            <value name="gfx_grass_quality" type="integer">@gfx_grass_quality@</value>
                            <value name="gfx_screen_space_reflections" type="integer">@gfx_screen_space_reflections@</value>
                            <value name="gfx_shadow_quality" type="integer">@gfx_shadow_quality@</value>
                            <value name="gfx_sky_quality" type="integer">@gfx_sky_quality@</value>
                            <value name="gfx_ssao" type="integer">@gfx_ssao@</value>
                            <value name="gfx_terrain_quality" type="integer">@gfx_terrain_quality@</value>
                            <value name="gfx_texture_filtering" type="integer">@gfx_texture_filtering@</value>
                            <value name="gfx_texture_quality" type="integer">@gfx_texture_quality@</value>
                            <value name="gfx_tree_quality" type="integer">@gfx_tree_quality@</value>
                            <value name="gfx_unit_quality" type="integer">@gfx_unit_quality@</value>
                            <value name="gfx_unit_size" type="integer">@gfx_unit_size@</value>
                            <value name="gfx_water_quality" type="integer">@gfx_water_quality@</value>

                        <!-- VSync off to avoid monitor refresh-rate changing results -->
                            <value name="gfx_vsync"       type="integer">0</value>
                        </key>
                    </key>
                </key>
            </key>
            <key name="MacDoze">
                <key name="Config">
                    <value name="ExtraCommandLine" type="string">gfx_first_run false; game_startup_mode benchmark_auto_quit Script/Benchmarks/SiegeOfWintanceaster/SiegeOfWintanceaster.xml</value>
                    <value name="ExtraCommandLineEnabled" type="integer">1</value>
                </key>
            </key>
        </key>
    </key>
</registry>
EOM

interim.sh

#!/bin/bash
GAME_PREFS="$DEBUG_REAL_HOME/.local/share/feral-interactive/Thrones of Britannia"

# Clean out the game temp files to ensure we have a clean run
rm -rf "${GAME_PREFS:?}/VFS"

post.sh

#!/bin/bash -e
GAME_PREFS="$DEBUG_REAL_HOME/.local/share/feral-interactive/Thrones of Britannia"

# Grab the old prefs bkp location
DATETIME=$( cat /tmp/tob-bkp-dt )
rm /tmp/tob-bkp-dt
GAME_PREFS_BKP="${GAME_PREFS}.pts-$DATETIME-bkp"

# Put back our game prefs
rm -rf "${GAME_PREFS:?}/"
mv "$GAME_PREFS_BKP" "$GAME_PREFS"

pre.sh

#!/bin/bash -e
set -o xtrace
exec > /tmp/test
exec 2>&1

# Input settings
WIDTH=$1
HEIGHT=$2
SETTING=$3

# Game preferences
export HOME=$DEBUG_REAL_HOME
GAME_PREFS="$DEBUG_REAL_HOME/.local/share/feral-interactive/Thrones of Britannia"

# Set up (and back up) the game preferences files
DATETIME=$( date +%Y-%d-%m-%H-%M )
echo "$DATETIME" >/tmp/tob-bkp-dt
GAME_PREFS_BKP="${GAME_PREFS}.pts-$DATETIME-bkp"
cp -r "$GAME_PREFS" "$GAME_PREFS_BKP"

# clear previous runs
rm -rf "${GAME_PREFS:?}"
mkdir -p "${GAME_PREFS}"

# Set up the files to use
cp "preferences.template.xml" "$GAME_PREFS/preferences"

# Replace the resolutions
cd "$GAME_PREFS" || exit 1

# Replace settings with those chosen
sed -i "s/@ScreenW@/$WIDTH/g"          preferences
sed -i "s/@ScreenH@/$HEIGHT/g"         preferences

# Lowest
if [ $SETTING -eq "0" ]; then
	sed -i "s/@gfx_aa@/0/g"                       preferences
	sed -i "s/@gfx_building_quality@/0/g"         preferences
	sed -i "s/@gfx_depth_of_field@/0/g"           preferences
	sed -i "s/@gfx_distortion@/0/g"               preferences
	sed -i "s/@gfx_effects_quality@/0/g"          preferences
	sed -i "s/@gfx_fleet_size@/0/g"               preferences
	sed -i "s/@gfx_grass_quality@/0/g"            preferences
	sed -i "s/@gfx_screen_space_reflections@/0/g" preferences
	sed -i "s/@gfx_shadow_quality@/0/g"           preferences
	sed -i "s/@gfx_sky_quality@/0/g"              preferences
	sed -i "s/@gfx_ssao@/0/g"                     preferences
	sed -i "s/@gfx_terrain_quality@/0/g"          preferences
	sed -i "s/@gfx_texture_filtering@/0/g"        preferences
	sed -i "s/@gfx_texture_quality@/2/g"          preferences
	sed -i "s/@gfx_tree_quality@/0/g"             preferences
	sed -i "s/@gfx_unit_quality@/0/g"             preferences
	sed -i "s/@gfx_unit_size@/0/g"                preferences
	sed -i "s/@gfx_water_quality@/0/g"            preferences
elif [ $SETTING -eq "1" ]; then
	sed -i "s/@gfx_aa@/0/g"                       preferences
	sed -i "s/@gfx_building_quality@/1/g"         preferences
	sed -i "s/@gfx_depth_of_field@/0/g"           preferences
	sed -i "s/@gfx_distortion@/1/g"               preferences
	sed -i "s/@gfx_effects_quality@/1/g"          preferences
	sed -i "s/@gfx_fleet_size@/1/g"               preferences
	sed -i "s/@gfx_grass_quality@/1/g"            preferences
	sed -i "s/@gfx_screen_space_reflections@/0/g" preferences
	sed -i "s/@gfx_shadow_quality@/1/g"           preferences
	sed -i "s/@gfx_sky_quality@/1/g"              preferences
	sed -i "s/@gfx_ssao@/0/g"                     preferences
	sed -i "s/@gfx_terrain_quality@/1/g"          preferences
	sed -i "s/@gfx_texture_filtering@/0/g"        preferences
	sed -i "s/@gfx_texture_quality@/2/g"          preferences
	sed -i "s/@gfx_tree_quality@/1/g"             preferences
	sed -i "s/@gfx_unit_quality@/1/g"             preferences
	sed -i "s/@gfx_unit_size@/1/g"                preferences
	sed -i "s/@gfx_water_quality@/1/g"            preferences
elif [ $SETTING -eq "2" ]; then
	sed -i "s/@gfx_aa@/0/g"                       preferences
	sed -i "s/@gfx_building_quality@/2/g"         preferences
	sed -i "s/@gfx_depth_of_field@/0/g"           preferences
	sed -i "s/@gfx_distortion@/1/g"               preferences
	sed -i "s/@gfx_effects_quality@/2/g"          preferences
	sed -i "s/@gfx_fleet_size@/2/g"               preferences
	sed -i "s/@gfx_grass_quality@/2/g"            preferences
	sed -i "s/@gfx_screen_space_reflections@/1/g" preferences
	sed -i "s/@gfx_shadow_quality@/2/g"           preferences
	sed -i "s/@gfx_sky_quality@/2/g"              preferences
	sed -i "s/@gfx_ssao@/0/g"                     preferences
	sed -i "s/@gfx_terrain_quality@/2/g"          preferences
	sed -i "s/@gfx_texture_filtering@/0/g"        preferences
	sed -i "s/@gfx_texture_quality@/2/g"          preferences
	sed -i "s/@gfx_tree_quality@/2/g"             preferences
	sed -i "s/@gfx_unit_quality@/2/g"             preferences
	sed -i "s/@gfx_unit_size@/2/g"                preferences
	sed -i "s/@gfx_water_quality@/2/g"            preferences
elif [ $SETTING -eq "3" ]; then
	sed -i "s/@gfx_aa@/1/g"                       preferences
	sed -i "s/@gfx_building_quality@/3/g"         preferences
	sed -i "s/@gfx_depth_of_field@/0/g"           preferences
	sed -i "s/@gfx_distortion@/1/g"               preferences
	sed -i "s/@gfx_effects_quality@/3/g"          preferences
	sed -i "s/@gfx_fleet_size@/2/g"               preferences
	sed -i "s/@gfx_grass_quality@/3/g"            preferences
	sed -i "s/@gfx_screen_space_reflections@/2/g" preferences
	sed -i "s/@gfx_shadow_quality@/3/g"           preferences
	sed -i "s/@gfx_sky_quality@/3/g"              preferences
	sed -i "s/@gfx_ssao@/1/g"                     preferences
	sed -i "s/@gfx_terrain_quality@/3/g"          preferences
	sed -i "s/@gfx_texture_filtering@/1/g"        preferences
	sed -i "s/@gfx_texture_quality@/2/g"          preferences
	sed -i "s/@gfx_tree_quality@/3/g"             preferences
	sed -i "s/@gfx_unit_quality@/3/g"             preferences
	sed -i "s/@gfx_unit_size@/2/g"                preferences
	sed -i "s/@gfx_water_quality@/3/g"            preferences
elif [ $SETTING -eq "4" ]; then
	sed -i "s/@gfx_aa@/3/g"                       preferences
	sed -i "s/@gfx_building_quality@/3/g"         preferences
	sed -i "s/@gfx_depth_of_field@/1/g"           preferences
	sed -i "s/@gfx_distortion@/1/g"               preferences
	sed -i "s/@gfx_effects_quality@/3/g"          preferences
	sed -i "s/@gfx_fleet_size@/2/g"               preferences
	sed -i "s/@gfx_grass_quality@/3/g"            preferences
	sed -i "s/@gfx_screen_space_reflections@/2/g" preferences
	sed -i "s/@gfx_shadow_quality@/3/g"           preferences
	sed -i "s/@gfx_sky_quality@/3/g"              preferences
	sed -i "s/@gfx_ssao@/1/g"                     preferences
	sed -i "s/@gfx_terrain_quality@/3/g"          preferences
	sed -i "s/@gfx_texture_filtering@/2/g"        preferences
	sed -i "s/@gfx_texture_quality@/2/g"          preferences
	sed -i "s/@gfx_tree_quality@/3/g"             preferences
	sed -i "s/@gfx_unit_quality@/3/g"             preferences
	sed -i "s/@gfx_unit_size@/3/g"                preferences
	sed -i "s/@gfx_water_quality@/3/g"            preferences
else
	echo "Failed to set graphics preset"
	exit 2
fi

results-definition.xml

<?xml version="1.0"?>
<!--Phoronix Test Suite v8.0.0-->
<PhoronixTestSuite>
  <ResultsParser>
    <OutputTemplate>   mean    #_RESULT_#
   min     #_MIN_RESULT_#
   max     #_MAX_RESULT_#</OutputTemplate>
  </ResultsParser>
  <ExtraData>
    <Identifier>csv-individual-frame-times</Identifier>
  </ExtraData>
</PhoronixTestSuite>

test-definition.xml

<?xml version="1.0"?>
<!--Phoronix Test Suite v8.0.0-->
<PhoronixTestSuite>
  <TestInformation>
    <Title>A Total War Saga: THRONES OF BRITANNIA</Title>
    <Description>A Total War Saga: THRONES OF BRITANNIA on Steam.

The test profile assumes you have a Steam account, have Steam installed for the system, and that you own a copy of this game. This automates the process of executing the game and using its built-in benchmark mode.

Backs up old preferences (in ~/.local/share/feral-interactive/) for the run.

NOTES for cross-platform comparisons:
	TODO

See notes in install.sh for a few small tweaks including disabling the CPU governor check when testing for it's effects
    </Description>
    <ResultScale>Frames Per Second</ResultScale>
    <Proportion>HIB</Proportion>
    <TimesToRun>3</TimesToRun>
    <PreInstallMessage>This test will attempt to install the necessary game using your Steam account. If the test appears hung you may need to manually exit the Steam client.</PreInstallMessage>
  </TestInformation>
  <TestProfile>
    <Version>1.0.0</Version>
    <SupportedPlatforms>Linux</SupportedPlatforms>
    <SoftwareType>Game</SoftwareType>
    <TestType>Graphics</TestType>
    <License>Retail</License>
    <Status>Verified</Status>
    <SupportedArchitectures>x86_64</SupportedArchitectures>
    <EnvironmentSize>2</EnvironmentSize>
    <EstimatedTimePerRun>120</EstimatedTimePerRun>
    <ProjectURL>https://store.steampowered.com/app/712100/</ProjectURL>
    <Maintainer>Feral Interactive</Maintainer>
  </TestProfile>
  <TestSettings>
    <Option>
      <DisplayName>Resolution</DisplayName>
      <Identifier>auto-resolution</Identifier>
      <ArgumentPrefix></ArgumentPrefix>
      <ArgumentPostfix></ArgumentPostfix>
      <DefaultEntry>0</DefaultEntry>
      <Menu>
        <Entry>
          <Name>$VIDEO_WIDTH x $VIDEO_HEIGHT</Name>
          <Value>$VIDEO_WIDTH $VIDEO_HEIGHT</Value>
          <Message></Message>
        </Entry>
      </Menu>
    </Option>
    <Option>
      <DisplayName>Graphics Preset</DisplayName>
      <Identifier>graphics-preset</Identifier>
      <ArgumentPrefix></ArgumentPrefix>
      <ArgumentPostfix></ArgumentPostfix>
      <DefaultEntry>0</DefaultEntry>
      <Menu>
        <Entry>
          <Name>Low</Name>
          <Value>0</Value>
          <Message></Message>
        </Entry>
        <Entry>
          <Name>Medium</Name>
          <Value>1</Value>
          <Message></Message>
        </Entry>
        <Entry>
          <Name>High</Name>
          <Value>2</Value>
          <Message></Message>
        </Entry>
        <Entry>
          <Name>Ultra</Name>
          <Value>3</Value>
          <Message></Message>
        </Entry>
        <Entry>
          <Name>Extreme</Name>
          <Value>4</Value>
          <Message></Message>
        </Entry>
      </Menu>
    </Option>
  </TestSettings>
</PhoronixTestSuite>