doc.json

{
  "name": "img2brick",
  "description": "Render images in game",
  "author": "cake",
  "config": {
    "only-authorized": {
      "description": "Whether only authorized players can use img2brick commands",
      "type": "boolean",
      "default": true
    },
    "authorized-users": {
      "description": "List of players who can always img2brick commands",
      "type": "players",
      "default": []
    },
    "cooldown": {
      "description": "Cooldown for time between loads (seconds)",
      "type": "number",
      "default": 30
    },
    "max-size": {
      "description": "Maximum width or height of images to brickify",
      "type": "number",
      "default": 512
    },
    "max-filesize": {
      "description": "Maximum downloadable file size (bytes)",
      "type": "number",
      "default": 5000000
    },
    "quilt-mode": {
      "description": "A mode where every image uploaded is on a quilt-size grid",
      "type": "boolean",
      "default": false
    },
    "quilt-size": {
      "description": "Size of the quilt grid, images must have dimensions a multiple of this. Min: 8",
      "type": "number",
      "default": 16
    }
  },
  "commands": [
    {
      "name": "!img",
      "description": "Convert an image to bricks and place them under your player",
      "example": "!img https://imgur.com/image.png",
      "args": [{
        "name": "url",
        "description": "Url of image to download and convert",
        "required": true
      }]
    },
    {
      "name": "!img:tile",
      "description": "Same as !img but renders saves as tiled bricks",
      "example": "!img:tile https://imgur.com/image.png",
      "args": [{
        "name": "url",
        "description": "Url of image to download and convert",
        "required": true
      }]
    },
    {
      "name": "!img:quilt-reset",
      "description": "Clear the stored quilt in memory (host/authorized only)",
      "example": "!img:quilt-reset",
      "args": []
    },
    {
      "name": "!img:quilt-fix",
      "description": "Remove the section of the quilt the player is over (host/authorized only)",
      "example": "!img:quilt-fix all",
      "args": [{
        "name": "all",
        "description": "When provided, removes all sections by this owner",
        "required": false
      }]
    },
    {
      "name": "!img:quilt-info",
      "description": "See how many contributions you have made to the quilt",
      "example": "!img:quilt-info all",
      "args": [{
        "name": "all",
        "description": "See complete quilt information when provided (host only)",
        "required": false
      }]
    },
    {
      "name": "!img:quilt-preview",
      "description": "Preview the bricks in the image below the player (host only)",
      "example": "!img:quilt-preview [all, broken]",
      "args": [{
        "name": "all",
        "description": "See preview for every brick owned by this player",
        "required": false
      }, {
        "name": "broken",
        "description": "See preview for every broken cell",
        "required": false
      }]
    }
  ]
}