a MUD Client written in Python
Reason this release was yanked:
bug.
Project description
PyMUD - Python原生MUD客户端
简介
帮助文件见北侠WIKI: https://www.pkuxkx.net/wiki/tools/pymud
源代码地址: https://github.com/crapex/pymud
使用交流QQ群:554672580
北大侠客行Mud (www.pkuxkx.net),最好的中文Mud游戏!
PyMUD是我为了更好的玩北大侠客行,特意自行开发的MUD客户端。PyMUD具有以下特点:
- 原生Python开发,除prompt-toolkit及其依赖库(wcwidth, pygment, pyperclip)外,不需要其他第三方库支持
- 基于控制台的全屏UI界面设计,支持鼠标操作(Android上支持触摸屏操作)
- 支持分屏显示,在数据快速滚动的时候,上半屏保持不动,以确保不错过信息
- 解决了99%情况下,北大侠客行中文对不齐,也就是看不清字符画的问题(因为我没有走遍所有地方,不敢保证100%)
- 真正的支持多session会话,支持命令或鼠标切换会话
- 原生支持多种服务器端编码方式,不论是GBK、BIG5、还是UTF-8
- 支持NWAS、MTTS协商,支持GMCP、MSDP、MSSP协议
- 一次脚本开发,多平台运行。只要能在该平台上运行python,就可以运行PyMUD客户端
- 脚本所有语法均采用Python原生语法,因此你只要会用Python,就可以自己写脚本,免去了再去学习lua、熟悉各类APP的使用的难处
- Python拥有极为强大的文字处理能力,用于处理文本的MUD最为合适
- Python拥有极为丰富的第三方库,能支持的第三方库,就能在PyMud中支持
- 我自己还在玩,所以本客户端会持续进行更新:)
版本更新信息
0.15.8 (2023-12-05)
发布到pip,增加模块使用
0.16.1 (2023-12-11)
- 问题修复:修复__init__.py中的__all__变量为字符串
- 功能增加:可以加载自定义Settings。在执行python -m pymud时,会自动从当前目录读取pymud.cfg文件。使用json格式将配置信息写在该文件中即可。支持模块中settings.py里的sessions, client, server, styles, text字段内容。
- 功能增加:增加全局变量集,可以使用session.setGlobal和session.getGlobal进行访问,以便于跨session通信。也可以使用#global在命令行访问
- 功能增加:增加变量的持久化,持久化文件保存于当前目录,文件名为session名称.mud,该文件在会话初始化时自动读取,会话断开时自动保存,其他时候使用#save保存。
- 功能增加:在extras.py中增加DotDict,用于支持字典的.访问方式
- 功能增加:使用DotDict增加了session有关对象的点访问方式(.)的快捷访问,包括变量vars,全局变量globals,触发器tris,别名alis,命令cmds,定时器timers,gmcp。例如:session.vars.charname,相当于session.getVariable('charname')
- 功能增加:增加#all命令,可以向当前所有活动会话发送同一消息,例如#all xixi,可以使所有连接的会话都发送emote
- 功能增加:增加%copy系统变量,当复制后,会将复制内容赋值给%copy变量
- 功能增加:增加Trigger测试功能,使用#test {msg}在命令行输入后,会如同接收到服务端数据一样引发触发反应,并且会使用[PYMUD TRIGGER TEST]进行信息显示。
- 功能增加:匹配#test命令和%copy变量使用如下:窗体中复制有关行,然后命令行中输入#test %copy可使用复制的行来测试触发器
- 功能修改:将原CodeBlock修改为CodeBlock和CodeLine组成,以适应新的#test命令
- 功能修改:session对命令的输入异步处理函数handle_input_async进行微小调整,以适应#test命令使用
- 功能修改:退出时未断开session时的提示窗口文字改为红色(原黄色对比度问题,看不清楚)
- 功能修改:恢复了#help功能,可以在任意会话中使用#help列出所有帮助主题,#help {topic}可以查看主题详情
- 功能修改:在#reload重新加载脚本时,保留变量数据
0.16.1.post1 (2023-12-12)
- 问题修复:修复版本显示,更正问为0.16.1(原0.16.0)
- 问题修复:发布日期标志修改为当前时间
- 功能修改:CodeLine的执行运行处理修改为不删除中间的多余空白
0.16.1.post2 (2023-12-12)
- 问题修复:修改github项目地址为原pymud地址
0.16.2a1 (2023-12-18)
- 功能修改:归一化#命令和非#命令处理,使session.exec_command、exec_command_async、exec_command_after均可以处理#命令,例如session.exec_command("#save")。同时,也可以在命令行使用#all发送#命令,如"#all #save"此类
- 功能修改:调整脚本加载与变量自动加载的顺序。当前为连接自动加载时,首先加载变量,然后再加载脚本。目的是使脚本的变化可以覆盖加载的变量内容,而不是反向覆盖。
- 功能修改:会话变量保存和加载可以配置是否打开,默认为打开。见Settings.client["var_autosave] 和 Settings.client["var_autoload"]。同理,该配置可以被本地pymud.cfg所覆盖
- 功能修改:将MatchObject的同步onSuccess和异步await的执行顺序进行调整,以确保一定是同步onSuccess先执行。涉及Trigger、Command等。
- 功能修改:修改了GMCPTrigger的onSuccess处置和await triggered处置参数,以保持与Trigger同步。当前,onSuccess函数传递3个参数,name,line(GMCP收到的原始str数据),wildcards(经eval处理的GMCP数据,大概率是dict,偶尔也可能eval失败,返回与line相同值)。await triggered返回与Triggerd的await triggered相同,均为BaseObject.State,包含4个参数的元组,result(永为True),name(GMCP的id),line(GMCP原始数据),wildcards(GMCP处理后数据)。其中,后3个参数与onSuccess函数调用时传递参数相同。
0.16.2 (2023-12-19)
- 功能修改:增加GMCP默认处理。当未使用GMCPTrigger对对应的GMCP消息进行处理时,默认使用[GMCP] name: value的形式输出GMCP收到的消息,以便于个人脚本调试。
- 功能修改:修改GMCP数据的处理方式从eval修改为json.load,其余不变。
0.17.0a1 (2023-12-20)
- 功能修改:调整修改GMCP数据的wildcards处理方式,恢复为eval,其余不变。(回滚0.16.2版更改)
- 功能修改:将本地pymud.cfg文件的读取默认编码调整为utf8,以避免加载出现问题
- 问题修复:sessions.py中,修复系统command与会话command重名的问题(这次才发现)
- 功能修改:将自动脚本加载调整到session创建初始,而不论是否连接服务器
- 功能修改:脚本load和reload时,不再清空任何对象,保留内容包括:中止并清空所有task,关闭所有定时器,将所有异步对象复位
- 功能修改:去掉了左右边框
0.17.0b1 (2023-12-23)
- 问题修复:修复了当使用session.addCommand/addTrigger/addAlias等添加对象,而对象是Command/Trigger/Alias等的子类时,由于类型检查失败导致无法成功的问题
- 功能修改:增加自动重连配置,Settings.client["auto_reconnect"]配置,当为True时,若连接过程中出现异常断开,则10秒后自动重连。该配置默认为False。
- 功能修改:当连接过程中出现异常时,异常提示中增加异常时刻。
- 功能修改:#reload指令增加可以重新加载插件功能。例如,#reload chathook会重新加载名为chathook的插件。
- 功能增加:增加#py指令,可以直接在命令行中写代码并执行。执行的上下文环境为当前环境,即self代表当前session。例如,#py self.writeline("xixi")相当于直接在脚本会话中调用发送xixi指令
- 功能新增:新增插件(Plugins)功能。将自动读取pymud模块目录的plugins子目录以及当前脚本目录的plugins子目录下的.py文件,若发现遵照插件规范脚本,将自动加载该模块到pymud。可以使用#plugins查看所有被加载的插件,可以直接带参数插件名(如#plugins myplugin)查看插件的详细信息(自动打印插件的__doc__属性,即写在文件最前面的字符串常量)插件文件中必须有以下定义:
名称 | 类型 | 状态 | 含义 |
---|---|---|---|
PLUGIN_NAME | str | 必须有 | 插件唯一名称 |
PLUGIN_DESC | dict | 必须有 | 插件描述信息的详情,必要关键字包含VERSION(版本)、AUTHOR(作者)、RELEASE_DATE(发布日期)、DESCRIPTION(简要描述) |
PLUGIN_PYMUD_START | func(app) | 函数定义必须有,函数体可以为空 | PYMUD自动读取并加载插件时自动调用的函数, app为PyMudApp(pymud管理类)。该函数仅会在程序运行时,自动加载一次 |
PLUGIN_SESSION_CREATE | func(session) | 函数定义必须有,函数体可以为空 | 在会话中加载插件时自动调用的函数, session为加载插件的会话。该函数在每一个会话创建时均被自动加载一次 |
PLUGIN_SESSION_DESTROY | func(session) | 函数定义必须有,函数体可以为空 | 在会话中卸载插件时自动调用的函数, session为卸载插件的会话。卸载在每一个会话关闭时均被自动运行一次。 |
0.17.0 (2023-12-24)
- 功能修改:对session自动加载mud文件中变量失败时的异常进行管理,此时将不加载变量,自动继续进行
- 功能修改:所有匹配类对象的匹配模式patterns支持动态修改,涉及Alias,Trigger,Command。修改方式为直接对其patterns属性赋值。如tri.patterns = aNewPattern
- 功能修改:连接/断开连接时刻都会在提示中增加时刻信息,而不论是否异常。
0.17.1 (2023-12-27)
本版对模块功能进行了整体调整,支持加载/卸载/重载/预加载多个模块,具体内容如下:
- 当模块中存在名为Configuration类时,以主模块形式加载,即:自动创建该Configuration类的实例(与原脚本相同)
- 当模块中不存在名为Configuration类时,以子模块形式加载,即:仅加载该模块,但不会创建Configuration的实例
- #load命令支持同时加载多个模块,模块名以半角逗号(,)隔开即可。此时按给定的名称顺序逐一加载。如:#load mod1,mod2
- 增加#unload命令,卸载卸载名称模块,同时卸载多个模块时,模块名以半角逗号(,)隔开即可。卸载时,如果该模块有Configuration类,会自动调用其__del__方法
- 修改reload命令功能,当不带参数时,重新加载所有已加载模块,带参数时,首先尝试重新加载指定名称模块,若模块中不存在该名称模块,则重新加载指定名称的插件。若存在同名模块和插件,则仅重新加载插件(建议不要让插件和模块同名)
- 增加#modules(简写为#mods)命令,可以列出所有已经加载的模块清单
- Session类新增load_module方法,可以在脚本中调用以加载给定名称的模块。该方法接受1个参数,可以使用元组/列表形式指定多个模块,也可以使用字符串指定单个模块
- Session类新增unload_module方法,可以在脚本中调用以卸载给定名称的模块。参数与load_module类似。
- Session类新增reload_module方法,可以在脚本中调用以重新加载给定名称的模块。当不指定参数时,重新加载所有模块。当指定1个参数时,与load_module和unload_module方法类似
- 修改Settings.py和本地pymud.cfg文件中sessions块脚本的定义的可接受值。默认加载脚本default_script现可接受字符串和列表以支持多个模块加载。多个模块加载有两种形式,既可以用列表形式指定多个,如["script1","script2"],也可以用字符串以逗号隔开指定多个,如"script1,script2"
- 修改Settings.py和本地pymud.cfg文件中sessions块脚本中chars指定的会话菜单参数。当前,菜单后面的列表参数可以支持额外增加第3个对象,其中第3个为该会话特定需要加载的模块。该参数也可以使用逗号分隔或者列表形式。
- 当创建会话时,自动加载的模块会首先加载default_script中指定的模块名称,然后再加载chars中指定的模块名称。
- 上述所有修改均向下兼容,不影响原脚本使用。
- 一个新的修改后的pymud.cfg示例如下
{
"sessions": {
"pkuxkx" : {
"host" : "mud.pkuxkx.net",
"port" : "8081",
"encoding" : "utf8",
"autologin" : "{0};{1}",
"default_script": ["pkuxkx.common", "pkuxkx.commands", "pkuxkx.main"],
"chars" : {
"char1": ["yourid1", "yourpassword1"],
"char2": ["yourid2", "yourpassword2", "pkuxkx.wudang"],
"char3": ["yourid3", "yourpassword3", "pkuxkx.wudang,pkuxkx.lingwu"],
"char4": ["yourid4", "yourpassword4", ["pkuxkx.shaolin","pkuxkx.lingwu"]]
}
}
}
}
0.17.1post1 (2023-12-27)
- 问题修复:修复enableGroup中定时器处的bug
- 功能修改:会话连接和重新连接时,取消原定时器停止的设定,目前保留为只清除所有task、复位Command
- 功能修改:auto_reconnect设定目前对正常/异常断开均有效。若设置为True,当连接断开后15s后自动重连
- 功能修改:会话菜单下增加“打开/关闭自动重连”子菜单,可以动态切换自动重连是否打开。
0.17.2 (2023-12-28)
- 功能修改:会话菜单 "显示/隐藏命令" 和 "打开/关闭自动重连" 操作后,增加在当前会话中提示状态信息。
- 功能修改:Timer实现进行修改,以确保一个定时器仅创建一个任务。
- 功能调整:Timer对象在复位Session对象时,也同时复位。目的是确保reload时不重新创建定时器任务。
- 功能调整:在会话连接时,不再复位Session有关对象信息。该复位活动仅在连接断开时和脚本重新加载时进行。
- 功能调整:启动PYMUD时,会将控制台标题设置为PYMUD+版本号。
0.17.2post1 (2023-12-28)
- 问题修复:修复定时器Timer中的bug。
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pymud-0.17.2.post1.tar.gz
(108.8 kB
view hashes)
Built Distribution
Close
Hashes for pymud-0.17.2.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c32a7c6364f2baa2d13191c11f06542ca0c5bdb2c783a03f2c5baebebbb0b9b4 |
|
MD5 | 9a9384601dc7537840850f8327d06560 |
|
BLAKE2b-256 | 2518159d806c7fa46d069b8a789a96fd0a9730cbfff03b27aba1f0a13e77e22c |