For the complete documentation index, see llms.txt. This page is also available as Markdown.

Penalty

Configuration

JSON
{
  "options": {
    "game_square": 450,
    "game_margin": 25,
    "min_aspect_ratio": "600 / 500",
    "number_of_shoot": 5,
    "time_between_shoot": 1000,
    "background": {
      "url": GAME_URL + "/background.png",
      "height": 960,
      "width": 1100
    },
    "ball": {
      "url": GAME_URL + "/ball.png",
      "height": 50,
      "width": 50,
      "speed": 120
    },
    "keeper": {
      "url": GAME_URL + "/keeper.png",
      "height": 126,
      "width": 103,
      "offsetY": 10,
      "speed": {
        "min": 2,
        "max": 7,
        "step": 1
      }
    },
    "goal": {
      "url": GAME_URL + "/goal.png",
      "height": 310,
      "width": 575,
      "offsetY": -87,
      "goal_post_angle": 0.12
    },
    "board": {
      "url": GAME_URL + "/board.png",
      "ratio": "628 / 336",
      "text_color": "white",
      "background_color": "black",
      "progress": true,
      "score": true,
      "goal_emoji": "",
      "miss_emoji": "",
      "unset_emoji": ""
    },
    "visor": {
      "color": "white"
    }
  },
  "texts": {
    "en": {
      "shoot": "Shots: ",
      "score": "Goals: "
    },
    "fr": {
      "shoot": "Tirs : ",
      "score": "Buts : "
    },
    "nl": {
      "shoot": "Kicks: ",
      "score": "Goals: "
    }
  },
  "sounds": {},
  "images": {
    "rewards": {}
  }
}

Options

Key
Type
Explanation
Default

Integer

Actual game zone.

450

Integer

Border around the game zone.

25

String

Aspect ratio to be used if no parent sizing is provided.

"600 / 500"

Integer

Number of times a player can "shoot" the ball.

5

Integer

Delay between each "shoot".

1000

Integer

Background's visual sizes.

960 / 1100

Integer

Ball's visual sizes (to render).

50 / 50

Integer

Speed of the ball.

120

Integer

Keeper's visual sizes (to render).

126 / 103

Integer

Vertical adjustment of the keeper.

10

Integer

Speed of the keeper (min and max, increases after each "goal").

2 / 7

Integer

Speed increasing after each "goal".

1

Integer

Goal's visual sizes (to render).

310 / 575

Integer

Vertical adjustment of the goal.

-87

Number

Border for the goal (the ball will bounce of those areas).

0.12

String

Size ratio of the scoreboard visual.

"628 / 336"

String

Colors of the menu (if no scoreboard visual is provided).

"white" / "black"

Boolean

Display the current progress of the game.

true

Boolean

Display the current score of the game.

true

String

Replace the default text progress, with icons.

"⚽" / "❌" / "⚪"

String

Color of the curve preview (transparent to remove it).

"white"

String

Text displayed in the header.

"Shots: "

String

Text displayed in the header.

"Goals: "

Assets

Key
Size
Explanation
Default

~600 x 600px (adapt background sizes)

Background of the game.

50 x 50px

Visual of the ball.

~100 x 125px (adapt keeper sizes)

Visual of the keeper.

~400 x ...px (adapt goal sizes)

Visual of the goal.

~400 x 200px (adapt board sizes)

Visual of the scoreboard.

Last updated