Skip to main content

Search GiselleBot's commands and docs.

Try /ban, or start with / for commands only.

Press Ctrl K anywhere in the dashboard to open this.

Mahjong Soul Integration

This module has a few commands that report on Mahjong Soul, a Japanese mahjong game platform from Cat Food Studio, distributed in its English and Japanese versions by Yostar. The game runs in a browser, with Android and iOS apps planned.

The game was released in 3 regions:

  • CN (Chinese)
  • JP (Japanese)
  • EN (English/Global)

Commands

/mahjongsoul status

Command Syntax

/mahjongsoul status [region:{en/jp/cn}]

Command Description

Checks the status of Mahjong Soul's game servers. Omitting region defaults to en, the English servers.

Permissions Needed

Examples

/mahjongsoul status
/mahjongsoul status region:cn

Server Status Live Feed

The Mahjong Soul Server Status Feed watches server availability for any region and posts to one or more of the webhooks configured in your Discord server when something changes.

See also

The feed posts through Discord webhooks, so you need to know how they work. See this official guide for an introduction.

By default the feed mascot is the Mahjong Soul character Ichihime, and the feed messages are Mahjong Soul-themed.

The full list of feed messages and monitored transitions is in this Google Spreadsheet.

Note

A few rows in the spreadsheet are highlighted in yellow and not used for now, for technical reasons. They will be filled in if they become applicable.

Each message ends with a list of hashtags that users can filter on. They give:

  • The region code the message refers to: #cn #en #jp
  • The region's current status as a technical status tag: #gateway_error #maintenance #partial_maintenance #server_outage #operational
  • If the game has maintenance notes, the message includes them and tracks changes during a maintenance.
  • The quote ID (see the Mahjong Soul Server Status Feed Sentences Google Spreadsheet) for the region status transition and/or server status transition: e.g. #r_01 #r_02 s_02 ...

Mahjong Soul Status Feed Example

Feed management (dashboard)

Note

You start, edit, list and remove status feed webhooks from your server's Mahjong Soul page on the dashboard. The settings below still apply; only where you configure them has changed.

Warning

Discord webhooks currently do not authenticate the messages sent to them. Anyone who knows a webhook URL can, with some effort, use external tools to forge a message with any content and post it to that webhook.

Feed fields

  • Webhook URL: the Discord webhook the feed posts status transitions to. Set once when creating the feed - pasting a new URL later requires deleting and re-creating the feed.
  • Regions: a checkbox filter for Mahjong Soul server regions (cn, en, jp). Leave all unchecked to match every region.
  • Filter Words: a whitelist of words or phrases that a status transition's quote text or hashtags must contain (or, with the "Exclude Matches" checkbox, must not contain) before it is posted; Filter Mode below combines them. Enter one word or phrase per line - there is no comma-separated list and no quoting syntax, so a multi-word phrase like partial maintenance is just its own line. Matching is case-insensitive and works on partial words. Leave empty for no filter.
  • Filter Mode: OR (any filter word matches) or AND (every filter word must match).
  • Exclude Matches Instead of Including Them: turns the Filter Words whitelist into a blacklist.
  • Custom Header: replaces the default message template posted above each status transition (max 1024 characters). Supports the dynamic tags below.
  • Webhook Display Name: overrides the webhook's posted username (max 32 characters). Leave blank to keep the webhook's own name.
  • Do Not Overwrite the Webhook's Username / Avatar: two independent checkboxes that keep the webhook's own posted username and/or avatar instead of the module's automated ones.

Permissions needed on the dashboard: Manage Webhooks (server-side)

Note

Custom headers can be formatted as embeds with a specific syntax. Both GiselleBot and Discord are strict about it, and special characters break it easily, so embeds as a header are not recommended and not supported. Use them at your own risk. If you want to try, this embed generator can help (click "Enable webhook mode" at the bottom of the page).

Custom headers support these dynamic tags, replaced at run time:

  • %region%: the region name, capitalized (e.g. Chinese, English, ...)
  • %region_code%: the region code, uppercase (e.g. CN, EN, ...)
  • %timestamp% or %timestamp_utc%: the status transition time in UTC, with format YYYY-MM-DD HH:mm:ss (UTC).
  • %timestamp_iso%: the status transition time in UTC, as an ISO8601 string.
  • %timestamp_pst%: the status transition time in PST, with format YYYY-MM-DD HH:mm:ss (PST).

Timestamp tags accept a custom time zone. Replace the utc part with either:

  • A different valid IANA time zone identifier (e.g. America/New_York, Europe/London).

  • An UTC offset in the form [UTC/GMT](+/-)(hours)[:][minutes], for example:

    • %timestamp_Europe/London%
    • %timestamp_America/Los_Angeles%
    • %timestamp_Japan%
    • %timestamp_PST8PDT%
    • %timestamp_+0800%
    • %timestamp_-10:30%
    • %timestamp_UTC+2%

The quote text, including its hashtags, is appended after every header.

Default header: Jyanashi Sama, Ichihime here with an important message for you from the %region% region!

Default webhook display name: "MahjongSoul Status Feed :: Offered by GiselleBot"

See also

Full migration mapping for these commands: Migration Guide.