Streaker
Streaker 是一款生产就绪的 Paper/Purpur 插件,提供每日登录连击、里程碑奖励、动态库存 GUI、PlaceholderAPI 占位符、异步 SQL 持久化、Caffeine 缓存以及 HikariCP 连接池功能。
功能特性
- 基于服务器时区的每日连击领取。
- 可配置错过天数后的重置宽限期。
- 支持 7、14、30、60 和 100 天等里程碑奖励。
- 支持多种奖励指令、概率、倍率、消息及条件。
- 支持 SQLite、MySQL 和 MariaDB。
- 使用预编译语句进行异步数据库操作。
- Caffeine 缓存与防抖批量配置文件保存。
- 动画化可配置的 GUI 设计。
- PlaceholderAPI 扩展支持。
- JUnit 5 和 MockBukkit 测试环境搭建。
命令
| 命令 |
权限 |
描述 |
/streak |
streaker.command.menu |
打开主连击菜单。 |
/streak menu |
streaker.command.menu |
打开主连击菜单。 |
/streak stats |
streaker.command.stats |
显示个人统计信息。 |
/streak rewards |
streaker.command.rewards |
打开奖励视图。 |
/streak top |
streaker.command.top |
显示排行榜。 |
/streak reload |
streaker.admin.reload |
异步重载配置。 |
/streak reset <player> |
streaker.admin.reset |
重置当前连击。 |
/streak set <player> <value> |
streaker.admin.set |
设置当前连击数。 |
/streak add <player> <value> |
streaker.admin.add |
增加连击天数。 |
/streak remove <player> <value> |
streaker.admin.remove |
减少连击天数。 |
占位符
| 占位符 |
值 |
%streak_current% |
当前连击数。 |
%streak_best% |
最佳连击数。 |
%streak_next_reward% |
下一个配置的奖励。 |
%streak_days_until_reward% |
距离下一个奖励的天数。 |
%streak_total_rewards% |
已发放的奖励总数。 |
%streak_last_claim% |
上次领取日期。 |
安装
- 使用
./gradlew build 进行构建。
- 将
build/libs/Streaker-1.0.0.jar 放入服务器的 plugins 文件夹中。
- 启动服务器一次以生成配置文件。
- 编辑
config.yml、database.yml、rewards.yml、messages.yml 和 menus.yml。
- 运行
/streak reload 或重启服务器。
配置
主要文件:
config.yml 控制时区、领取行为、缓存、写回延迟、通知以及排行榜大小。
database.yml 选择 SQLite、MySQL 或 MariaDB 并调整 HikariCP 参数。
rewards.yml 定义里程碑奖励。
menus.yml 定义 GUI 布局。
messages.yml 定义 MiniMessage 输出格式。
奖励示例:
rewards:
30:
name: "<gradient:#ff512f:#f09819>Monthly Inferno</gradient>"
icon: "CHEST"
chance: 100.0
multiplier: 1.0
commands:
- "crate key give %player% legendary 1"
API
RuntimeContext 实现了 StreakerApi:
CompletableFuture<StreakProfile> profile(UUID uuid, String playerName);
CompletableFuture<ClaimResult> claim(Player player);
CompletableFuture<StreakProfile> setStreak(UUID uuid, String playerName, int value);
文档
常见问题
Streaker 会阻塞主线程吗?
不会。SQL 和配置 IO 均异步运行。仅 Bukkit 相关的操作会返回到主线程执行。
同一个里程碑可以重复触发奖励吗?
不可以。奖励历史记录对每个玩家、奖励和连击天数拥有唯一键。
我可以在命令中使用 PlaceholderAPI 吗?
可以。安装 PlaceholderAPI 并保持 rewards.placeholderapi 启用即可。
路线图
- 多服务器网络的 Redis 同步。
- Web 管理面板。
- 季节性奖励活动。
- 游戏内 GUI 编辑器。
支持
提交 Issue 时请包含你的 Paper 版本、Streaker 版本、数据库类型、配置片段以及相关日志。
Streaker
Streaker is a production-ready Paper/Purpur plugin that adds daily login streaks, milestone rewards, animated inventory GUI, PlaceholderAPI placeholders, async SQL persistence, Caffeine caching, and HikariCP pooling.
Features
- Daily streak claims based on the server timezone.
- Configurable reset grace for missed days.
- Reward milestones such as 7, 14, 30, 60, and 100 days.
- Multiple reward commands, chance, multipliers, messages, and conditions.
- SQLite, MySQL, and MariaDB support.
- Async database operations with prepared statements.
- Caffeine cache and debounced batched profile saves.
- Animated configurable GUI designs.
- PlaceholderAPI expansion.
- JUnit 5 and MockBukkit test setup.
Commands
| Command |
Permission |
Description |
/streak |
streaker.command.menu |
Opens the main streak menu. |
/streak menu |
streaker.command.menu |
Opens the main streak menu. |
/streak stats |
streaker.command.stats |
Shows personal stats. |
/streak rewards |
streaker.command.rewards |
Opens rewards view. |
/streak top |
streaker.command.top |
Shows leaderboard. |
/streak reload |
streaker.admin.reload |
Reloads configuration asynchronously. |
/streak reset <player> |
streaker.admin.reset |
Resets current streak. |
/streak set <player> <value> |
streaker.admin.set |
Sets current streak. |
/streak add <player> <value> |
streaker.admin.add |
Adds streak days. |
/streak remove <player> <value> |
streaker.admin.remove |
Removes streak days. |
Placeholders
| Placeholder |
Value |
%streak_current% |
Current streak. |
%streak_best% |
Best streak. |
%streak_next_reward% |
Next configured reward. |
%streak_days_until_reward% |
Days until next reward. |
%streak_total_rewards% |
Total granted rewards. |
%streak_last_claim% |
Last claim date. |
Installation
- Build with
./gradlew build.
- Put
build/libs/Streaker-1.0.0.jar into the server plugins folder.
- Start the server once to generate configs.
- Edit
config.yml, database.yml, rewards.yml, messages.yml, and menus.yml.
- Run
/streak reload or restart the server.
Configuration
Primary files:
config.yml controls timezone, claim behavior, cache, write-behind, notifications, and leaderboard size.
database.yml selects SQLite, MySQL, or MariaDB and tunes HikariCP.
rewards.yml defines milestone rewards.
menus.yml defines GUI layouts.
messages.yml defines MiniMessage output.
Example reward:
rewards:
30:
name: "<gradient:#ff512f:#f09819>Monthly Inferno</gradient>"
icon: "CHEST"
chance: 100.0
multiplier: 1.0
commands:
- "crate key give %player% legendary 1"
API
RuntimeContext implements StreakerApi:
CompletableFuture<StreakProfile> profile(UUID uuid, String playerName);
CompletableFuture<ClaimResult> claim(Player player);
CompletableFuture<StreakProfile> setStreak(UUID uuid, String playerName, int value);
Documentation
- Architecture
- Database
- GUI
- Optimization
- Media prompts
- Project audit
FAQ
Does Streaker block the main thread?
No. SQL and config IO run asynchronously. Bukkit-only work is returned to the main thread.
Can rewards run more than once for the same milestone?
No. Reward history has a unique key per player, reward, and streak day.
Can I use PlaceholderAPI in commands?
Yes. Install PlaceholderAPI and keep rewards.placeholderapi enabled.
Roadmap
- Redis sync for multi-server networks.
- Web dashboard.
- Seasonal reward campaigns.
- In-game GUI editor.
Support
Open an issue with your Paper version, Streaker version, database type, config snippet, and relevant logs.
评论 0
登录后参与评分
还没有评论,来抢沙发吧