> For the complete documentation index, see [llms.txt](https://doc.lucky-cycle.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.lucky-cycle.com/games/index/pinball.md).

# Pinball

{% hint style="warning" %}
Demo: <https://campaigns.lucky-cycle.com/utils/games?game=pinball>
{% endhint %}

1. [#configuration](#configuration "mention")
2. [#options](#options "mention")
3. [#assets](#assets "mention")

### Configuration

<details>

<summary>JSON</summary>

```json
{
  "options": {
    "header_text_color": "white",
    "header_background_color": "black",
    "sound_color": "white",
    "balls": 3
  },
  "texts": {
    "en": {
      "play_button": "Play now",
      "sound_on": "Turn the sound on",
      "sound_off": "Turn the sound off",
      "chance": "Chance:",
      "score": "Score:"
    },
    "fr": {
      "play_button": "Je joue",
      "sound_on": "Activer les sons",
      "sound_off": "Désactiver les sons",
      "chance": "Chance&nbsp;:",
      "score": "Score&nbsp;:"
    },
    "nl": {
      "play_button": "Speel nu",
      "sound_on": "Zet geluid aan",
      "sound_off": "Zet geluid uit",
      "chance": "Kans:",
      "score": "Score:"
    }
  },
  "images": {
    "background": GAME_URL + "/background.png",
    "overlay": GAME_URL + "/overlay.png",
    "paddle": GAME_URL + "/paddle.png",
    "ball": GAME_URL + "/ball.png",
    "buttons": "",
    "rewards": {}
  },
  "sounds": {
    "points": "",
    "background": ""
  }
}
```

</details>

### Options

<table><thead><tr><th>Key</th><th>Type</th><th>Explanation</th><th>Default</th></tr></thead><tbody><tr><td><pre><code>header_text_color / header_background_color
</code></pre></td><td>String</td><td>Color and background of the header.</td><td>"white" / "black"</td></tr><tr><td><pre><code>sound_color
</code></pre></td><td>String</td><td>Color of the sound (on/off) icons <em><mark style="color:red;">(only displayed if sounds are provided)</mark></em>.</td><td>"white"</td></tr><tr><td><pre><code>balls
</code></pre></td><td>Int</td><td><p>Number of chances (balls).</p><p><em><mark style="color:blue;">Score = sum([scores])</mark></em></p></td><td>3</td></tr><tr><td><pre><code>texts > play_button
</code></pre></td><td>String</td><td>Text of the CTA to start the game.</td><td>"Play now"</td></tr><tr><td><pre><code>texts > sound_on / sound_off
</code></pre></td><td>String</td><td>Aria-label of the sound icons <em><mark style="color:red;">(only displayed if sounds are provided)</mark></em>.</td><td>"Turn the sound on" / "Turn the sound off"</td></tr><tr><td><pre><code>texts > chance
</code></pre></td><td>String</td><td>Label in the header for the number of chances.</td><td>"Chance:"</td></tr><tr><td><pre><code>texts > score
</code></pre></td><td>String</td><td>Label in the header for the score.</td><td>"Score:"</td></tr></tbody></table>

### Assets

<table><thead><tr><th>Key</th><th>Size</th><th>Explanation</th><th>Default</th></tr></thead><tbody><tr><td><pre><code>background
</code></pre></td><td>720 x 1280</td><td>Background of the game.</td><td><a href="https://statics.lucky-cycle.com/files/_games/pinball/background.png">/background.png</a></td></tr><tr><td><pre><code>overlay
</code></pre></td><td>720 x 1280</td><td>Overlay of the game. <mark style="color:$warning;">Shape must be respected!</mark></td><td><a href="https://statics.lucky-cycle.com/files/_games/pinball/overlay.png">/overlay.png</a></td></tr><tr><td><pre><code>paddle
</code></pre></td><td>250 x 80</td><td>Paddle visual <em>(reversed for the second one)</em>. <mark style="color:$warning;">Shape must be respected!</mark></td><td><a href="https://statics.lucky-cycle.com/files/_games/pinball/paddle.png">/paddle.png</a></td></tr><tr><td><pre><code>ball
</code></pre></td><td>100 x 100</td><td>Visual of the ball. <mark style="color:$warning;">Must be square!</mark></td><td><a href="https://statics.lucky-cycle.com/files/_games/pinball/ball.png">/ball.png</a></td></tr><tr><td><pre><code>buttons
</code></pre></td><td></td><td>Visual used for the buttons.</td><td>/</td></tr></tbody></table>