UID2223249
性别保密
经验 EP
铁粒 粒
回帖0
主题
精华
在线时间 小时
注册时间2025-12-24
最后登录1970-1-1
|
你是否不够了解verity,没关系wiki会帮助
由于苦力怕论坛部分帖子的问题,始终未彻底解决,于是我们把帖子全部迁移新的网站当中
并在这里提供较好的服务,你也可以去改动,调用,甚至开设/部署服务器等等
如果您使用我们的项目,请尊重整个项目
进行署名等等操作哦~
大部分的介绍和使用方法等等,都已经进入写在了网站内部
你可以试着去调用我们的代码,准备了的很好的列表如
# Verity Wiki · 完整接口清单(API Reference)
> **来源**:本清单由 `verity-wiki/index.html` 静态提取生成,与站点代码一一对应。
> **唯一命名空间 / 调用头**:`minecraft_verity_wiki`
> **单例取值**:`const wiki = window.minecraft_verity_wiki();`
---
## 0. 调用约定
```js
- minecraft_verity_wiki // 工厂函数(返回单例实例)
- minecraft_verity_wiki() // 取得引擎实例
- minecraft_verity_wiki.version // 静态属性:版本号
- minecraft_verity_wiki().setConfig(...) // 实例方法
复制代码
```
- **静态成员** → `minecraft_verity_wiki.xxx`
- **实例方法** → `minecraft_verity_wiki().xxx()`
- 所有内部值**只能通过带调用头的 API 修改**;省略必填项抛 `{ code:"required" }`,可选项取默认值。
---
## 1. 核心引擎(Core)
| 方法 / Signature | 返回 | 说明 | 必填/可选 |
|---|---|---|---|
| `minecraft_verity_wiki()` | `Object` 单例 | 工厂,取得引擎实例 | — |
| `.version` (static) | `String` | 引擎版本 | — |
| `.setConfig(patch)` | `Object` | 合并配置 | patch **必填** |
| `.getConfig()` | `Object` | 读取当前配置(克隆) | — |
| `.resetConfig()` | `Object` | 重置为默认值 | — |
| `.selfCheck()` | `Object` | 自检报告 | — |
| `.destroy()` | — | 销毁并清理 DOM | — |
| `.init(options)` | `Object` | 初始化(可重复调用) | options 可选 |
| `.namespace` | `String` | 命名空间标识 | — |
| `.schema` | `Number` | 当前数据 schema 版本 | — |
### 配置项(Config / `_DEFAULTS`)
| Key | 类型 | 默认 | 说明 |
|---|---|---|---|
| `editable` | Boolean | `false` | 是否开启编辑模式 |
| `debug` | Boolean | `false` | 调试日志 |
| `theme` | String | `dark` | 主题(dark/light) |
| `accent` | String | `#7c5cff` | 主题色 |
| `density` | String | `comfortable` | 排版密度 |
| `lang` | String | `zh-CN` | 界面语言 |
### 参数规范(`paramTypes`)
| API | 字段 | 规则 |
|---|---|---|
| `setConfig(patch)` | `patch` | **必填**,type: object |
调用:`minecraft_verity_wiki().paramTypes('setConfig')`。
---
## 2. 页面模型(Page Model)
| 方法 | 返回 | 说明 |
|---|---|---|
| `registerPage({id, title, render, schema, permissions})` | — | 注册页面,**id 必填** |
| `renderPage(id, data, opts)` | `String` | 渲染页面,**id 必填** |
| `unregisterPage(id)` | — | 注销页面 |
| `getPage(id)` | `Object` | 取页面定义 |
| `listPages()` | `Array` | 所有已注册页面 |
---
## 3. 中间件 / 插件(Middleware & Plugin)
| 方法 | 返回 | 说明 |
|---|---|---|
| `use(middleware)` | — | 注册中间件(compose 链) |
| `usePlugin({plugin, name, dependencies, install})` | — | 安装插件,**plugin 必填** |
| `compose(...fns)` | `Function` | 组合函数 |
---
## 4. 数据迁移(Migrate)
| 方法 | 返回 | 说明 |
|---|---|---|
| `migrate(data, opts)` | `Object` | 执行迁移,**data 必填** |
| `addMigration({version, up, down})` | — | 注册迁移,**up 必填** |
| `importData(data, opts)` | — | 导入数据,**data.\_\_namespace 必填** |
| `validate(data)` | `Object` | 校验数据合法性 |
| `defineValidator({name, schema})` | — | 定义校验器,name/schema **必填** |
---
## 5. 模板 / 存储 / 事务
| 方法 | 返回 | 说明 |
|---|---|---|
| `defineTemplate(name, tpl)` | — | 定义模板 |
| `store.set(key, val)` | — | 存储(持久化) |
| `store.get(key)` | `Any` | 读取 |
| `store.delete(key)` | — | 删除 |
| `store.clear()` | — | 清空 |
| `transaction(fn)` | — | 事务 + 自动快照回滚 |
---
## 6. 事件系统(Events)—— `emit / on / off / once`
### 已定义的事件名
**配置**:`config:applied` · `config:changed` · `config:invalid` · `config:reset`
**页面**:`page:registered` · `page:unregistered` · `page:*`(通配)
**路由**:`route:handled` · `route:registered` · `route:error`
**插件**:`plugin:installed` · `plugin:uninstalled`
**迁移**:`migrate:start` · `migrate:done` · `migrate:error` · `migration:added`
**历史**:`history:added` · `history:cleared` · `history:undo`
**事务**:`transaction:start` · `transaction:commit` · `transaction:rollback`
**其他**:`init:done` · `init:again` · `help:shown` · `content:appended` · `data:exported` · `data:imported` · `destroy:cleaned` · `destroy:done` · `middleware:registered` · `mount:created` · `mount:removed` · `sandbox:error` · `store:set` · `store:deleted` · `store:cleared` · `template:defined` · `template:rendered` · **`play`**(视频)
---
## 7. 标准 Wiki 层(`.wiki`)
| 方法 | 返回 | 说明 |
|---|---|---|
| `wiki.engine` | Object | 引擎引用 |
| `wiki.version` | String | Wiki 版本 |
| `wiki.namespace` | String | 命名空间 |
| `wiki.schema` | Number | Schema 版本 |
| `wiki.createAPI(...)` | Object | 创建受限 API |
| `wiki.utils` | Object | 工具集 |
| `wiki.selfCheck()` | Object | Wiki 自检 |
### Wiki 功能方法(Special 特殊页面)
| 方法 | 返回 | 说明 |
|---|---|---|
| `allPages()` | `Array` | 所有页面 |
| `recentChanges()` | `Array` | 最近更改 |
| `randomPage()` | `Object` | 随机页面 |
| `longPages()` | `Array` | 长页面 |
| `shortPages()` | `Array` | 短页面 |
| `orphanPages()` | `Array` | 孤立页面 |
| `whatLinksHere()` | `Array` | 链入页面 |
| `diff(...)` | `Object` | 版本差异(LCS) |
| `validate(...)` | `Object` | 校验 |
| `rollback(...)` | — | 回滚 |
| `magicWords()` | `Object` | 魔术字 |
| `snapshot()` | `Object` | 快照 |
| `paramTypes(name)` | `Object` | 参数规范查询 |
### 时间戳(标准 Wiki 设置)
| 方法 | 返回 | 说明 |
|---|---|---|
| `getWikiTimestamp()` | `String` | 取当前时间戳 |
| `searchEnabled` (config) | Boolean | 搜索开关,**默认 `true`** |
| `searchTimestamp` (config) | String | `system`(默认) / `custom` |
| `customTimestamp` (config) | String | 自定义内容,可选,留空回退系统 |
---
## 8. 视频模块(VPCore)—— `.video`
挂载:`minecraft_verity_wiki().video` 或全局 `VPCore`
| 方法 | 返回 | 说明 | 必填/可选 |
|---|---|---|---|
| `play(id)` | — | 播放视频,**id 必填** | id **必填** |
| `pause()` | — | 暂停 | — |
| `stop()` | — | 停止 | — |
| `seekBy(delta)` | — | 相对定位(秒) | — |
| `setRate(rate)` | — | 倍速(0.5/1/1.5/2) | — |
| `list()` | `Array` | 视频列表 | — |
| `current()` | `Object` | 当前视频 | — |
| `on(event, fn)` | — | 订阅事件 | — |
| `close()` | — | 关闭播放器 | — |
| `showFallback()` | — | 降级为外链 | — |
| `addVideo(item)` | — | 添加视频,id **必填** | — |
| `removeVideo(id)` | — | 移除视频 | — |
| `addCreator(c)` | — | 添加作者,id **必填** | — |
| `detectPlatform()` | `Object` | 平台检测(iOS/Android/Windows 等) | — |
| `detectRegion()` | `Object` | 地区检测(国内/海外) | — |
### 视频字段定义
| 字段 | 规则 |
|---|---|
| `id` | **必填** |
| `title` / `platform` / `embed` / `author` | 可选,有默认 |
| `platformLabel` | 自动派生 |
---
## 9. 全局工具函数(Global Helpers)
| 函数 | 说明 |
|---|---|
| `getWikiTimestamp()` | 时间戳 |
| `detectPlatform()` / `detectRegion()` | 设备/地区检测 |
| `renderPacks()` | 渲染整合包表 |
| `renderBili()` | 渲染 B站视频 |
| `renderVideo()` | 渲染视频卡片 |
| `renderCreators()` | 渲染作者卡片 |
| `renderContacts()` | 渲染联系方式 |
| `getEmbedUrl()` / `buildEmbed()` | 嵌入 URL 构造 |
| `findVideo(id)` | 查找视频 |
| `escHtml()` / `escAttr()` / `esc()` / `escRegex()` | 转义(防 XSS) |
| `thumbGradient()` | 缩略图渐变 |
| `runSearch()` / `highlight()` / `clearHighlights()` | 搜索与高亮 |
| `toast()` / `showToast()` | 提示 |
| `loadSettings()` / `saveSettings()` / `applyAll()` / `applyAccent()` / `syncUI()` / `bindSettings()` / `initSettings()` / `refreshPreview()` / `toggleCustomRow()` / `applyEnabled()` | 设置系统 |
| `showPage()` / `getCurrentPage()` | 页面切换 |
| `loadEdits()` / `saveEdits()` / `exportEdits()` / `importEdits()` / `resetEdits()` / `undoLast()` / `renderHistory()` / `initEditor()` / `toggleEditMode()` | 编辑/修订系统 |
| `mountSelfCheck()` / `runSelfCheck()` | 自检挂载 |
| `buildIndex()` | 搜索索引 |
| `getNow()` | 当前时间 |
| `getBox()` / `getWrap()` | DOM 辅助 |
---
## 10. 页面路由(Hash Routes)
| Hash | 页面 |
|---|---|
| `#home` | 首页 |
| `#about` | 关于 |
| `#lore` | 背景 |
| `#phases` | 阶段 |
| `#box` | 纸箱 |
| `#ai` | AI |
| `#anger` | 愤怒机制 |
| `#entities` | 实体 |
| `#items` | 物品 |
| `#commands` | 命令 |
| `#versions` | 版本 |
| `#install` | 安装/整合包 |
| `#forum` | 论坛归档 |
| `#faq` | 问答 |
| `#settings` | 设置(含标准 Wiki 设置) |
| `#editwiki` | 编辑 |
| `#mods` | 模组网站 |
| `#modsites` | 模组站点介绍 |
| `#engine` | 引擎 API |
| `#bilibili` | B站教程 |
| `#video` | 视频平台 |
| `#creators` | 视频作者 |
| `#lexicon` | 词汇表 |
| `#contact` | 联系方式 |
| `Special:*` | Wiki 特殊页面 |
---
## 11. 快速示例
```js
- const wiki = window.minecraft_verity_wiki();
- wiki.setConfig({ editable: true }); // ① 开启编辑
- wiki.paramTypes('setConfig'); // 查参数规范
- wiki.selfCheck(); // 自检
- wiki.video.play('verity-be-official'); // 播放在线视频
- wiki.video.setRate(1.5); // 1.5 倍速
- wiki.video.detectPlatform(); // 设备信息
- getWikiTimestamp(); // 系统时间戳
- wiki.allPages(); // Wiki 全部页面
- wiki.recentChanges(); // 最近更改
- wiki.store.set('key', 'value'); // 持久化
- wiki.addVideo({ id:'v1', title:'...' }); // 扩展视频
复制代码
```
---
**规则回顾**:所有"修改内部值"的操作必须经上述带 `minecraft_verity_wiki` 调用头的 API;**必填项省略即报错,可选项省略取默认值**。
详细去下载API.md文件
API.md
(10.06 KB, 下载次数: 5)
当然也有文件,也能下载
verity-wiki-release.zip
(6.76 MB, 下载次数: 2)
如果您觉得比较好的话,可以跟我们赞助一下,我们会提供永远的优质服务给您,包括wiki等等项目等等
网站实景 |
-
-
|