AdsPoster
A Minecraft Spigot/Paper plugin for managing advertising regions and displaying custom ads
Overview
AdsPoster is a powerful Minecraft plugin that allows server administrators to define advertising regions and display custom advertisements using item frames. The plugin supports both map-based ads and banner-based ads, providing flexibility for various advertising needs.
Features
- Region-Based Ad Management: Define cuboid regions where ads will be displayed
- Command-Based Controls: Easy-to-use /ads command with multiple subcommands
- Multiple Ad Types: Support for both filled maps and banners
- Persistent Storage: All regions are saved to YAML configuration and persist across server restarts
- Asynchronous Operations: File operations and ad placement handled asynchronously to prevent lag
- Permission System: Granular permission controls for different operations
- Customizable Messages: All messages can be customized through the configuration file
- Tab Completion: Full tab completion support for all commands
- Modular Design: Easily extensible with new features like rotating or scheduled ads
Installation
- Download the AdsPoster.jar file
- Place it in your server’s plugins folder
- Restart your server
- Configure the plugin by editing plugins/AdsPoster/config.yml
Commands
All commands use the
/ads prefix:
/ads set pos1 <regionName> |
Set the first corner of a region |
adsposter.set |
/ads set pos2 <regionName> |
Set the second corner of a region |
adsposter.set |
/ads place <regionName> <adId> |
Place ads in a defined region |
adsposter.place |
/ads remove <regionName> |
Remove ads from a region |
adsposter.remove |
/ads list |
List all defined regions |
adsposter.admin |
/ads info <regionName> |
Show detailed region information |
adsposter.admin |
/ads help |
Display help information |
adsposter.admin |
Permissions
adsposter.admin |
Access to all AdsPoster commands |
op |
adsposter.set |
Allows setting region positions |
op |
adsposter.place |
Allows placing ads in regions |
op |
adsposter.remove |
Allows removing ads from regions |
op |
Usage Guide
Defining a Region
- Stand at the first corner of your desired region
- Run /ads set pos1 myRegion
- Move to the opposite corner
- Run /ads set pos2 myRegion
- Region is automatically saved
Placing Ads
Map-based ads:
Code (Text):
/ads place myRegion 0
(Replace 0 with your map ID)
Banner-based ads:
Code (Text):
/ads place myRegion WHITE_BANNER
(Replace WHITE_BANNER with a valid banner material)
Removing Ads
Code (Text):
/ads remove myRegion
Viewing Regions
List all regions:
View region info:
Code (Text):
/ads info myRegion
Configuration
The configuration file is located at
plugins/AdsPoster/config.yml:
Code (Text):
# Messages
messages:
prefix: "&8[&6AdsPoster&8]&r "
pos1_set: "&aPosition 1 set for region &e{region}&a at &7{location}"
pos2_set: "&aPosition 2 set for region &e{region}&a at &7{location}"
# Settings
settings:
async_file_operations: true
item_frame:
invisible: false
fixed: true
glow: false
max_region_size: 100
debug: false
Configuration Options
- async_file_operations: Enable asynchronous file operations (recommended: true)
- item_frame.invisible: Make item frames invisible
- item_frame.fixed: Prevent item frames from being broken
- item_frame.glow: Make item frames glow
- max_region_size: Maximum region size per dimension (in blocks)
- debug: Enable debug logging
Data Storage
All region data is stored in
plugins/AdsPoster/ads_positions.yml:
Code (Text):
regions:
myregion:
name: myRegion
world: world
x1: 100
y1: 64
z1: 200
x2: 110
y2: 70
z2: 210
currentAdId: "0"
Future Extensions
- Rotating Ads
- Scheduled Ads
- URL Integration
- Analytics
- Economy Integration
- Holographic Ads
Support
For issues or requests:
- Author: NotGamerPratham
- Version: 1.0.0
- Discord: Join Server
License
This plugin is provided as-is for use on Minecraft servers. Please respect the author's work.
Credits
Author: NotGamerPratham
Plugin Name: AdsPoster