tourpings host add - shinyfinder/chatot-smogon GitHub Wiki

Usage

Availability: All Guilds

/tourpings host add <tour> <role> [psladder]

  • tour: Description of the tour that identifies the games being pinged for
  • role: The role you ping to announce games for this tour
  • psladder (Optional): Name of the ladder on PS associated with the tour (i.e. gen9ou, gen8monotype)

Example:

/tourpings host add tour:Tour Name role:465789 psladder:gen9ou

Permissions

  • Chatot: View Channel where role is pinged
  • Users: Ban Members

Description

Summary: Adds a role whose pings other servers can subscribe to.

Whenever the role gets pinged in your server, any servers subscribed to the tour will be pinged in their servers as well. When choosing a name for the tour, pick something that makes it clear what you are pinging for, i.e. SV OU SPL, WCOP, SCL, etc. The name you enter for tour is how other servers know what they are subscribing to. If you do not specify a psladder, subscribers will be notified of all pings of the role. Specifying a psladder allows for subscribers to have more granular control over what they get alerted for. For example, the Smogon tours server may ping @SCL Matches for all matches regarding SCL. By setting running the command with the following

/tourpings host add tour:SCL role:@SCL Matches

Servers that subscribe to SCL will be notified of all matches regardless of the ladder; i.e. whenever @SCL Matches is pinged. Building on the above, if an additional tour SCL SV OU is setup with

/tourpings host add tour:SCL SV OU role:@SCL Matches psladder:gen9ou

Then other servers will see SCL and SCL SV OU as tour options to subscribe to. The former will notify them anytime the @SCL Matches role is pinged. The latter will notify them only when @SCL Matches is pinged for gen9ou matches.

The setup is subject to the following restrictions:

  • The name of the tour must be unique
  • The combination of psladder + role must be unique

The first restriction is self-explanatory: you can't use the same name for multiple tours. The second restriction means that 2 different tours cannot use the same combination of ladder and role. If you are trying to ping for multiple tours within your tier, each tour must be associated with a different role.

For the ping to work, the role and URL must be sent in the same message. At this time, only the play.pokemonshowdown.com and smogtours.psim.us domains are whitelisted.

Only official Smogon servers are able to manage pings that others can subscribe to.

⚠️ **GitHub.com Fallback** ⚠️