> For the complete documentation index, see [llms.txt](https://obey.gitbook.io/wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://obey.gitbook.io/wiki/coinflips/features/sign-input.md).

# Sign GUI Input

Documentation for the virtual SignGUI input editor.

The **Sign GUI Input** feature provides an optional virtual sign editor for players to enter their wager amount when creating a coinflip. This replaces the traditional chat input mechanism and improves user experience by staying within a graphical interface.

***

## Configuration

You can enable or disable the sign input feature under the `coinflip.sign-input` section in `config.yml`:

```yaml
coinflip:
  # ...
  sign-input:
    enable: false
    type: DARK_OAK_SIGN
    color: YELLOW
```

* `enable`: If `true`, the sign editor opens upon clicking the "Create Coinflip" item. If `false`, the plugin prompts the player in chat.
* `type`: The Material type of the sign block displayed virtually (e.g. `DARK_OAK_SIGN`, `OAK_SIGN`, `SPRUCE_SIGN`).
* `color`: The DyeColor of the text (e.g. `YELLOW`, `WHITE`, `BLACK`).

***

## Messages & Layout

The lines printed on the virtual sign can be translated and configured inside the plugin's `messages.yml`:

```yaml
create-sign-lines:
  - ""
  - "^^^^^^^^^^^^^^^"
  - "Enter Amount"
  - "To Coinflip"
```

* **Line 1 (Index 0)**: Must be kept empty (`""`) as it represents the space where the player types their wager amount (e.g. `1000`, `1k`, `10m`).
* **Lines 2-4 (Indexes 1-3)**: Visual instructions guiding the player on what to do.

***

## Aborting Coinflip Creation

If a player wishes to cancel creating a coinflip while the sign GUI is open, they can simply:

1. Close the sign editor without typing anything.
2. Type `"cancel"` on the first line and submit.

Both actions abort the creation process gracefully, trigger the `cancel-creation` sound, and print a cancellation confirmation message in chat.