SimpleAdvertising - 游戏内广告插件

SimpleAdvertising 插件文档

SimpleAdvertising 是一款功能全面的广告插件，允许玩家付费发布广告，并支持经济系统、积分系统、GUI 界面、自动广播等丰富功能。所有内容均可高度自定义，以适应您的服务器风格。

💡核心特性

• 全面自定义：从颜色到价格，一切皆可按您的喜好调整。
• 经济系统支持：支持 Vault 和 EssentialsX 经济，并可使用内置积分系统。
• 现代化支持：兼容 1.21 版本，支持 HEX 颜色代码和 PlaceholderAPI。
• 轻量高效：代码持续优化，力求高效运行。
• 开源透明：插件完全开源，代码托管于 GitHub，便于审查和贡献。

🎮要求与依赖

• 必需依赖：
• Vault
• EssentialsX (插件依赖其经济系统)
• 可选依赖：
• PlaceholderAPI (用于在消息和标题中使用变量)
• 兼容版本：专为 Minecraft 1.21 设计，注重向前兼容。

⭐主要功能

广告系统

• 玩家可使用 /ad 命令发布广告。
• 支持设置每次发布广告的价格和冷却时间。
• 支付方式可选择使用 Essentials 金钱 或插件内置的 广告积分。
• 广告消息支持 HEX 颜色代码。
• 可设置广告的停留时间和重复播放间隔。

积分系统

• 内置一套独立的“广告积分”系统，支持 UUID。
• 管理员可通过命令轻松给予、扣除、设置、查看玩家积分。
• 积分数据目前存储在 .yml 文件中，未来计划支持 MySQL/SQL。
• 可在配置中选择启用/禁用积分系统，或与经济系统并存，由玩家选择支付方式。

广播与消息

• 智能广播：使用 /broadcast 命令发布官方公告。消息短于42字符时使用标题显示，否则在聊天栏显示。
• 自动广播器：可定时向所有在线玩家发送预设的聊天消息或标题。
• 加入/退出消息：当发布广告的玩家加入或退出服务器时，可显示提示（可关闭）。
• 操作日志：记录所有广告行为，便于追踪滥用情况。

用户界面与体验

• 美观的 GUI：通过点击即可轻松发送广告，简化操作流程。
• 可配置的标题：可调整标题的淡入、停留、淡出时间（以 tick 计）。
• 命令补全：支持 Tab 键自动补全命令。
• 一键重载：使用 /ad reload 重载配置文件。
• 调试功能：遇到问题时，可使用 /ad debug 生成调试信息。

高度可配置

• 几乎所有功能都可通过配置文件开启或关闭。
• 可自定义消息前缀、格式、声音等。
• 支持使用 PlaceholderAPI 变量丰富消息内容。

🔧命令列表

• /ad <文本> - 发布一条广告。需要权限 simplead.ad (默认拥有)。
• /ad reload - 重载插件配置。需要权限 simplead.reload。
• /ad help - 显示帮助页面。需要权限 simplead.help (默认拥有)。
• /ad debug - 显示调试信息。需要权限 simplead.debug。
• /broadcast - 发布一条服务器广播。需要权限 simplead.broadcast。
• /points give <玩家> <数量> - 给予玩家积分。
• /points take <玩家> <数量> - 扣除玩家积分。
• /points set <玩家> <数量> - 设置玩家积分。
• /points - 查看自己的积分。
• 管理积分需要权限 simplead.points。

✨权限列表

• simplead.help - 使用 /ad help 命令。
• simplead.reload - 重载插件。
• simplead.broadcast - 使用广播命令。
• simplead.ad - 发布广告（默认拥有）。
• simplead.admin - 拥有所有权限。
• simplead.points - 管理广告积分。
• simplead.debug - 查看调试信息。

🔧PlaceholderAPI 变量

