Skip to content

Commit

Permalink
docs: new comp tool URL, fix S_PickBanStartAuto description (#50)
Browse files Browse the repository at this point in the history 
* docs: update comp tool URL, fix incorrect `S_PickBanStartAuto` description

* docs: mark `S_TrackmaniaUIProperties` as deprecated
  • Loading branch information
@resir014
resir014 authored Jul 11, 2024
1 parent 6f57b76 commit 7c96087
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 42 deletions.
2 changes: 1 addition & 1 deletion docs/club/activities/competition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Competition activities allow for the creation of ingame competitive events via the usage of the Competition Tool.

These activities cannot be created in the game and instead have to be created on the [Competition Tool website](https://admin.trackmania.nadeo.club/).
These activities cannot be created in the game and instead have to be created on the [Competition Tool website](https://www.trackmania.com/competition).

For more help with the competition tool, please refer to the [Competition Tool category](/club/competition-tool/) of this documentation.

Expand Down
2 changes: 1 addition & 1 deletion docs/club/competition-tool/administration/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This section contains guides on administrative actions for Competitions, such as adding players/spectators to a competition, match server management, among other things.

You can view a list of all competition you created, or that you're an admin of, on [this page](https://admin.trackmania.nadeo.club/competitions).
You can view a list of all competition you created, or that you're an admin of, on [this page](https://www.trackmania.com/competition).
2 changes: 1 addition & 1 deletion docs/club/competition-tool/create-competition/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

In order to create and manage Competitions for a club you must either have the **Creator**, **Admin** or **Content Creator** role for that club.

To create a Competition activity, you need to visit the [Competition Tool website](https://admin.trackmania.nadeo.club/). To get started, log in to the Competition Tool using your Ubisoft account, and then click on "Create Competition."
To create a Competition activity, you need to visit the [Competition Tool website](https://www.trackmania.com/competition). To get started, log in to the Competition Tool using your Ubisoft account, and then click on "Create Competition."

## Basic Information

Expand Down
2 changes: 1 addition & 1 deletion docs/club/competition-tool/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ The Competition tool is provided for club administrators to create and manage Co

## Accessing the Competition tool

You can find the Competition tool [on this link](https://admin.trackmania.nadeo.club). You have to sign in with your Ubisoft account to access the Competition tool dashboard.
You can find the Competition tool [on this link](https://www.trackmania.com/competition). You have to sign in with your Ubisoft account to access the Competition tool dashboard.
76 changes: 38 additions & 38 deletions docs/club/competition-tool/plugin-settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,43 +12,42 @@ Below is a reference of plugin settings available to use on the competition tool

Display a carousel of images.

| Setting name | Type | Default value | Description |
|:---------------|:-------|:---------------|:---------------------------------------------------------------------------------|
| S_AdImageUrls | String | `""` | Urls separated by a pipe character (`\|`).<br/>Add a value to enable the plugin. |
| Setting name | Type | Default value | Description |
| :------------ | :----- | :------------ | :------------------------------------------------------------------------------- |
| S_AdImageUrls | String | `""` | Urls separated by a pipe character (`\|`).<br/>Add a value to enable the plugin. |

## Qualifier

Settings used for qualifiers (round challenges).

| Setting name | Type | Default value | Description |
|:----------------------|:--------|:---------------|:------------------------------------------------------------------------------------------------|
| S_UsePlayListComplete | Boolean | `False` | Complete the challenge when the map playlist is over for the first time (forbid playlist loop). |
| Setting name | Type | Default value | Description |
| :-------------------- | :------ | :------------ | :---------------------------------------------------------------------------------------------- |
| S_UsePlayListComplete | Boolean | `False` | Complete the challenge when the map playlist is over for the first time (forbid playlist loop). |

## Competition whitelist

Allow only the players registered to a competition to join a server.

| Setting name | Type | Default value | Description |
|:--------------------------------|:--------|:---------------|:-----------------------|
| S_UseCompetitionWhitelistPlugin | Boolean | `False` | Enable the plugin. |
| S_CompetitionId | String | `""` | ID of the competition. |

| Setting name | Type | Default value | Description |
| :------------------------------ | :------ | :------------ | :--------------------- |
| S_UseCompetitionWhitelistPlugin | Boolean | `False` | Enable the plugin. |
| S_CompetitionId | String | `""` | ID of the competition. |

## Match management

Automatically enabled for all matches.

| Setting name | Type | Default value | Description |
|:-----------------------------------|:--------|:---------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| S_AutoStartMode | String | `""` | Possible values:<br/>- `""`: disabled <br/>- `"delay"`: automatically start the match at start date + delay <br/>- `"light"`: the match starts automatically right away after the server starts. |
| S_AutoStartDelay | Integer | `600` | Delay in seconds used by the "delay" mode. |
| S_PickBanStartAuto | Boolean | `False` | Automatically start a Pick & Ban phase 10 minutes before the match start. |
| S_PickBanOrder | String | `""` | Sequence of string separated by a comma. Starting with "p" for pick or "b" for ban, followed by ":" and a number representing team position, player position or "r" for random (e.g. "b:1,b:0,p:0,p:1,p:r").<br/>See more examples below. |
| S_EnableReadyManager | Boolean | `True` | Do not depends on players readiness to automatically start the match |
| S_UseAutoReady | Boolean | `False` | A connected player is automatically considered ready |
| S_ReadyStartRatio | Integer | `1.0` | Minimum value the ratio “ready players”/“all players” must reach to start the match |
| S_ReadyMinimumTeamSize | Integer | `1` | The minimum number of members a team needs to be considered ready |
| S_DisableForceSpectatorOnComplete | Boolean | `False` | Do not force all players in spectator mode when the match is over |
| Setting name | Type | Default value | Description |
| :-------------------------------- | :------ | :------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| S_AutoStartMode | String | `""` | Possible values:<br/>- `""`: disabled <br/>- `"delay"`: automatically start the match at start date + delay <br/>- `"light"`: the match starts automatically right away after the server starts. |
| S_AutoStartDelay | Integer | `600` | Delay in seconds used by the "delay" mode. |
| S_PickBanStartAuto | Boolean | `False` | Automatically start a Pick & Ban phase during the match start time. |
| S_PickBanOrder | String | `""` | Sequence of string separated by a comma. Starting with "p" for pick or "b" for ban, followed by ":" and a number representing team position, player position or "r" for random (e.g. "b:1,b:0,p:0,p:1,p:r").<br/>See more examples below. |
| S_EnableReadyManager | Boolean | `True` | Do not depends on players readiness to automatically start the match |
| S_UseAutoReady | Boolean | `False` | A connected player is automatically considered ready |
| S_ReadyStartRatio | Integer | `1.0` | Minimum value the ratio “ready players”/“all players” must reach to start the match |
| S_ReadyMinimumTeamSize | Integer | `1` | The minimum number of members a team needs to be considered ready |
| S_DisableForceSpectatorOnComplete | Boolean | `False` | Do not force all players in spectator mode when the match is over |

!!! example "Examples for Match autostart"

Expand Down Expand Up @@ -84,7 +83,7 @@ Automatically enabled for all matches.
```

The same can be done for solo competitions, where there can be more than 2 participants in a match.

```
b:3,b:2,b:1,b:0,p:0,p:1,p:2,p:3
```
Expand All @@ -95,37 +94,38 @@ Automatically enabled for all matches.

Send a message in the chat every 75 seconds.

| Setting name | Type | Default value | Description |
|:------------------------|:-------|:---------------|:------------------------------------------------------------|
| S_MessageTimer | String | `""` | The message to send. Add a value to enable the plugin. |
| Setting name | Type | Default value | Description |
| :------------- | :----- | :------------ | :----------------------------------------------------- |
| S_MessageTimer | String | `""` | The message to send. Add a value to enable the plugin. |

## Minimum rank

Display a popup and UI in-game to inform the players about the minimum rank required to qualify for the next round.

| Setting name | Type | Default value | Description |
|:-----------------------------|:--------|:----------------|:-----------------------------------|
| S_UsePlayerMinimumRankPlugin | Boolean | `False` | Enable the plugin. |
| S_MinimumRank | String | `0` | The rank to reach to be qualified. |

| Setting name | Type | Default value | Description |
| :--------------------------- | :------ | :------------ | :--------------------------------- |
| S_UsePlayerMinimumRankPlugin | Boolean | `False` | Enable the plugin. |
| S_MinimumRank | String | `0` | The rank to reach to be qualified. |

## Time limit

Limit the duration a player can stay on a server.

| Setting name | Type | Default value | Description |
|:---------------------|:--------|:---------------|:---------------------------------------------------------------------------------------------------------------|
| S_UseTimeLimitPlugin | Boolean | `False` | Enable the plugin. |
| S_TimeLimitDuration | Integer | `300` | The duration a player can stay on the server in seconds, based on the player's first connection to the server. |
| Setting name | Type | Default value | Description |
| :------------------- | :------ | :------------ | :------------------------------------------------------------------------------------------------------------- |
| S_UseTimeLimitPlugin | Boolean | `False` | Enable the plugin. |
| S_TimeLimitDuration | Integer | `300` | The duration a player can stay on the server in seconds, based on the player's first connection to the server. |

## Trackmania UI

| Setting name | Type | Default value | Description |
|:----------------------------|:-------|:----------------|:-------------------------------------------------------|
| S_TrackmaniaUIProperties | String | `""` | The UI properties to hide. Add value to enable the plugin. |
| Setting name | Type | Default value | Description |
| :----------------------- | :----- | :------------ | :------------------------------------------------------------------------- |
| S_TrackmaniaUIProperties | String | `""` | **Deprecated.** The UI properties to hide. Add value to enable the plugin. |

!!! example "Example of a valid S_TrackmaniaUIProperties value"

See all available options in [this page](https://github.com/maniaplanet/script-xmlrpc/blob/master/XmlRpcListing.md#trackmaniauiproperties).

```xml
<ui_properties><round_scores visible='false'/></ui_properties>
```

0 comments on commit 7c96087

Please sign in to comment.