An open API service indexing awesome lists of open source software.

https://github.com/dragonstudio-store/ds-ads-ultimate

DS-Ads Ultimate source code
https://github.com/dragonstudio-store/ds-ads-ultimate

Last synced: 10 months ago
JSON representation

DS-Ads Ultimate source code

Awesome Lists containing this project

README

          

# DS-Ads Ultimate

DS-Ads is a Minecraft plugin designed to enhance your server's advertisement capabilities. With DS-Ads, you can send customized ads to players via chat, boss bars, action bars, and titles. This plugin is fully configurable and supports permissions for managing who can send and manage ads.

## Features

- Customizable welcome messages for new players.
- Configurable ad formats including chat, boss bar, action bar, and title.
- Permissions to control ad management and sending.
- Easy configuration and reloading of settings.

## Installation

1. Download the latest version of the DS-Ads plugin.
2. Place the plugin jar file in your server's `plugins` directory.
3. Restart your server to generate the default configuration files.
4. Edit the `Settings.yml` file to customize the plugin settings to your needs.
5. Use the `/ads reload` command to apply the changes without restarting the server.

## Configuration

The configuration file (`Settings.yml`) includes settings for plugin behavior, permissions, and customizable messages. Below is an example of the configuration options:

```yaml
# Plugin Settings, you can edit them according to your needs.
Plugin-Configuration:
Enabled: true
Disable-MCJoinLeave-Messages: true

# Plugin permissions
Plugin-Permissions:
Send-Ads: ads.send
Manage-Ads: ads.manage
Reload-Plugin: ads.reload

# Plugin messages, you can edit them according to your needs.
Messages:
Prefix: "DS-ADS » "
No-Perms: "You dont have permissions to run this command"
No-Subcmd: "This command doesnt exist"
No-Ad-Found: "This ad doesnt exist"
No-Player-Found: "This player doesnt exist"
Ad-Failed: "Error sending ad to player"
Reloaded-Sucess: "Config was reloaded correctly"
Only-players: "This command can only be used by players"
Disabled-Plugin: "The plugin was successfully disabled"
Already-Disabled-Plugin: "The plugin is already disabled"
Enabled-Plugin: "The plugin was successfully enabled"
Already-Enabled-Plugin: "The plugin is already enabled"
Everyone-Send: "Ad sent to all players"
Player-Send: "Ad sent correctly to the player"
Usage: "Usage: /ads send "

# Advertisement configuration
Ads-Configuration:
Ads-Cooldown: 15 # In Seconds, For all ads
Ad-Example-1:
worlds:
- world
permission: ads.ad1
Chat:
Enabled: true
Sound: BLOCK_NOTE_BLOCK_PLING
Ad-content:
- ''
- '-----------------------------------------------------'
- ''
- 'Hi %player_name%'
- ''
- 'What do you think of this plugin?'
- ''
- '-----------------------------------------------------'
Bossbar:
Enabled: true
Message: "Look, a Bossbar with MiniMessage"
Color: PINK
Style: SOLID
Actionbar:
Enabled: true
Message: "And here you have one in ActionBar"
Title:
Enabled: true
Title: "DS-Ads"
Subtitle: "Thanks for another opportunity!"
FadeIn: 10
Stay: 70
FadeOut: 20
```

## Permissions

- `ads.send` - Allows the user to send ads.
- `ads.manage` - Allows the user to manage ads.
- `ads.reload` - Allows the user to reload the plugin configuration.

## Commands

- `/ads send ` - Sends the specified ad to a player or all players.
- `/ads reload` - Reloads the plugin configuration.
- `/ads enable` - Enables the plugin.
- `/ads disable` - Disables the plugin.

## Contribution

We welcome contributions from the community! If you have ideas for new features, find a bug, or want to improve the code, feel free to open an issue or submit a pull request. Please ensure your contributions adhere to our coding standards and include appropriate tests where applicable.

## Community Help

If you need help with the plugin, you can:

1. Check the [Wiki](https://wiki.dragonstudio.site) for detailed documentation.
2. Join our [Discord server](https://discord.dragonstudio.site) to ask questions and get support from the community.
3. Open an issue on GitHub if you find any bugs or have feature requests.

## Code of Conduct

We expect all contributors to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it to understand the expected behavior in our community.

## License

DS-Ads is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for more details.

## No Plagiarism

We take plagiarism seriously. Ensure that your contributions are original and appropriately attributed if they build upon the work of others. Plagiarized contributions will not be accepted and may lead to being banned from the project.

---

Thank you for using DS-Ads! We hope it enhances your Minecraft server experience.