Referrals

插件

· 作者 editid

让玩家通过互相推荐获得奖励,完全可自定义

0 本站下载 0 关注 更新于 9 个月前

最新 1.0.0 · 1.21.11 · Paper / Purpur

一键开服(送7天)

推荐系统

一个高度可定制的推荐系统,支持里程碑、奖励、玩家重新加入后才执行奖励、自定义消息、加入提醒、账号加入时间限制、推荐人数上限、循环推荐拦截以及占位符等功能。

配置

所有配置选项均在 config.yml 文件中详细说明。

config.yml
# _____            __                                _             _                   _
#|  __ \          / _|                              | |           | |                 (_)
#| |__) |   ___  | |_    ___   _ __   _ __    __ _  | |    _ __   | |  _   _    __ _   _   _ __
#|  _  /   / _ \ |  _|  / _ \ | '__| | '__|  / _` | | |   | '_ \  | | | | | |  / _` | | | | '_ \
#| | \ \  |  __/ | |   |  __/ | |    | |    | (_| | | |   | |_) | | | | |_| | | (_| | | | | | | |
#|_|  \_\  \___| |_|    \___| |_|    |_|     \__,_| |_|   | .__/  |_|  \__,_|  \__, | |_| |_| |_|
#                                                         | |                   __/ |
#                                                         |_|                  |___/

# 前缀
# 在消息中使用的前缀
# 默认值: "&6&l[Referral]"
prefix: "&6&l[Referral]"

# 循环推荐
# 如果玩家1推荐了玩家2,玩家2是否也能推荐玩家1?
# 默认值: false
circular-referrals: false

# 最大推荐数
# 一个玩家可以推荐多少人?
# 设置为 -1 表示无限制
# 默认值: -1
max-referrals: -1

# 最大年龄(游戏时长)
# 用户累计游戏多少秒后便无法通过 /refer 命令来认领其推荐人?
# 设置为 -1 表示无限制
# 默认值: 86400 (24小时)
max-age: 86400

# 被推荐人加入要求
# 被推荐的玩家是否在推荐人之前加入服务器?
# 这有助于防止玩家输入无效的用户名。
# 默认值: true
referree-joined-requirement: true

# 加入时通知
# 如果未超过 max-age 设置的时间,尚未被推荐的玩家在加入服务器时是否应收到关于推荐系统的通知?
# 默认值: true
notify-on-join: true

# 通知延迟
# 在加入时发送通知消息前等待多长时间(毫秒)?
# 这确保消息出现在加入消息之后显示
# 默认值: 1000 (1秒)
notify-delay: 1000

# 消息
# 自定义插件发送的所有消息
# 可用的占位符:
# {prefix} - 上面定义的前缀
# {player} - 玩家的用户名
# {referrer} - 推荐人的用户名
# {claimer} - 领取者的用户名
# {max-age} - 最大有效期(秒)
# {max-age-hours} - 最大有效期(小时)
# {max-referrals} - 最大推荐人数限制
# {hours} - 剩余小时数(用于时间剩余消息)
# {minutes} - 剩余分钟数(用于时间剩余消息)
# {value} - 通用值占位符

messages:
  # 命令消息
  player-only: "&c此命令只能由玩家使用。"
  no-permission: "&c你没有权限使用此命令。"

# /refer 命令消息
  refer-usage: "&c用法:/refer <用户名>"
  refer-success: "{prefix} &a你已被 {referrer} 推荐!"
  already-referred: "{prefix} &c你已经设置过你的推荐人了!"
  cannot-refer-self: "{prefix} &c你不能推荐自己!"
  referrer-not-joined: "{prefix} &c玩家 '{referrer}' 此前从未加入过服务器!"

account-too-old: "{prefix} &c你的账号存在时间过长,无法设置推荐人!"
  account-too-old-details: "&c最大允许年龄:{max-age} 秒({max-age-hours} 小时)"
  circular-referral-blocked: "{prefix} &c不允许循环推荐!{referrer} 是由你推荐的。"
  max-referrals-reached: "{prefix} &c玩家 '{referrer}' 已达到最大推荐人数限制!"

# /refer 说明(未提供参数时)
  refer-explanation-header: "{prefix} &e推荐系统"
  refer-explanation-line1: "&e如果有人将你推荐到这个服务器,请使用此命令为他们记录贡献!"
  refer-explanation-usage: "&e用法:&a/refer <用户名>"
  refer-explanation-current: "&a你的推荐人是:&f{referrer}"

refer-explanation-time-remaining: "&e你还有 &a{hours} 小时 {minutes} 分钟 &e可以领取推荐奖励。"
  refer-explanation-expired: "&c你的账号已经过期,无法领取推荐奖励。"

refer-explanation-no-limit: "&e您可以随时领取您的推荐奖励!"

# 加入通知消息
  notify-line1: "{prefix} &e你还没有设置是谁推荐你的!"
  notify-line2: "&e使用 &a/refer <username> &e来领取你的推荐奖励!"

# /referral 帮助命令
  help-header: "{prefix} &e推荐插件命令:"
  help-refer: "&a/refer <用户名> &7- 领取推荐你的玩家奖励"
  help-referral-help: "&a/referral help &7- 显示此帮助信息"
  help-referral-config: "&a/referral config &7- 查看当前配置"
  help-referral-reload: "&a/referral reload &7- 重载插件配置"

