🍍DS-Ads

Welcome to the official documentation for DS-Ads! Here you'll find everything you need to know to configure and use the plugin effectively.

About DS-Ads

DS-Ads is the first plugin developed by our studio, and we continue to update it! This plugin allows you to display advertisements to your players through ActionBars, Bossbars, Titles, or Chat Messages.

---

How to Configure DS-Ads

The plugin has a simple structure that allows you to configure as many ads as you want, in whatever way you choose. You can make global adjustments as well as customize individual ads.

Settings.yml File

Below is a breakdown of the configuration file and how to modify it according to your needs:

# Version of the configuration file, do not modify these settings.
Plugin-Version: 8.0
Config-Version: 8.0

########################
## Plugin Configuration ##
########################
Plugin-Configuration:
  Enabled: true
  Disable-MCJoinLeave-Messages: true

• Enabled: Enables or disables the plugin.

• Disable-MCJoinLeave-Messages: Disables Minecraft's default join/leave messages.

---

Permissions System

Plugin Permissions:

• ads.send – Allows players to send advertisements.

• ads.manage – Grants access to manage ad settings.

• ads.reload – Allows reloading the plugin.

---

Messages Customization

The plugin allows for full customization of messages using MiniMessage format.

Messages:
  Prefix: '<aqua>Fruit<white>Forge <dark_gray><bold>» <reset>'
  No-Perms: "<red>You dont have permissions to run this command"
  No-Subcmd: "<red>This command doesnt exist"
  No-Ad-Found: "<red>This ad doesnt exist"
  No-Player-Found: "<red>This player doesnt exist"
  Reloaded-Sucess: "<green>Config was reloaded correctly"
  Everyone-Send: "<green>Ad sent to all players"
  Player-Send: "<green>Ad sent correctly to the player"

---

Welcome Advertisement

DS-Ads allows you to configure welcome messages in different formats when players join the server.

Welcome-Ad:
  Enabled: true
  WelcomeAd-Content:
    Chat:
      Enabled: true
      Sound: BLOCK_NOTE_BLOCK_PLING
      Ad-content:
        - '<center><aqua><bold>Welcome %player_name%</bold></aqua></center>'
    Bossbar:
      Enabled: true
      Message: "<dark_purple>Welcome %player_name%!</dark_purple>"
      Color: PINK
      Style: SOLID
    Actionbar:
      Enabled: true
      Message: "<red>Welcome to DragonStudio</red>"
    Title:
      Enabled: true
      Title: "<blue>DS-Ads</blue>"
      Subtitle: "<yellow>Thanks for another opportunity!</yellow>"
      FadeIn: 10
      Stay: 70
      FadeOut: 20

---

Advertisement Configuration

You can create custom ads for different worlds with unique settings.

Example Ad Configuration:

Ads-Configuration:
  Ads-Cooldown: 15 # Global cooldown for ads in seconds

  Ad-Example-1:
    worlds:
      - world
    permission: ads.ad1
    Chat:
      Enabled: true
      Sound: BLOCK_NOTE_BLOCK_PLING
      Ad-content:
        - '<center><aqua><bold>Hi %player_name%</bold></aqua></center>'
    Bossbar:
      Enabled: true
      Message: "<gradient:#ff5555:#5555ff>Look, a Bossbar with MiniMessage</gradient>"
      Color: PINK
      Style: SOLID
    Actionbar:
      Enabled: true
      Message: "<gradient:#55ff55:#5555ff>And here you have one in ActionBar</gradient>"
    Title:
      Enabled: true
      Title: "<blue>DS-Ads</blue>"
      Subtitle: "<yellow>Thanks for another opportunity!</yellow>"
      FadeIn: 10
      Stay: 70
      FadeOut: 20

• Cooldown: Prevents spam by setting a global cooldown between ads.

• Permissions: Only players with the required permission can see the ad.

• Multi-format support: Ads can be displayed in chat, bossbars, actionbars, or titles.

---

Commands and Usage

General Commands:

• /ads send <AdName> <Player/*> – Sends an ad to a specific player or all players.

• /ads reload – Reloads the plugin configuration.

Permissions Required:

• ads.send – Required to send ads.

• ads.manage – Allows managing ads.

• ads.reload – Grants permission to reload the plugin.

---

Multi-World and Dynamic Ads

DS-Ads supports multi-world ads, allowing you to set up different messages based on the world the player is in.

  Ad-Example-2:
    worlds:
      - world_nether
    permission: ads.ad2
    Chat:
      Enabled: true
      Sound: ENTITY_ENDER_DRAGON_GROWL
      Ad-content:
        - '<center><red><bold>Explore the Nether</bold></red></center>'
    Bossbar:
      Enabled: true
      Message: "<gradient:#ffaa00:#ff00aa>Brave the Nether</gradient>"
      Color: RED
      Style: SEGMENTED_10
    Actionbar:
      Enabled: true
      Message: "<gradient:#ff5555:#ffaa00>Watch out for the Ghasts!</gradient>"
    Title:
      Enabled: true
      Title: "<dark_red>Nether Adventures</dark_red>"
      Subtitle: "<gold>Are you ready?</gold>"
      FadeIn: 20
      Stay: 100
      FadeOut: 30

• Ads in the Nether world have different messages and effects than ads in the Overworld.

• Use MiniMessage gradients and styles for creative, eye-catching ads.

---

Why Choose DS-Ads?

• Multi-format support: Chat, Bossbar, Actionbar, and Titles.

• Fully customizable messages with MiniMessage support.

• Multi-world compatibility with dynamic ads per world.

• Cooldown system to prevent spam.

• Welcome ads for players joining the server.

For additional support, contact the FruitForge development team. Thank you for using DS-Ads!