2.5.0

General

You need the latest dedicated server to access this new api version.

Diff from previous version

Updated callbacks

• Trackmania.Scores
  The players' scores now contain the previous race values.

2.4.0

General

You need the latest dedicated server to access this new api version.

Diff from previous version

Updated callbacks

• Shootmania.UI.Properties
• Trackmania.UI.Properties
  The scores table module now has a new "visible" property in addition to "alt_visible". The former set the general visibility of the scores table displayed when pressing tab or alt. The later only set the visibility of the scores table displayed when pressing alt. If "visible" is false, then the scores table won't be visible when pressing alt even if "alt_visible" is true.

New methods

• Maniaplanet.UI.SetScoresTableVisibility
  Hide or show the scores table for a specific player.

Updated methods

• Shootmania.UI.SetProperties
• Trackmania.UI.SetProperties
  The scores table module now has a new "visible" property in addition to "alt_visible". The former set the general visibility of the scores table displayed when pressing tab or alt. The later only set the visibility of the scores table displayed when pressing alt. If "visible" is false, then the scores table won't be visible when pressing alt even if "alt_visible" is true.

2.3.0

General

You need the latest dedicated server to access this new api version.

Diff from previous version

New callbacks

• Shootmania.UI.Property
• Trackmania.UI.Property
  Callbacks sent by the new *.UI.GetProperty method with the value of one UI property.

Updated callbacks

• Trackmania.UI.Properties
  A new module is available in the properties: viewers_count

New methods

• Shootmania.SetPlayerPoints
  Set the round/map/match points of a player.
• Shootmania.SetTeamPoints
  Set the round/map/match points of a team.
• Shootmania.UI.GetDefaultProperties
• Trackmania.UI.GetDefaultProperties
  Get the default values of all UI properties.
• Shootmania.UI.ResetProperties
• Trackmania.UI.ResetProperties
  Reset all UI properties to their default value.
• Shootmania.UI.GetProperty
• Trackmania.UI.GetProperty
  Request the value of one UI property.
• Shootmania.UI.GetDefaultProperty
• Trackmania.UI.GetDefaultProperty
  Request the default value of one UI property.
• Shootmania.UI.SetProperty
• Trackmania.UI.SetProperty
  Set the value of one UI property.
• Shootmania.UI.ResetProperty
• Trackmania.UI.ResetProperty
  Reset the value of one UI property.

Updated methods

• Trackmania.SetTeamPoints
  The team id are now 0 (Blue) and 1 (Red) instead of 1 (Blue) and 2 (Red).
• Trackmania.UI.SetProperties
  A new module is available in the properties: viewers_count

2.2.0

General

You need the latest dedicated server to access this new api version.

Diff from previous version

New callbacks

• Shootmania.AFK.IsAFK
  This callback is sent when the AFK library detects an AFK player. It will be sent at regular interval until the players are forced into spectator mode. This callback is useful when the "forcespec" property is disabled, which let the server manager handle the action to take against AFK players.
• Shootmania.AFK.Properties
  The current values of the AFK management library properties. This callback can be triggered with the "Shootmania.AFK.GetProperties" method.

Updated callbacks

• Shootmania.Scores
• Trackmania.Scores
  The callback documentation was updated to reflect the change made in the 2.1.1 version.

New methods

• Shootmania.AFK.GetProperties
  Request the current values of the AFK management library properties.
• Shootmania.AFK.SetProperties
  Update the values of the AFK management library properties.

2.1.0

Important

Starting with this release the script xmlrpc api is versioned. You have to use XmlRpc.SetApiVersion to select the version you want to use.

You need the latest dedicated server to access this new api version.

Diff from previous version

Updated callbacks

• Trackmania.UI.Properties
  The positions displayed in the callback documentation are now the correct default values.
  New property live_info that let the user see the position and visibility of the live events displayed in the top left corner of the screen.
  New property spectator_info that let the user see the position and visibility of the informations displayed to the spectators at the bottom of the screen.

New methods

• Trackmania.SetPlayerPoints
  New method to update the score of a player.
• Trackmania.SetTeamPoints
  New method to update the score of a team.

Updated methods

• Trackmania.UI.SetProperties
  The positions displayed in the method documentation are now the correct default values.
  New property live_info that let the user update the position and visibility of the live events displayed in the top left corner of the screen.
  New property spectator_info that let the user update the position and visibility of the informations displayed to the spectators at the bottom of the screen.

