EpicGreetings Plugin Documentation

Installation
Prerequisites

• Requires Spigot 1.21.1

Installation Steps

1. Download the latest release of EpicGreetings.
2. Drop the plugin file (EpicGreetings.jar) into your server’s /plugins folder.
3. Restart or reload your server to generate the default configuration files.
4. Configure your messages and settings in config.yml.

Configuration File Overview
The configuration file is generated in /plugins/EpicGreetings/config.yml. Here's an example of the default file:

yaml
# The join message for all players
join-message: "&aWelcome to the server %player%!"

# Join sound settings
join-sound:
enabled: true
sound: "ENTITY_PLAYER_LEVELUP"

# Random join messages
random-join-messages:
enabled: false
messages:
- "&a%player% just showed up... try to act normal."
- "&a%player% hatched into the world!"
- "&a%player% has joined the simulation."
- "&a%player% arrived, but only for the free pizza."
⚙️ Commands & Permissions:

Command	Permission	Description
/setjoinmessage <message>	epicgreetings.use	Sets greeting message.
/randomjoinmessage <enable/disable>	epicgreetings.use	Enables or disables the random join message option.
/randomjoinmessage add <message>	epicgreetings.use	Adds a message to the random join message list.
/randomjoinmessage remove <message index>	epicgreetings.use	Removes a join message at a certain index from the random join message list.
/randomjoinmessage list	epicgreetings.use	Lists the messages and indexes of the random join messages.
/joinsound <enable/disable>	epicgreetings.use	Enables or disables the join sound.
/joinsound set <sound>	epicgreetings.use	Sets the join sound to the specified sound. (Must be a minecraft spigot sound)

Permissions
epicgreetings.use - Allows players to use commands like /setjoinmessage, /randomjoinmessage, and /joinsound.
Usage Examples
Basic Usage

• Set a custom join message:
  /setjoinmessage &aWelcome to the server %player%!
  
  
• Enable random join messages:
  /randomjoinmessage enable
  
  
• Add a new random join message:
  /randomjoinmessage add &a%player% has entered the realm of Epic!
  
  
• Enable/Disable the join sound:
  /joinsound enable
  /joinsound disable
  

Advanced Usage

• Using Variables:
  • %player%: Replaces with the player's name.
  • Use minecraft color codes and formatting using '&'
  • Example: &aWelcome %player%!
• Example Random Messages:
  • &a%player% just showed up... try to act normal.
  • &a%player% is here for the free pizza!

Configuration Guide
join-message

• The default join message for all players when they first connect.
• Example:
  join-message: "&aWelcome to the server %player%!"

join-sound

• Controls whether a sound is played when a player joins.
  • enabled: Set to true to enable, false to disable.
  • sound: Specify the sound to play (must be a valid Minecraft Spigot sound).

Example:

yaml
join-sound:
enabled: true
sound: "ENTITY_PLAYER_LEVELUP"

random-join-messages

• enabled: Set to true to enable random join messages, false to disable.
• messages: List of join messages that will appear randomly.

Example:

yaml
random-join-messages:
enabled: true
messages:
- "&a%player% just showed up... try to act normal."
- "&a%player% hatched into the world!"
- "&a%player% is the new hero of the server!"

Troubleshooting

Create a github issue or contact me about any issues.