# Join / Quit

This module enables you to perform actions when players connect and disconnect.

## Configuration

```yaml
########################################################################################################################
#
# ░░░░░██╗░█████╗░██╗███╗░░██╗░░░░██████╗░██╗░░░██╗██╗████████╗
# ░░░░░██║██╔══██╗██║████╗░██║░░░██╔═══██╗██║░░░██║██║╚══██╔══╝
# ░░░░░██║██║░░██║██║██╔██╗██║░░░██║██╗██║██║░░░██║██║░░░██║░░░
# ██╗░░██║██║░░██║██║██║╚████║░░░╚██████╔╝██║░░░██║██║░░░██║░░░
# ╚█████╔╝╚█████╔╝██║██║░╚███║░░░░╚═██╔═╝░╚██████╔╝██║░░░██║░░░
# ░╚════╝░░╚════╝░╚═╝╚═╝░░╚══╝░░░░░░╚═╝░░░░╚═════╝░╚═╝░░░╚═╝░░░
#
# Documentation: https://zessentials.groupez.dev/modules/home
#
########################################################################################################################

enable: true

# Should players with permissions be able to join and part silently?
# You can control this with essentials.silentjoin and essentials.silentquit permissions if it is enabled.
allow-silent-join-quit: false


# Available placeholders:
# %player% - The player's name.
# %displayName% - The player's display name.
#
# Available type:
# DISABLE
# DEFAULT
# CUSTOM
custom-join-message: CUSTOM
custom-quit-message: CUSTOM

# Should a message be sent when the player first logs in
#
# Available placeholders:
# %player% - The player's name
# %totalUser% - The total number of unique players
# %totalUserFormat% - The total formatted number of unique players
allow-first-join-broadcast: true

# Send a welcome message to the player on first login
#
# Available placeholders:
# %player% - The player's name.
# %displayName% - The player's display name.
allow-first-join-motd: true

# The number of ticks before sending the message
first-join-motd-ticks: 20 # 1 second = 20 ticks
```


---

# Agent Instructions: 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://zessentials.groupez.dev/modules/join-quit.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.