Rizline:Game config.json: Difference between revisions

From Rhythm Game Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:game_config.json}}
{{DISPLAYTITLE:game_config.json}}


<code>game_config.json</code> is a file that contains information about the current [[Rizline:game version|game version]] and [[Rizline:asset version|asset version]]. When the ''[[Rizline:Rizline|Rizline]]'' app is started, the game downloads the <code>game_config.json</code> file from <code>https://rizlineassetstore.pigeongames.cn/configs/game_config.json</code> to check for updates.
<code>game_config.json</code> is a file that contains information about the current [[Rizline:game version|game version]] and [[Rizline:asset version|asset version]]. When the ''[[Rizline:Rizline|Rizline]]'' app is started, the game downloads the <code>game_config.json</code> file from <code><nowiki>https://rizlineassetstore.pigeongames.cn/configs/game_config.json</nowiki></code> to check for updates.


= JSON Format =
= JSON Format =
== New format ==


This format is in use since [[Rizline:Rizline 1.0.10|Rizline 1.0.10]].
This format is in use since [[Rizline:Rizline 1.0.10|Rizline 1.0.10]].


{{Todo}}
{{DataStructure|
  {{DataStructureField|configs|array|List of configurations for different game versions.|
    {{DataStructureField||object|A configuration.|
      {{DataStructureField|version|string|App version that this config is intended for.}}
      {{DataStructureField|resourceUrl|string|URL to download the [[Rizline:assets|assets]] from. Can be an empty string.}}
      {{DataStructureField|maintenanceInfo|object, optional|Information about server maintenance. See [[#Maintenance Info format]] for details.}}
    }}
  }}
  {{DataStructureField|minimalVersion|string|The minimal game version.}}
  {{DataStructureField|maintenanceInfo|object, optional|Information about server maintenance. See [[#Maintenance Info format]] for details.}}
}}
 
=== Maintenance Info format ===
{{DataStructure|
  {{DataStructureField|time|string|Date and time of the end of the maintenance period.}}
  {{DataStructureField|zhHans|string|Server maintenance message in Chinese (Simplified). The string may contain the substring <code>{TIME}</code>, which will get replaced by the value of the <code>time</code> field above.}}
  {{DataStructureField|zhHant|string|Server maintenance message in Chinese (Traditional). The string may contain the substring <code>{TIME}</code>, which will get replaced by the value of the <code>time</code> field above.}}
  {{DataStructureField|en|string|Server maintenance message in English. The string may contain the substring <code>{TIME}</code>, which will get replaced by the value of the <code>time</code> field above.}}
  {{DataStructureField|ja|string|Server maintenance message in Japanese. The string may contain the substring <code>{TIME}</code>, which will get replaced by the value of the <code>time</code> field above.}}
}}


= JSON Format (old) =
== Old format ==


This format was used before [[Rizline:Rizline 1.0.10|Rizline 1.0.10]].
This format was used before [[Rizline:Rizline 1.0.10|Rizline 1.0.10]].

Revision as of 10:03, 1 December 2024


game_config.json is a file that contains information about the current game version and asset version. When the Rizline app is started, the game downloads the game_config.json file from https://rizlineassetstore.pigeongames.cn/configs/game_config.json to check for updates.

JSON Format

New format

This format is in use since Rizline 1.0.10.

  • (root)
    • configs (array) - List of configurations for different game versions.
      • (object) - A configuration.
        • version (string) - App version that this config is intended for.
        • resourceUrl (string) - URL to download the assets from. Can be an empty string.
        • maintenanceInfo (object, optional) - Information about server maintenance. See #Maintenance Info format for details.
    • minimalVersion (string) - The minimal game version.
    • maintenanceInfo (object, optional) - Information about server maintenance. See #Maintenance Info format for details.

Maintenance Info format

  • (root)
    • time (string) - Date and time of the end of the maintenance period.
    • zhHans (string) - Server maintenance message in Chinese (Simplified). The string may contain the substring {TIME}, which will get replaced by the value of the time field above.
    • zhHant (string) - Server maintenance message in Chinese (Traditional). The string may contain the substring {TIME}, which will get replaced by the value of the time field above.
    • en (string) - Server maintenance message in English. The string may contain the substring {TIME}, which will get replaced by the value of the time field above.
    • ja (string) - Server maintenance message in Japanese. The string may contain the substring {TIME}, which will get replaced by the value of the time field above.

Old format

This format was used before Rizline 1.0.10.

  • (root)
    • configs (array) - List of configurations for different game versions.
      • (object) - A configuration.
        • version (string) - App version that this config is intended for.
        • resourceUrl (string) - URL to download the assets from.
    • minimalVersion (string) - The minimal game version.
    • underMaintenance (bool) - Are the servers currently under maintenance?
    • maintenanceNoticeZhHans (string) - Server maintenance message in Chinese (Simplified).
    • maintenanceNoticeZhHant (string) - Server maintenance message in Chinese (Traditional).
    • maintenanceNoticeEn (string) - Server maintenance message in English.
    • maintenanceNoticeJa (string) - Server maintenance message in Japanese.