• %simplead_price% - 返回配置中设置的广告价格。
• %simplead_cooldown% - 返回广告命令的冷却时间。
• %simplead_currentad% - 返回当前/最新的广告内容。
• %simplead_currentplayer% - 返回发布当前/最新广告的玩家名。

❓配置示例与说明

以下为配置文件 (config.yml) 的核心部分示例与简要说明：

# 启用/禁用模块
enable:
  welcomers: true # 加入/退出消息
  logging: true   # 操作日志
  sounds: true    # 音效
  updater: true   # 更新检查

# 广告设置
advertising:
  economy: "money" # 支付类型："money" 或 "points"
  cooldown: 10     # 命令冷却时间（秒）
  price: 100       # 每次广告价格
  stay: 0          # 广告停留时间（秒），设为 "permanent" 则永久停留直到下一条广告
  repeat: 0        # 重复播放间隔（秒），需 stay > 0
  sound: BLOCK_NOTE_BLOCK_PLING # 发布成功时的音效

# 积分系统
points:
  default-balance: 1 # 新玩家的默认积分

# 自动广播器
auto-advertiser:
  chat: true
  titles: true
  minimum-players-online: 1 # 触发广播的最低在线人数
  chat-interval: 60  # 聊天广播间隔（秒）
  titles-interval: 65 # 标题广播间隔（秒）
  chat-messages: [ ] # 聊天广播消息列表
  title-messages: [ ] # 标题广播主标题列表
  subtitle-messages: [ ] # 标题广播副标题列表

提示：完整的配置选项、材料名称、音效名称及 YAML 验证工具，请参考插件内注释或官方 Wiki。

⭐开发者 API

SimpleAdvertising 提供了友好的开发者 API，允许其他插件调用其方法（例如管理积分）。API 文档和代码示例可在项目的 GitHub 仓库 中找到。

❓支持与联系

• 文档与更新：最新版本、完整文档、配置帮助及源代码均可在 GitHub 获取。
• 问题反馈：遇到任何问题，请提供详细描述和 /ad debug 的截图信息。
• 联系方式：
• Discord: discord.gg/rADmNx9
• 论坛: https://forum.b-zone.ro/profile/69781-moshu/
• 邮箱: [email protected]
• 网站: http://mc.b-zone.ro

插件持续更新中，欢迎提出功能建议！

简介

SimpleAdvertising 是一款轻量级的广告插件，允许玩家付费发布服务器公告。安装后即可使用，但建议根据需求调整配置以获得最佳体验。

💡安装与运行

• 下载 SimpleAdvertising.jar 文件。
• 确保服务器运行 Java 21 或更高版本，并使用 Spigot 1.21（或更低版本）。对于低于 1.21 的 Spigot 版本，请使用旧版 SimpleAdvertising。此版本仅兼容 1.21。
• 将插件文件放入服务器的 plugins 文件夹。
• 启动或重载服务器，插件即可正常工作。

🎮依赖要求

插件需要以下依赖才能实现完整功能

• Vault：必需的经济系统接口。
• 经济插件：例如 EssentialsX，用于提供经济支持。
• PlaceholderAPI：可选，用于在广告中使用丰富的占位符。

> 注意：如果没有安装 Vault 和经济插件，玩家将无法使用 /ad 命令发布付费广告。

🔧配置与支持

• 插件开箱即用，但建议根据喜好调整 config.yml 文件。
• 如果遇到任何问题，请联系开发者获取支持。
• 如果你喜欢这个插件，可以考虑留下好评。

❓旧版本兼容性

对于运行 1.12 至 1.15 等旧版服务端的用户，如果遇到以下错误：

org.bukkit.plugin.InvalidPluginException: Unsupported API version 1.16

可以按照以下步骤解决

• 解压 SimpleAdvertising.jar 文件。
• 找到并编辑 plugin.yml 文件。
• 将其中的 api-version: 1.16 修改为你当前服务端的版本号（例如 1.14）。
• 重新打包为 JAR 文件并放入 plugins 文件夹即可。