Module supported_games

Expand description

Registry of all Total War games supported by RPFM.

This module contains the complete list of supported Total War games with their full configuration data. It provides the SupportedGames registry which allows lookup of game information by key.

§Supported Games

RPFM currently supports these Total War games (newest to oldest):

Pharaoh Dynasties (2024)
Pharaoh (2023)
Warhammer 3 (2022)
Troy (2020)
Three Kingdoms (2019)
Warhammer 2 (2017)
Warhammer (2016)
Thrones of Britannia (2018)
Attila (2015)
Rome 2 (2013)
Shogun 2 (2011)
Napoleon (2010)
Empire (2009)
Arena (online game)

§Usage

The primary way to access game information is through the SupportedGames registry:

use rpfm_lib::games::supported_games::{SupportedGames, KEY_WARHAMMER_3};

let games = SupportedGames::default();
let wh3 = games.game(&KEY_WARHAMMER_3).unwrap();
println!("Game: {}", wh3.display_name());

§Game Keys

Each game has a unique key constant (e.g., KEY_WARHAMMER_3) used for programmatic lookup. These keys are also used in directory names and configuration files.

§Adding New Games

To add support for a new Total War game:

Add display name and key constants
Create a GameInfo instance in the SupportedGames::default() implementation
Add the game to the order vector for proper release order sorting
Update relevant tests

Structs§

SupportedGames: Registry of all supported Total War games.

Constants§

DISPLAY_NAME_ARENA: Display name for Total War: Arena.
DISPLAY_NAME_ATTILA: Display name for Total War: Attila.
DISPLAY_NAME_EMPIRE: Display name for Empire: Total War.
DISPLAY_NAME_NAPOLEON: Display name for Napoleon: Total War.
DISPLAY_NAME_PHARAOH: Display name for Total War: Pharaoh.
DISPLAY_NAME_PHARAOH_DYNASTIES: Display name for Total War: Pharaoh Dynasties.
DISPLAY_NAME_ROME_2: Display name for Total War: Rome II.
DISPLAY_NAME_SHOGUN_2: Display name for Total War: Shogun 2.
DISPLAY_NAME_THREE_KINGDOMS: Display name for Total War: Three Kingdoms.
DISPLAY_NAME_THRONES_OF_BRITANNIA: Display name for A Total War Saga: Thrones of Britannia.
DISPLAY_NAME_TROY: Display name for A Total War Saga: Troy.
DISPLAY_NAME_WARHAMMER: Display name for Total War: Warhammer.
DISPLAY_NAME_WARHAMMER_2: Display name for Total War: Warhammer II.
DISPLAY_NAME_WARHAMMER_3: Display name for Total War: Warhammer III.
KEY_ARENA: Unique key for Total War: Arena.
KEY_ATTILA: Unique key for Total War: Attila.
KEY_EMPIRE: Unique key for Empire: Total War.
KEY_NAPOLEON: Unique key for Napoleon: Total War.
KEY_PHARAOH: Unique key for Total War: Pharaoh.
KEY_PHARAOH_DYNASTIES: Unique key for Total War: Pharaoh Dynasties.
KEY_ROME_2: Unique key for Total War: Rome II.
KEY_SHOGUN_2: Unique key for Total War: Shogun 2.
KEY_THREE_KINGDOMS: Unique key for Total War: Three Kingdoms.
KEY_THRONES_OF_BRITANNIA: Unique key for A Total War Saga: Thrones of Britannia.
KEY_TROY: Unique key for A Total War Saga: Troy.
KEY_WARHAMMER: Unique key for Total War: Warhammer.
KEY_WARHAMMER_2: Unique key for Total War: Warhammer II.
KEY_WARHAMMER_3: Unique key for Total War: Warhammer III.