Skip to content

Configurate ranked mods

MingxuanGame edited this page Sep 30, 2025 · 1 revision

By modifying config/ranked_mods.json to make it.

Example:

{
  "0": {
    "EZ": {
      "retries": {
        "type": "number",  // this is required, see `static/mods.json` to fill type
        "eq": 2  // the value is needed to be equal to this.
      }
    },
    "NF": {},  // empty object means no check.
    "HT": {
      "speed_change": {
        "type": "number",
        "eq": 0.75
      },
      "adjust_pitch": {
        "check": false,  // marking `check` is `false` to skip the check of this field.
        "type": "boolean"
      }
    },
    "DT": {
      "speed_change": {
        "type": "number",
        "le": 2,  // arguments passed into pydantic to validate, see https://docs.pydantic.dev/latest/concepts/fields/
        "ge": 1
      }
      // fields not defined in here are disallowed.
    }
    // mods not defined in here are disallowed.
  },
  "1": {...},
  "$mods_checksum": "md5-checksum of static/mods.json"
}

If this file is not existed, the server will generate it by ENABLE_ALL_MODS_PP automatically, or you can use tools/generate_ranked_mods.py to generate.

$ python tools/generate_ranked_mods.py  # default
$ python tools/generate_ranked_mods.py --all # all mods
Clone this wiki locally