gomps-settings-schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "description": "Schema",
      "type": "string"
    },
    "LocalCameraObjectName": {
      "description": "Name of the local object to use as the camera. If this is not defined or this object can't be found, I'll try to find the main camera by myself.",
      "type": "string"
    },
    "LocalPlayerObjectName": {
      "description": "Name of the local object to use as local player. If this is not defined or this object can't be found, I'll use the object given by the LocalCameraObjectName setting.",
      "type": "string"
    },
    "LocalPlayerObjectChildPath": {
      "description": "Path of a child of the local player parent object in the shape of 'ChildA/ChildB/ChildC'. Gets passed to Transform.Find()",
      "type": "string"
    },
    "TextScale": {
      "description": "Scale multiplier for all text generated by Gomps (player names, notes).",
      "type": "number"
    },
    "RemotePlayerObjectScale": {
      "description": "Scale multiplier for the object created for remote players.",
      "type": "number"
    },
    "RemotePlayerObjectPositionOffset": {
      "description": "Position offset to apply to the objects that represent remote players.",
      "type": "string"
    },
    "RemotePlayerObjectEulerOffset": {
      "description": "Euler angles offset to apply to the objects that represent remote players.",
      "type": "string"
    },
    "RemotePlayerShaderName": {
      "description": "Name of a shader to use for the remote player objects. This must be a shader that's already included in the game. If left empty, I'll use one of the custom shaders included with Gomps",
      "type": "string"
    },
    "OriginComponentName": {
      "description": "Name of a Unity Component present in objects to be used as reference points. If this is defined, positions will be relative to the origin object closest to each player. This is useful for games where the scene gets centered around the player, or when players are standing on large, fast moving objects.",
      "type": "string"
    },
    "OriginIgnoreList": {
      "description": "List of names of origin objects to ignore. Only relevant if OriginComponentName is defined.",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}