2.0.0

Diff from previous version

New callbacks

• Maniaplanet.ChannelProgression_Start
• Maniaplanet.ChannelProgression_End
  New callbacks sent at the beginning and the end of the channel progression screen.
• Trackmania.WarmUp.Status
  New callback to check if the warmup system is available in the current game mode and if it is currently active.

Updated callbacks

• Maniaplanet.StartServer_Start
• Maniaplanet.StartServer_End
  New "mode" property in the JSON payload to know if the game mode script was changed and get its name.
• Maniaplanet.LoadingMap_Start
• Maniaplanet.LoadingMap_End
  New "restarted" property in the JSON payload to know if the map was restarted.
• XmlRpc.CallbackHelp
  New "available" and "disabled" properties in the JSON payload to know if the callback is available in the current game mode and if it is blocked.
• XmlRpc.MethodHelp
  New "available" property in the JSON payload to know if the method is available in the current game mode.
• Trackmania.WarmUp.Stop -> Trackmania.WarmUp.ForceStop
• Trackmania.WarmUp.StopRound -> Trackmania.WarmUp.ForceStopRound
• Maniaplanet.WarmUp.Stop -> Maniaplanet.WarmUp.ForceStop
  Rename the methods to make their intent clearer.

New methods

• Maniaplanet.UI.SetAltScoresTableVisibility
  New method to enable or disable the scores table bound on the alt key on a player by player basis.
• Trackmania.WarmUp.GetStatus
  New method to check if the warmup system is available in the current game mode and if it is currently active.
• Trackmania.Chase.ForceStopRound
  New method for Chase to stop the current round

2017-04-11

You need to update the Combo title and the dedicated server scripts (replace the ones in the GameData folder).

Diff from previous version

New callbacks

• Maniaplanet.Mode.UseTeams
  Used in tandem with the new Maniaplanet.Mode.GetUseTeams method. It allows the user to check if the game mode uses teams or not (value of UseClans from the script)
• Maniaplanet.Pause.Status
  Used in tandem with the new Maniaplanet.Pause.GetStatus method. It allows the user to check the status of the pause system in the game mode.

Updated callbacks

• XmlRpc.ApiVersion
  The "version" value was not properly escaped which caused the JSON payload to be malformed sometimes.
• Maniaplanet.StartServer_Start
• Maniaplanet.StartServer_End
• Maniaplanet.StartMatch_Start
• Maniaplanet.StartMatch_End
• Maniaplanet.StartMap_Start
• Maniaplanet.StartMap_End
• Maniaplanet.StartRound_Start
• Maniaplanet.StartRound_End
• Maniaplanet.StartTurn_Start
• Maniaplanet.StartTurn_End
• Maniaplanet.StartPlayLoop
• Maniaplanet.EndPlayLoop
• Maniaplanet.EndTurn_Start
• Maniaplanet.EndTurn_End
• Maniaplanet.EndRound_Start
• Maniaplanet.EndRound_End
• Maniaplanet.EndMap_Start
• Maniaplanet.EndMap_End
• Maniaplanet.EndMatch_Start
• Maniaplanet.EndMatch_End
• Maniaplanet.EndServer_Start
• Maniaplanet.EndServer_End
• Maniaplanet.LoadingMap_Start
• Maniaplanet.LoadingMap_End
• Maniaplanet.UnloadingMap_Start
• Maniaplanet.UnloadingMap_End
• Maniaplanet.Podium_Start
• Maniaplanet.Podium_End
  All these callbacks now have a "time" property inside the JSON payload that gives the server time (value of Now from the script) at the time of the sending.
• Maniaplanet.StartMap_Start
• Maniaplanet.StartMap_End
  New "restarted" property in the JSON payload that allows the user to know if the map was restarted or not.
• Maniaplanet.EndPlayLoop
  This callback was sent two times instead of one. Once before EndTurn_Start which is correct, but also a second time before EndRound_Start, it is not the case anymore.
• Maniaplanet.WarmUp.Status
  New "available" property in the JSON payload that allows the user to know if the game mode includes a warmup system or not.
• Shootmania.Event.OnHit
  New "points" and "distance" properties in the JSON payload.
• Shootmania.Event.OnArmorEmpty
  New "distance" property in the JSON payload.
