trackmania.tmx module

class trackmania.tmx.GbxFileMetadata(gbx_map_name: str, author_login: str, map_type: str, title_pack: str, track_uid: str, mood: str, display_cost: int, mod_name: str, light_map: int, exe_version: str, exe_build: datetime, author_time: int, environment_name: str, vehicle_name: str)[source]

Bases: TMXObject

New in version 0.3.3.

Represents data stored in the map’s GBX file metadata

Parameters

  • gbx_map_name (str) – Unaltered map name

  • author_login (str) – Unaltered author name

  • map_type (str) – Nadeo map type embedded.

  • title_pack (str) – Titlepack of map

  • track_uid (str) – Unaltered map signature uid

  • mood (str) – Mood of the map (daytime and map base)

  • display_cost (int) – in game metric for map weight

  • mod_name (str | None) – Name of texture mod, if included

  • light_map (int) – Light map version

  • exe_version (str) – Game application version

  • exe_build (datetime) – Build date of game version

  • author_time (int) – Map author time in ms

  • environment_name (str) – Name of the game environment

  • vehicle_name (str) – Name of the game vehicle

class trackmania.tmx.ReplayWRData(wr_id: int | None, wr_time: int | None, wr_user_id: int | None, wr_username: str)[source]

Bases: TMXObject

New in version 0.3.3.

Represents data relating to the wr replay

Parameters

  • wr_id (int | None) – replay id of mx world record

  • wr_time (int | None) – Time of the mx world record

  • wr_user_id (int | None) – userid of the mx world record holder

  • wr_username (str) – mx username of max world record holder

class trackmania.tmx.TMXMap(username: str, map_name: str, track_id: int | None, map_id: int | None, comments: str, map_pack_id: str, user_id: int, route_name: str, length_name: str, difficulty_name: str, laps: int, times: TMXMapTimes, gbx_data: GbxFileMetadata, tags: TMXTags, replay_wr_data: ReplayWRData, metadata: TMXMetadata)[source]

Bases: object

New in version 0.3.3.

Represents a Map from TMX

Parameters

  • username (str) – The username of the map’s creator

  • map_name (str) – The name of the map. The exact same as GbxMapName.

  • track_id (int | None) – The track id of the map

  • map_id (int | None) – The map id of the map

  • comments (str) – Map author’s comments

  • map_pack_id (str) – The map pack id of the map

  • user_id (int) – The user id of the map’s creator

  • route_name (str) – The route name of the map

  • length_name (str) – The length name of the map

  • difficulty_name (str) – The difficulty name of the map

  • laps (int) – The number of laps of the map

  • times (TMXMapTimes) – The uploaded and updated at times of the map.

  • gbx_data (GbxFileMetadata) – The gbx file metadata of the map

  • tags (TMXTags) – The tags of the map

  • replay_wr_data (ReplayWRData) – The replay wr data of the map

  • metadata (TMXMetadata) – The metadata of the map

async classmethod get_map(tmx_id: int) → Self[source]

New in version 0.3.3.

Gets a map’s data using it’s tmx id

Parameters

tmx_id (int) – The tmx id

Returns

The map of the given id.

Return type

TMXMap

async classmethod get_random_map() → Self[source]

Gets a random map from trackmania.exchange

Returns

The random map.

Return type

TMXMap

class trackmania.tmx.TMXMapTimes(uploaded: datetime, updated: datetime)[source]

Bases: TMXObject

New in version 0.3.3.

Represents when the map was uploaded and/or updated on the trackmania.exchange website

Parameters

  • uploaded (datetime) – When the map was uploaded to TMX

  • updated (datetime) – When the map was last updated on TMX

class trackmania.tmx.TMXMetadata(unlisted: bool, unreleased: bool, downloadable: bool, rating_vote_count: int, rating_vote_average: float, has_screenshot: bool, has_thumbnail: bool, has_ghost_blocks: bool, embedded_objects_count: int, embedded_objects_size: int, size_warning: bool, replay_count: int, award_count: int, comment_count: int, image_count: int, video_count: int)[source]

Bases: TMXObject

New in version 0.3.3.

Represents a map’s metadata on TMX

Parameters

  • unlisted (bool) – Whether the map is unlisted on TMX

  • unreleased (bool) – Whether the map is unreleased on TMX

  • downloadeable (bool) – Whether the map is downloadeable on TMX

  • rating_vote_count (int) – The number of votes for the map

  • rating_vote_average (float) – The average rating of the map

  • has_screenshot (bool) – Whether the map has a screenshot

  • has_thumbnail (bool) – Whether the map has a thumbnail

  • has_ghost_blocks (bool) – Whether the map has ghost blocks

  • embedded_objects_count (int) – The number of embedded objects on the map

  • embedded_objects_size (int) – The size of the embedded objects on the map

  • size_warning (bool) – Map exceeds the size limit for online servers (TM: 6MB)

  • replay_count (int) – The number of replays on the map

  • award_count (int) – The number of awards on the map

  • comment_count (int) – The number of comments on the map

  • image_count (int) – The number of custom images on the map

  • video_count (int) – The number of videos on the map

class trackmania.tmx.TMXTags(map_tags: list[int])[source]

Bases: TMXObject

New in version 0.3.3.

Represents TMX Map Tags

Parameters

map_tags (list[int]) – The map tags as a list of integers