koishi-plugin-jx3api
v2.0.1
Published
jx3-help接口服务
Readme
koishi-plugin-jx3api
剑网3游戏数据 API 接口服务，为 Koishi 提供剑网3游戏数据查询功能。
⚙️ 配置
在 Koishi 配置文件中添加以下配置：
plugins:
jx3api:
apiUrl: https://www.jx3api.com # API 服务器地址
token: your_token_here # 必填：你的 API Token
ticket: your_ticket_here # 可选：推栏 Ticket配置项说明
| 配置项 | 类型 | 默认值 | 说明 |
| -------- | ------ | ------------------------ | -------------------------------------------------------------------- |
| apiUrl | string | https://www.jx3api.com | JX3API 服务器地址 |
| token | string | - | 必填：API 访问令牌，请前往 JX3API 申请 |
| ticket | string | - | 可选：推栏应用的 Ticket，用于访问需要推栏授权的接口 |
🚀 使用
安装并配置后，即可在其他插件中通过服务调用的方式使用：
import { Context } from "koishi";
export function apply(ctx: Context) {
// 查询活动日历
const calendar = await ctx.jx3api.getActiveCalendar({
server: "幽月轮",
num: 0, // 0-当天，1-明天，2-后天
});
// 查询服务器状态
const status = await ctx.jx3api.getServerStatus({
server: "幽月轮",
});
// 查询角色信息
const roleInfo = await ctx.jx3api.getRoleDetailed({
server: "幽月轮",
name: "角色名",
ticket: "your_ticket",
});
}📚 功能列表
活动相关
getActiveCalendar- 查询活动日历getActiveListCalendar- 查询活动列表日历getActiveCelebs- 查询楚天社/云从社进度getActiveMonster- 查询本周百战异闻录首领getActiveNextEvent- 查询下次扶摇九天活动时间
服务器相关
getServerCheck- 服务器开服检查getServerStatus- 查询服务器状态getServerMaster- 查询服务器信息getServerSand- 查询服务器沙盘信息getServerAntivice- 查询诛恶事件getServerEvent- 查询跨服阵营事件getServerLeader- 查询服务器关隘首领
角色相关
getRoleDetailed- 查询角色详情getRoleAttribute- 查询角色属性getRoleAchievement- 查询角色成就getRoleMonster- 查询角色精力信息getRoleOnlineStatus- 查询角色在线状态saveRoleDetailed- 保存/更新角色详情
副本相关
getTeamCdList- 查询角色副本进度
奇遇相关
getLuckRecent- 查询近期奇遇getLuckStatistical- 查询奇遇统计getLuckAdventure- 查询角色奇遇记录getLuckUnfinished- 查询未完成奇遇getLuckCollect- 查询奇遇汇总统计getLuckServerStatistical- 查询全服奇遇统计
交易相关
getTradeMarket- 查询交易行价格getTradeDemon- 查询金价比例getTradeSearch- 模糊搜索外观物品getTradeRecords- 查询黑市价格统计getTradeItemRecords- 查询黑市物品价格getAuctionRecords- 查询拍卖记录
名剑大会
getArenaAwesome- 查询名剑排行榜getArenaRecent- 查询角色名剑战绩getArenaSchools- 查询各门派表现统计
烟花相关
getFireworksRecords- 查询烟花记录getFireworksCollect- 查询烟花统计getFireworksStatistical- 查询烟花汇总
排行榜
getRankStatistical- 查询区服排行榜getRankServerStatistical- 查询全服排行榜
物品掉落
getRewardStatistical- 查询区服物品掉落getRewardServerStatistical- 查询全服物品掉落
门派心法
getSchoolForce- 查询心法奇穴getSchoolMatrix- 查询心法阵眼getSchoolSkills- 查询心法技能getSchoolSeniority- 查询心法资历排行
师徒系统
getMemberTeacher- 查询师傅信息getMemberStudent- 查询徒弟信息getMemberRecruit- 查询团队招募信息
家园相关
getHomeFlower- 查询家园花卉getHomeFurniture- 查询家园装饰getHomeTravel- 查询家园游历
宠物马匹
getArchivedPetEvent- 查询宠物出现记录getHorseRanch- 查询马场马驹信息getChituRecords- 查询赤兔幼驹刷新getDiluRecords- 查询的卢记录
名片墙
getShowCard- 查询名片墙信息getShowCache- 查询名片墙缓存getShowRandom- 查询随机名片getShowRecords- 查询所有名片墙记录
游戏资料
getExamAnswer- 查询科举答案getSkillRecords- 查询技改记录getArchivedPendant- 查询挂件信息getTuilanAchievement- 查询推栏成就
新闻公告
getAllNews- 查询新闻公告getNewsAnnounce- 查询维护公告
贴吧相关
getTiebaRandom- 查询贴吧随机帖子getTiebaItemRecords- 查询贴吧物价记录
音乐搜索
getKugouMusic- 酷狗音乐搜索getNeteaseMusic- 网易云音乐搜索getTencentMusic- 腾讯音乐搜索
娱乐功能
getIdiomSolitaire- 成语接龙getMixedChat- 智能聊天getSaohuaRandom- 随机骚话getSaohuaContent- 舔狗日记getSoundConverter- 语音转换（需要阿里云配置）
其他功能
getFraudDetailed- 查询骗子记录saveClientCalendar- 上报客户端日常任务saveTuilanCalendar- 上报推栏日常任务saveWeekCalendar- 更新推栏周常任务
📖 API 示例
查询活动日历
const calendar = await ctx.jx3api.getActiveCalendar({
server: "幽月轮",
num: 0,
});
console.log(calendar.data);查询角色奇遇
const adventures = await ctx.jx3api.getLuckAdventure({
server: "幽月轮",
name: "角色名",
ticket: "your_ticket",
});
console.log(adventures.data);查询交易行价格
const price = await ctx.jx3api.getTradeMarket({
server: "幽月轮",
name: "物品名称",
});
console.log(price.data);📝 类型定义
本插件提供完整的 TypeScript 类型定义，所有接口的参数和返回值类型都已定义，可以获得完整的代码提示和类型检查。
import type { ActiveCalendar, ActiveCalendarParams, ServerStatus, ServerStatusParams } from "koishi-plugin-jx3api";🔗 相关链接
📄 许可证
MIT License
🤝 贡献
欢迎提交 Issue 和 Pull Request！
⚠️ 注意事项
- 使用本插件需要先申请 JX3API 的 Token
- 部分接口需要推栏 Ticket 才能访问
- 请遵守 JX3API 的使用规范，避免频繁请求
- 建议在生产环境中使用缓存机制减少 API 调用次数