> For the complete documentation index, see [llms.txt](https://symbiote-development.gitbook.io/symbiote-development-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://symbiote-development.gitbook.io/symbiote-development-docs/plugins/cwelcomer/configuration.md).

# Configuration

## Need help or have suggestions?

If you got any questions, suggestions or need help, please do not hesitate and join our [discord ](https://discord.gg/nWwUQJwG9F)to ask for help!

We are there to assist you.

To get the license key join our discord and open a ticket than add the license key in the license.json file

## Example configuration

{% code title="config.yml" %}

```yaml
# PlayerWelcomer Configuration

# Configure welcome messages and rewards for new players.
# Supports hex color codes (e.g., #FF0000) and legacy Minecraft color codes (ex. : &a).

first-join:
  enabled: true # Enable/disable first-join welcome messages (true/false)
  line_count: 5 # Number of message lines (must match the number of lines below, including empty ones)
  message:
    line1: "#808080&m====================" # Top border (gray, strikethrough)
    line2: "" # Empty line for spacing
    line3: "#00FF00&lWelcome #FFFF00%player_name% #808080to the server! #808080[&f#%unique_join_count%#808080]" # Welcome message with player name and join count
    line4: "" # Empty line for spacing
    line5: "#808080&m====================" # Bottom border (gray, strikethrough)

welcome-command:
  enabled: true # Enable/disable the /welcome command (true/false)
  cooldown: 60 # Cooldown in seconds after a successful /welcome

  # Reward type for the /welcome command. Choose one:
  # - "currency": Gives in-game currency via a selected currency plugin
  # - "crate_key": Gives crate keys via Excellent Crates (requires Excellent Crates plugin)
  reward-type: "currency"

  # Currency type for currency rewards. Choose one:
  # - "vault": Uses Vault with an economy plugin (ex. : EssentialsX for coins)
  # - "playerpoints": Uses PlayerPoints for points
  # - "coinsengine:<currency_id>": Uses CoinsEngine with a specific currency (ex. : "coinsengine:gold")
  reward-currency: "playerpoints"

  # Amount of reward:
  # - For "currency", specifies the amount of money/points (ex. : 100.0 for 100 coins, 10 for 10 points)
  # - For "crate_key", specifies the number of keys (must be a positive integer, ex. : 1)
  reward-amount: 100.0

  # Crate key ID from Excellent Crates (ex. : "Test Key"). Required only if reward-type is "crate_key".
  # Can be omitted if reward-type is "currency".
  crate-key-name: "Test Key"
  welcome-message: "#00FF00Welcome to the server, #FFFF00%target_name%#00FF00! Welcomed by #FFFF00%player_name%" # Broadcast message for /welcome

  # Success message shown to the player who used /welcome. Adapts to reward-type:
  # - For "currency": Shows amount and currency name (ex. : "100 coins", "10 points", "100 Gold")
  # - For "crate_key": Shows amount and key name (ex. : "1 Test Key key(s)")
  success-message: "#00FF00You welcomed a new player and received #ADD8E6%reward_amount% %reward_display%!" # Use %reward_amount% and %reward_display%
  no-new-players: "#FF0000That player has already been welcomed!" # Message when target is not a new player
  cooldown-message: "#FF0000Please wait %seconds% seconds before using this command again!" # Message when on cooldown
```

{% endcode %}

*Last updated 1 month ago*


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://symbiote-development.gitbook.io/symbiote-development-docs/plugins/cwelcomer/configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.