# /referral 指令消息
  referral-usage: "&c用法:/referral <help|config|reload>"
  referral-unknown-subcommand: "&c未知子命令。使用 &e/referral help &c查看可用命令。"
  reload-start: "{prefix} &e正在重新加载推荐配置..."
  reload-complete: "{prefix} &a推荐配置已重新加载。"

  # /referral config 消息
  config-header: "{prefix} &e当前推荐配置:"
  config-circular: "&e循环推荐:&f{value}"
  config-max-referrals: "&e最大推荐数:&f{value}"
  config-max-age: "&e最大有效期:&f{value}"
  config-referree-joined: "&e被推荐人加入要求:&f{value}"
  config-notify-on-join: "&e加入时通知:&f{value}"
  config-store-offline: "&e离线时存储奖励:&f{value}"

# 奖励
# 当推荐被领取时,给予推荐人和被推荐人的奖励。
rewards:
  # 领取者是运行 /refer <username> 的玩家,也就是新玩家
  claimer:
    # 当推荐被领取时以控制台身份执行的命令
    # {player} 会被替换为领取者的用户名
    commands:
      - "give {player} diamond 5"
    # 当推荐被领取时发送给领取者的消息
    messages:
      - "&a你因为被推荐而获得了 5 颗钻石!"
  # 推荐新玩家的玩家,这是传递给 /refer <username> 的 <username>
  referrer:
    # 存储离线状态的含义是:如果被推荐人在推荐被领取时处于离线状态,则在他们下次上线时执行命令和发送消息
    # 默认值: true
    store-if-offline: true
    # 当推荐被领取时以控制台身份执行的命令
    # {player} 会被替换为推荐人的用户名
    commands:
      - "give {player} emerald 10"
    # 当推荐被领取时发送给推荐人的消息
    # {claimer} 会被替换为领取者的用户名
    messages:
      - "&a你因为推荐了 {claimer} 而获得了 10 颗绿宝石!"

  # 里程碑奖励
  # 当推荐人达到一定数量的推荐次数时给予他们
  # 每个里程碑仅触发一次
  # 可用的占位符:{player}, {milestone}, {total}
  milestones:
    # 启用或禁用里程碑奖励
    # 默认值: true
    enabled: true

    # 单个里程碑配置
    # 键名(5, 10, 17, 25 等)代表所需的推荐数量
    5:
      commands:
        - "give {player} diamond_block 1"
      messages:
        - "&6&l达成里程碑!"
        - "&e你已经推荐了 &a{total} &e名玩家!"
        - "&a你获得了 1 个钻石块!"
    10:
      commands:
        - "give {player} emerald_block 2"
      messages:
        - "&6&l达成里程碑!"
        - "&e你已经推荐了 &a{total} &e名玩家!"
        - "&a你获得了 2 个绿宝石块!"


# bStats
# 启用或禁用 bStats 指标收集
# 这有助于我了解插件的使用情况
# 默认值: true
bstats: true

# PlaceholderAPI 集成
# 可用的占位符(需要 PlaceholderAPI):
# %referral_referred_by% - 推荐该玩家的玩家用户名(如果未被推荐则为 "None")
# %referral_has_referrer% - "true" 或 "false"
# %referral_total_referrals% - 该玩家已推荐的人数
# %referral_first_join% - 首次加入的时间戳(如果未知则为 "Unknown")
# %referral_account_age% - 账号年龄(秒)(如果未知则为 "Unknown")
# %referral_account_age_hours% - 账号年龄(小时)(如果未知则为 "Unknown")
# %referral_can_claim% - 如果玩家可以领取推荐奖励则为 "true",否则为 "false"
# %referral_time_remaining% - 推荐领取过期前的剩余秒数("Unlimited", "Expired" 或秒数)
# %referral_time_remaining_hours% - 推荐领取过期前的剩余小时数("Unlimited", "Expired" 或小时数)
# %referral_next_milestone% - 玩家即将达成的下一个里程碑(如果无或已禁用则为 "None"/"Disabled")
# %referral_referrals_until_next% - 距离下一个里程碑还需多少推荐次数(如果无或已禁用则为 "None"/"Disabled")

占位符

如果你安装了 PlaceholderAPI,你可以使用以下占位符:

占位符 描述
%referral_referred_by% 谁推荐了该玩家,如果未被推荐则为 "None"
%referral_has_referrer% 该玩家是否有推荐人,true/false
%referral_total_referrals% 该玩家已经推荐了多少名玩家
%referral_first_join% 自插件安装以来玩家首次加入的时间戳(Unix 毫秒)
%referral_account_age% 自玩家首次加入以来的秒数
%referral_account_age_hours% 自玩家首次加入以来的小时数
%referral_can_claim% 该玩家是否仍可以领取推荐奖励,检查他们是否已被推荐以及加入时间是否过长
%referral_time_remaining% 直到无法再领取推荐奖励的剩余秒数,或 "Unlimited",或 "Expired"
%referral_time_remaining_hours% 直到无法再领取推荐奖励的剩余小时数,或 "Unlimited",或 "Expired"
%referral_next_milestone% 距离下一个里程碑总共需要多少推荐次数
%referral_referrals_until_next% 距离获得下一个里程碑还需要多少推荐次数

所有占位符也在 config.yml 文件的底部进行了说明

里程碑

奖励邀请更多玩家的推荐人,例如,在第 5 次推荐或第 50 次推荐时给予额外奖励

Milestones config section

权限

只有 2 个有用的权限

  1. referral.use - 允许玩家运行 /refer <username>,默认启用
  2. referral.admin - 允许使用 /referral reload 和 /referral config,默认为 OP(管理员)

命令

命令 描述 权限 默认值
/refer <username> 设置谁推荐了你 referral.use 默认对所有用户启用
/referral reload 重载配置文件 referral.reload/referral.admin 默认为 OP
/referral config 显示部分配置值,主要用于调试 referral.config/referral.admin 默认为 OP

支持

需要帮助吗?在 Discord 上给我发消息,我的用户名是 editid。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源