BBAds

<h1>BBAds - Enhance Player Engagement with Dynamic BossBar Messages</h1>

<p>BBAds is a Minecraft plugin designed to enhance player engagement by displaying dynamic information in the BossBar. This plugin offers a range of features to keep players informed and entertained, improving the overall server experience.</p>

<h2>Key Features:</h2>

<ul>
<li><strong>Server Advertisements:</strong> Automatically rotates predefined messages from the <code>config.yml</code> file. This allows you to display important server information to all players.</li>
<li><strong>Player Advertisements:</strong> Players with the appropriate permission can display custom messages in the BossBar for a limited time.</li>
<li><strong>Administrative Control:</strong> Enable/disable server ads, mute abusive players, and reload the configuration without restarting the server.</li>
<li><strong>Mute System:</strong> Allows administrators to prevent specific players from sending messages to the BossBar.</li>
<li><strong>Curse Word Filter:</strong> Filters unwanted words and phrases using regular expressions defined in the <code>regex.yml</code> file.</li>
<li><strong>Logging:</strong> Records all messages sent to the BossBar in a log file for moderation and analysis purposes.</li>
</ul>

<h2>Commands:</h2>

<h3>Player Commands:</h3>
<ul>
<li><code>/bb <time> <bossbar_color> <text_color> <message></code> - Sends a custom message to the BossBar.
<ul>
<li><code><time></code>: The duration (in seconds) for which the message will be displayed.</li>
<li><code><bossbar_color></code>: The color of the BossBar (e.g., <code>BLUE</code>, <code>RED</code>, <code>GREEN</code>).</li> <li><code><text_color></code>: The color of the message text (e.g., <code>AQUA</code>, <code>YELLOW</code>).</li>
<li><code><message></code>: The text to display.</li>
<li>Example: <code>/bb 10 RED YELLOW Check out my shop!</code></li>
</ul>
</li>
</ul>

<h3>Administrator Commands:</h3>
<ul>
<li><code>/bb mute <player> [time]</code> - Mutes a player, preventing them from sending messages. If no time is specified, the mute is permanent until the player is unmuted.</li>
<li><code>/bb unmute <player></code> - Unmutes a player.</li>
<li><code>/bossbarad <on|off|stop|reload></code> - Server management commands.
<ul>
<li><code>on</code>: Enables automatic server advertisements.</li>
<li><code>off</code>: Disables server advertisements.</li>
<li><code>stop</code>: Stops all BossBars immediately.</li>
<li><code>reload</code>: Reloads settings from the <code>config.yml</code> and <code>regex.yml</code> files.</li>
</ul>
</li>
</ul>

<h2>Permissions:</h2>
<ul>
<li><code>bossbarads.use</code>: Allows a player to use the <code>/bb</code> command.</li>
<li><code>bossbarads.kd.15</code>: Allows sending messages for 15 seconds.</li>
<li><code>bossbarads.kd.30</code>: Allows sending messages for 30 seconds.</li>
<li><code>bossbarads.kd.60</code>: Allows sending messages for 60 seconds.</li>
<li><code>bossbarads.kd.120</code>: Allows sending messages for 120 seconds.</li>
<li><code>bossbarads.kd.unlimited</code>: Allows sending messages with no time limit.</li>
<li><code>bossbarads.admin</code>: Grants access to administrator commands.</li>
</ul>

<h2>Configuration (config.yml):</h2>
<pre><code>enable_logging: true # Enable or disable logging
alternate_ads: true # Alternate between player and server ads
bossbar_id: "ads" # ID of the BossBar (recommended not to change)
player_ads_interval: # Interval between player ads (in seconds)
min: 15
max: 60
server_ads_interval: # Interval between server ads (in seconds)
min: 30
max: 60
server_ads: # List of server advertisements
- "&aJoin us, it's fun here!"
- "&eSubscribe to our Discord!"
muted_players: # List of muted players
player1: 0 # player1 is muted permanently (until unmuted)
player_ad_format: "§7§o%name%§r: %message%" # Format of player advertisements.
%name% - player's name
%message% - player's message
</code></pre>

<h2>Curse Word Filter (regex.yml):</h2>
<pre><code>regex: # List of words and phrases to filter
- "bad_word1"
- "bad_word2"
- ".website\.com." # Block websites
</code></pre>

<h2>Installation:</h2>
<ol>
<li>Download the <code>.jar</code> file of the plugin.</li>
<li>Place the <code>.jar</code> file into the <code>plugins</code> folder of your Minecraft server.</li>
<li>Start the server.</li>
<li>Configure the <code>config.yml</code> and <code>regex.yml</code> files to your liking.</li>
</ol>

<h2>Dependencies:</h2>

<ul>
<li>Spigot or Paper (or another server that supports Bukkit/Spigot plugins)</li>
</ul>