Vector API 文档

Vector 提供与网易我的世界游戏底层交互的 Python API，帮助开发者快速构建机器人插件和自动化工具。

基础环境：Python 2.7.18 MSVC | 环境完全隔离 | 控制台 GBK 编码

模块总览

模块	说明	适用场景
`engine`	核心交互模块	所有与游戏交互的操作
`setting`	配置信息模块	获取登录配置、版本等
`utility`	工具函数模块	加密、解密、Token 生成
`fop`	内核模块	高级开发（不推荐常规使用）

环境信息

项目	值
Python 版本	`2.7.18`
编译器	MSVC
环境隔离	完全隔离
控制台编码	GBK

所有函数返回值类型标注为 void 表示无返回值，str/int/float/list/bool 为对应返回值类型。Python 语法需遵循 2.7 规范（如 print 无括号）。

核心模块 · engine

任何需要和游戏交互的操作均需使用该模块，是与游戏底层交互的核心入口。

事件注册与触发

void engine.register(object callback, str event_name)

注册事件处理器，机器人触发 Python 逻辑的关键入口。一个事件可注册多个处理器，支持被 C++ 层调用。

python

def event_handle(args):
    print '事件已触发'

engine.register(event_handle, 'event_name')

void engine.trigger(str event_name, list args)

触发全局事件或自定义事件。后台会自动调用所有注册了该事件的处理函数。

python

engine.trigger('my_event', ['param1', 'param2'])

游戏交互

void engine.message(str sender, str content)

在游戏聊天栏发送消息。sender 可为空字符串。

void engine.command(str cmd)

发送游戏普通指令，无需管理员权限。

void engine.command_guid(str command, str guid)

带 GUID 的指令发送。GUID 为 16 字节随机值，用于判断指令返回归属。

void engine.respawn()

复活玩家。

void engine.move(float x, float y, float z)

将自身传送到指定三维坐标。

服务器/进程信息

str engine.get_server_ip()

返回当前服务器 IP 地址。

int engine.get_server_port()

返回当前服务器端口号。

list engine.getparams()

获取进程启动参数。

int engine.get_entity_runtime_id()

获取玩家实体运行时 ID。

坐标与视角

获取坐标

float engine.get_pot_x()

float engine.get_pot_y()

float engine.get_pot_z()

获取玩家当前 x/y/z 坐标值。

增加坐标

void engine.add_pot_x(float delta)

void engine.add_pot_y(float delta)

void engine.add_pot_z(float delta)

给当前 x/y/z 坐标增加指定浮点值。

头部视角

float engine.get_head_x()

float engine.get_head_y()

获取玩家头部 x/y 旋转角度。

void engine.add_head_x(float delta)

void engine.add_head_y(float delta)

增加玩家头部 x/y 旋转角度。

权限/配置/工具

void engine.disabled_auth_input()

启动 authinput 支持，启用后每 tick 发送验证包。

void engine.enable_auth_input()

关闭 authinput 支持。

bool engine.get_auth_input()

获取当前 authinput 开启状态。

bool engine.get_mcp_load_config()

返回当前文件配置，代表 MCP 模式和源代码模式。

void engine.settingscommand(str cmd)

发送 setting 格式指令，拥有控制台权限（游戏内需管理员权限）。

void engine.system(str cmd)

执行 Windows 平台 CMD 指令，功能同系统 system。

void engine.exit(int code)

关闭当前进程，功能同系统 exit。

特殊功能

void engine.command_update(int x, int y, int z, int type, bool needs_redstone, bool conditional, int delay, bool execute_first_tick, str command, str name)

更新命令方块内的数据。参数依次为：x/y/z 坐标、命令方块类型、是否需要红石、是否有条件、延迟、是否在第一个 tick 执行、实际指令、命令方块名称。

void engine.rpc(object data)

发起远程调用，需搭配 msgpack 使用。

python

engine.send(umsgpack.packb(['ModEventC2S', [None], None]))

杂项模块 · setting

用于获取当前玩家的登录配置、版本等基础信息。

str setting.gettoken()

获取当前登录 token。

str setting.getplayerid()

获取 Py 层玩家实体 ID。

str setting.get_engine_version()

获取当前引擎版本。

str setting.get_patch_version()

获取当前补丁版本。

str setting.get_uid()

获取当前用户 ID。

str setting.get_name()

获取当前玩家昵称。

杂项模块 · utility

提供加密、解密、动态 token 生成等工具类功能，适配游戏接口鉴权。

str utility.encrypt_with_tail(str data)

加密字符串，与 /authentication-v2 加密模式一致。

str utility.decrypt_with_tail(str data)

解密密文字符串，与 /authentication-v2 加密模式一致。

str utility.get_encrypt_token(str token, str body, str url)

生成 HTTP 动态 token，用于填写 user-token 请求标头（类似 x-sign）。

引擎内置事件

事件为引擎触发 Python 逻辑的触发点，部分事件携带入参，可通过 engine.register 注册处理器。

ModEventStartUp

触发时机：所有插件加载完成后，可作为加入游戏的初始化函数。
on_respawn

触发时机：玩家死亡后触发。
on_move_player

触发时机：tp 指令传送自身后触发。携带参数：xyz 坐标轴列表。
on_command_output

触发时机：发送指令后触发。携带参数：指令返回值、GUID。
on_player_list

触发时机：进入服务器后触发。返回参数：玩家列表。
on_text

触发时机：收到聊天栏消息后触发。
on_disconnect

触发时机：与服务器断开连接后触发。
on_rpc

触发时机：收到远程调用后触发。
reload

触发时机：手动/底层触发后，重新加载全部插件。

内核模块 · fop

提示：正常用户无需使用该模块，推荐使用 MCP 模式开发。