• Shootmania.Event.OnPlayerRequestActionChange
  Fix callback documentation that stated that the "actionchange" property was a string. It is an integer. The value was correct in the callback.
• Shootmania.Scores
  Fix callback documentation that gave an id of 0 to the two teams. Left team has id 0 and right has id 1 now. The value was correct in the callback.
  Add a "matchpoints" property to the players' scores in the JSON payload.
• Shootmania.UIProperties -> Shootmania.UI.Properties
  The Shootmania.UIProperties callback was renamed to Shootmania.UI.Properties to match its Trackmania equivalent.
  The callback now returns a third value that are the UI properties in JSON format.
• Trackmania.Scores
  Fix callback documentation that gave an id of 0 to the two teams. Left team has id 0 and right has id 1 now. The value was correct in the callback.
  Trackmania.UI.Properties
  The callback now returns a third value that are the UI properties in JSON format.

Removed callbacks

• Shootmania.Combo.Pause
  Replaced by the Maniaplanet.Pause.Status callback.

New methods

• Maniaplanet.Mode.GetUseTeams
  Used in tandem with the new Maniaplanet.Mode.UseTeams callback. It allows the user to check if the game mode uses teams or not (value of UseClans from the script)
• Maniaplanet.Pause.GetStatus
  Used in tandem with the new Maniaplanet.Pause.Status callback. It allows the user to check the status of the pause system in the game mode.
• Maniaplanet.Pause.SetActive
  Allow the user to enable or disable the pause in the game modes where it is available.

Updated methods

• Shootmania.GetUIProperties -> Shootmania.UI.GetProperties
  The Shootmania.GetUIProperties method was renamed to Shootmania.UI.GetProperties to match its Trackmania equivalent.
• Shootmania.SetUIProperties -> Shootmania.UI.SetProperties
  The Shootmania.SetUIProperties method was renamed to Shootmania.UI.SetProperties to match its Trackmania equivalent.
• Maniaplanet.WarmUp.BlockEndWarmUp
  Allows the user to disable the countdown when all teams' slots are filled and force all players to be ready before ending the warmup.

Removed methods

• Shootmania.Combo.GetPause
  Replaced by the Maniaplanet.Pause.GetStatus method.
• Shootmania.Combo.SetPause
  Replaced by the Maniaplanet.Pause.SetActive method.

2017-04-05

You need the latest Shootmania titles (Battle, Combo, Elite, Joust, Royal, Siege) and the dedicated server scripts linked below (replace the ones in the GameData folder).

Diff from previous version

New callbacks

• Maniaplanet.WarmUp.Start
• Maniaplanet.WarmUp.End
• Maniaplanet.WarmUp.Status
• Shootmania.Combo.Pause
• Shootmania.Elite.StartTurn
• Shootmania.Elite.EndTurn
• Shootmania.Joust.OnReload
• Shootmania.Joust.SelectedPlayers
• Shootmania.Joust.RoundResult
• Shootmania.Royal.Points
• Shootmania.Royal.PlayerSpawn
• Shootmania.Royal.RoundWinner

Updated callbacks

• Trackmania.Event.WayPoint
  Two new properties are now available in the json metadata.
  curracecheckpoints -> contains the checkpoints times of the current race
  curlapcheckpoints -> contains the checkpoints times of the current lap
  If the race is not a multilap then curracecheckpoints and curlapcheckpoints are equal.
• Trackmania.Scores
  Four new properties are now available in the json metadata.
  players[n].bestracerespawns -> the number of respawns of the player during their best race
  players[n].bestracecheckpoints -> the checkpoints times of the player during their best race
  players[n].bestlaprespawns -> the number of respawns of the player during their best lap
  players[n].bestlapcheckpoints -> the checkpoints times of the player during their best lap
• Trackmania.Event.Respawn
  The nbrespawn property is renamed to nbrespawns (with an s)

New methods

• XmlRpc.BlockCallbacks
• XmlRpc.UnblockCallbacks
• Maniaplanet.WarmUp.Extend
• Maniaplanet.WarmUp.Stop
• Maniaplanet.WarmUp.GetStatus
• Shootmania.Combo.GetPause
• Shootmania.Combo.SetPause
• Shootmania.Combo.SetTimersPosition
• Shootmania.Siege.SetProgressionUIPosition
• Trackmania.ForceEndRound

Initial version

This version is available since the beginning of the Maniaplanet 4 beta.