【MUSH框架】基于MUSH的模块化机器人设计之底层框架_【一个脚本走天下v20141214】

littleknife

****************************************************************************************
一、【一个脚本】的核心思路：
以模块化脚本框架引用方式实现机器人的集成化，使得复杂机器的编写成为可能；单一的配置文件配置MUSH的运行状态，使得配置MUSH更加简洁。
****************************************************************************************
       （1）设置文件的编辑变成统一【一个脚本】，使机器的撰写更加方便。MUSH的设置文件主要包含变量、脚本、触发、Alias等，都是各自的文件，要想设置好一个机器人需要自己存储这些文件。而更换机器人就要把它们都换一遍，这里的【一个脚本走天下】其核心思路就是考虑以前用惯了zmud的用.mud文件的思路，以一个文件引用所有的东西。而脚本框架的应用则彻底不再依靠MUSH的触发、变量、alias的配置文件意思。

        （2）框架所提供的整合代码的思路，使得复杂的冗长的lua代码被实质上整合到【一个脚本】里，所以这也是其核心思路之一。通过这种模块化的集成，力图只制作一个集成脚本【框架脚本】就可以完成机器人的研发。而【底层框架】则为大多数应用层机器人提供了核心的函数及方法。

      其实这种模块化的思路好多玩家已经在自觉不自觉的使用了。所以，机器达人们请不要见笑，鲁班门前弄大斧了。
作为自己的一篇学习笔记、一篇心得体会，发出来供大家共勉，抛砖引玉罢了。有心的朋友请您提出宝贵的意见和建议，谢谢！

****************************************************************************************
****************************************************************************************
★pkuxkx2014【一个脚本走天下】之《底层框架》集成模块文件V20141214：
补充MUSH自带的wait.lua模块：将此文件拷贝至MUSH\lua目录下。
****************************************************************************************
【注：此脚本框架文件不可与城际互联插件同时使用，否则相互冲突。压缩包中的db库是城际互联节点库，请拷贝至MUSHclient.exe目录下。】

****************************************************************************************
★成功加载《底层框架》后的界面效果如下：
****************************************************************************************


****************************************************************************************
二、【一个脚本】框架的先续基础内容：你若想弄清楚下面的内容，得提前知道的内容是：
****************************************************************************************


如何建立一个MUSH的总文件MCL文件；
如何在这个文件的引用.lua脚本；
基本MUSH的常识性知识：比如什么是MUSH的变量，Lua的变量、正则表达式是什么、什么是触发等等。
MUD游戏的基本常识性知识：行走、吃饭、喝水、看东西、学习、打坐、吐纳，这些都是什么意思。
基本的lua编程基础：比如什么是lua，什么是表格。基本lua程序语言的写法等等。

****************************************************************************************
三、【底层框架】的使用方法：
****************************************************************************************

        首先，用一个总的配置文件（这里是pkuxkx_littleknife.lua）作为主引用文件，里面有一定的初始设置。其中包含底层框架
模块文件xkx_frame.mod的载入，通过这个mod文件（mod文件是我自己定义的文件，格式就是文本文件）固定几个底层模块（*.mod），
如：行走系统模块、系统函数模块、战斗模块、学习练习模块等等。注意：这里有载入顺序问题，顺序不对也许会出错。

        最后，则是以表格loadlua_list作为应用层模块的引用来调各个【应用层模块】。

---------------------------------------------------------------------------------------------------------------------------
pkuxkx_playerid.lua：总配置文件，只需要对这个总配置文件进行适当的修改即可完成载入模块的目的。
---------------------------------------------------------------------------------------------------------------------------
关于各个mod文件： 【 鉴于一楼资源紧张，各mod模块中的函数简介放在二楼。】
在mod目录下，还有一些以mod为扩展名的文本文件。这些被我称为底层引用库文件，主要是提供一些实用函数。
鉴于广大同学的建议，这里不再详细说明各个mod的函数，有些东西也都是自己按需要加入到底层框架中。只是在下面【应用模块】中以实例
的形式把常用的底层函数加以介绍吧。相信，随着时间的推移。多数同学会形成自己的底层框架支持函数。
---------------------------------------------------------------------------------------------------------------------------
****************************************************************************************
四、【应用层模块】的设计与使用：如何用框架来做应用层模块，就是怎么来用MUSH做模块化机器人的问题。
****************************************************************************************

首先，是你开发的【应用层模块】应放在总配置文件pkuxkx_playerid.lua（即调用文件，压缩包里的是pkuxkx_littleknfie.lua）的loadlua_list表中。形如下图：
其次，你只要集中精力弄自己的应用模块，及合理使用框架函数即可。

比如我编了个quest_hubiao.lua的机器人，怎么加入到框架中？就是loadlua_list表加一行“quest_hubiao.lua”即可。

注：这里的mod和lua文件都是文本文件、lua代码，格式上没有区别。只是我为了区分已完成的模块自定义为Mod。研发和测试代码我用Lua扩展名而已。






****************************************************************************************
1、封装模块（面向对象程序设计）：

        应用层模块的研发，我的建议是用封装模块的形式做，也就是面向对象程序设计的思路。即：无论是【应用中心】还是【任务模块】均采用封
装的形式进行封装。其好处是均以对象的方式使用，可以随时整合到各个使用机器人中。

1. 
   
2. -----具体的封装代码：
   
3. AppMOD={
   
4.         new=function()
   
5.                 local _AppMOD={}
   
6.                 setmetatable(_AppMOD,{__index=AppMOD})
   
7.                 return _AppMOD
   
8.         end,
   
9.         interval=5,
   
10.         timeout=20,
    
11.         help="格式：帮助文件",
    
12.         -------------------------------------
    
13.         Sleeproomno=player.Sleeproomno,
    
14.         Eatfoodroomno=player.Eatfoodroomno,
    
15.         Trainingroomno=player.Trainingroomno,
    
16.         -------------------------------------
    
17.         aimroomno="",
    
18.         aimroomname="",
    
19.         -------------------------------------
    
20.         jobnpcname="",
    
21.         jobnpcid="",
    
22.         jobnpcmenpai="",
    
23.         jobwords="",
    
24. }
    
25. 
    
26. function AppMOD:finish()
    
27. end
    
28. 
    
29. function AppMOD:fail()
    
30. end
    
31. 
    
32. AppMOD_button=function()
    
33.         print(AppMOD.help)
    
34.         SetCommandSelection (1, -1)
    
35.         PasteCommand("#AppMOD ")
    
36. end
    
37. 
    
38. AppMOD_alias=function(name, line, wildcards)
    
39.         do_AppMOD(wildcards,AppMOD_ok,AppMOD_fail)
    
40. end
    
41. 
    
42. do_AppMOD=function(wildcards,AppMOD_ok,AppMOD_fail)
    
43.         local tmp_AppMOD=AppMOD.new()
    
44.         tmp_AppMOD.finish=AppMOD_ok
    
45.         tmp_AppMOD.fail=AppMOD_fail
    
46.         tmp_AppMOD:start(wildcards)
    
47. 
    
48. end
    
49. 
    
50. function AppMOD:start(wildcards)
    
51.         wait.make(function()
    
52.         self:update()
    
53.         local f=function() self:check(wildcards) end
    
54.         getinfo(f)
    
55.         end)
    
56. end
    
57. -----封装后模块的应用：
    
58. （1）do_AppMOD(wildcards,AppMOD_ok,AppMOD_fail)，命令引用。
    
59. （2）脚本定义引用：形如：
    
60.                 local xkd_studyliterate=qxuexi.new()
    
61.                 local condition={"shi","literate",100,nil,"west;west"}
    
62.                         xkd_studyliterate.Sleeproomno=self.Sleeproomno
    
63.                         xkd_studyliterate.Eatfoodroomno=self.Eatfoodroomno
    
64.                         xkd_studyliterate.menpai="xkd"
    
65. 
    
66.                         xkd_studyliterate.finish=function()
    
67.                                 self.need_studyliterate=false
    
68.                                 self:main()
    
69.                         end
    
70.                         xkd_studyliterate:start(condition)
    

复制代码

****************************************************************************************
2、应用模块的研发实例：
        【应用实例】的代码文件是：xkd_rb.lua。其中里面包含了【应用中心】xkd_center的代码，执行层【任务模块】xkd_Diaoyu的代码。限于篇幅，请自行下载前面的压缩文件查阅。

        在新的框架模块下，应用模块的研发是基于一个总的【应用中心】的任务框架思路来完成的，其核心设计思想是尽可能的实现总协调的目的。定义是：判定自身状态并指向执行层的【任务模块】，也就是总调度文件的意思。下面以一个非pkuxkx的【侠客岛钓鱼机器】的例子说明下用法。   

（1）【应用中心】的代码：

贴完代码，我才发现，这个代码的格式整理真是头痛的要命。故此，限于篇幅我已经在pkuxkx_mod2014这个压缩包里，涵盖了相关代码。也注释了部分内容。这里提供的还是一个框架性质的代码文件。希望诸位能理解，也希望借此给哪些新入MUSH的玩家以借鉴性的作用。

（2）【任务模块】，即执行层的代码：这里钓鱼就是任务。这里任务的定义是通过一系列命令可以获取经验和潜能的事件。


（3）一个完整的执行层【任务模块】框架代码：

1. 
   
2. AppMOD={
   
3.         new=function()
   
4.                 local _AppMOD={}
   
5.                 setmetatable(_AppMOD,{__index=AppMOD})
   
6.                 return _AppMOD
   
7.         end,
   
8.         interval=5,
   
9.         timeout=20,
   
10.         help="格式：帮助文件",
    
11.         -------------------------------------
    
12.         Sleeproomno=player.Sleeproomno,
    
13.         Eatfoodroomno=player.Eatfoodroomno,
    
14.         Trainingroomno=player.Trainingroomno,
    
15.         -------------------------------------
    
16.         aimroomno="",
    
17.         aimroomname="",
    
18.         -------------------------------------
    
19.         jobnpcname="",
    
20.         jobnpcid="",
    
21.         jobnpcmenpai="",
    
22.         jobwords="",
    
23. }
    
24. 
    
25. function AppMOD:finish()
    
26. end
    
27. 
    
28. function AppMOD:fail()
    
29. end
    
30. 
    
31. AppMOD_button=function()
    
32.         print(AppMOD.help)
    
33.         SetCommandSelection (1, -1)
    
34.         PasteCommand("#AppMOD ")
    
35. end
    
36. 
    
37. AppMOD_alias=function(name, line, wildcards)
    
38.         do_AppMOD(wildcards,AppMOD_ok,AppMOD_fail)
    
39. end
    
40. 
    
41. do_AppMOD=function(wildcards,AppMOD_ok,AppMOD_fail)
    
42.         local tmp_AppMOD=AppMOD.new()
    
43.         tmp_AppMOD.finish=AppMOD_ok
    
44.         tmp_AppMOD.fail=AppMOD_fail
    
45.         tmp_AppMOD:start(wildcards)
    
46. 
    
47. end
    
48. 
    
49. function AppMOD:start(wildcards)
    
50.         wait.make(function()
    
51.         self:update()
    
52.         local f=function() self:check(wildcards) end
    
53.         getinfo(f)
    
54.         end)
    
55. end
    
56. 
    
57. function AppMOD:check(wildcards)
    
58.         local askjob=function() self:askcmd() end
    
59.         local endf=function()
    
60.                         do_walkgo(self.masterroomno,0.2,askjob,askjob)
    
61.         end
    
62. 
    
63.                 if me.hp["neili"]<=1.2*me.hp["neilimax"] then
    
64.                         do_dazuo(1.2,"curmaxneili",endf,endf)
    
65.                 else
    
66.                                 busytest(endf)
    
67.                 end
    
68. end
    
69. 
    
70. function AppMOD:askcmd()
    
71. end
    
72. 
    
73. function AppMOD:cooltime()
    
74. end
    
75. 
    
76. function AppMOD:main()
    
77. end
    
78. 
    
79. -----------------------------------------------
    
80. 
    
81. function AppMOD:dosomething1()
    
82. end
    
83. 
    
84. function AppMOD:dosomething2()
    
85. end
    
86. 
    
87. function AppMOD:dosomething3()
    
88. end
    
89. 
    
90. function AppMOD:dosomething4()
    
91. end
    
92. 
    
93. -----------------------------------------------
    
94. 
    
95. function AppMOD:update()
    
96. 
    
97.                 local  AppMOD_triggerlist={
    
98.                        {name="AppMOD_dosth1",regexp="Here is trigger1 RegularExpression",script=function()    self:dosomething1()  end,},
    
99.                        {name="AppMOD_dosth2",regexp="Here is trigger2 RegularExpression",script=function()    self:dosomething2()  end,},
    
100.                        {name="AppMOD_dosth3",regexp="Here is trigger3 RegularExpression",script=function()    self:dosomething3()  end,},
     
101.                        {name="AppMOD_dosth4",regexp="Here is trigger4 RegularExpression",script=function()    self:dosomething4()  end,},
     
102.                 }
     
103. 
     
104. ---Creat Trigger-->>
     
105.                 for k,v in pairs(AppMOD_triggerlist) do
     
106.                         addtri(v.name,v.regexp,"q_AppMOD",v.script)
     
107.                 end
     
108. 
     
109. ---End Creat Trigger--<<
     
110.         local noecho_trilist={
     
111.                         "noecho_tri1",
     
112.                         "noecho_tri2",
     
113.                         }
     
114.         local _noechotri=linktri(noecho_trilist)
     
115. 
     
116.         addtri("AppMOD_noecho",_noechotri,"q_AppMOD","")
     
117.         SetTriggerOption("AppMOD_noecho","omit_from_output",1)
     
118.         EnableTriggerGroup("q_AppMOD",1)
     
119. end
     
120. 
     
121. AddAlias("alias_AppMOD_button","#AppMOD_button","",alias_flag.Enabled + alias_flag.Replace ,"AppMOD_button")
     
122. AddAlias("alias_AppMOD","#AppMOD (.*)","",alias_flag.Enabled + alias_flag.Replace+ alias_flag.RegularExpression ,"AppMOD_alias")
     
123. 
     
124. SetAliasOption("alias_AppMOD","group","job_AppMOD")
     
125. SetAliasOption("alias_AppMOD_button","group","job_AppMOD")
     
126. 
     

复制代码

至此，通过本次的说明更新性，希望能给有用MUSH编写机器的玩家给以帮助。
最后，本作只是一个自学笔记，在各位机器达人面前弄斧献丑，不要见笑。
******************************************************************************************************
【一个脚本框架】近期更新记录：
20141214：针对框架文件加入map_p2palias.mod模块，此模块为城际互联算法模块，在xkx_frame.mod中默认加载，可自行屏蔽。实现框架脚本内直接应用城际互联（故不需加载插件，若加载插件则屏蔽此模块即可）的作用。

******************************************************************************************************

littleknife

【底层框架】各MOD文件所提供的常用函数简介：

-----************************************************************
system.mod文件中主要函数介绍：
-----************************************************************

1. 
   
2. 
   
3. -----************************************************************
   
4. ----函数名：busy模块。busytest(busyfinish,t,...)
   
5. ----此模块用来判定自身是否处于busy。
   
6. ----输入：函数名，间隔时间，参数表
   
7. ----输出：在不忙的情况下，执行busyfinish。
   
8. -----************************************************************
   
9. -----************************************************************
   
10. ----函数名：delay(t,delayfinish,...)，waitend(t,waitfun,...)，infoend(func,...)
    
11. ----delay和waitend均为等待几秒后执行目标函数。
    
12. ----infoend为信息结束函数，即等待信息都显示完毕后执行目标函数的意思。
    
13. -----************************************************************
    
14. 
    
15. -----************************************************************
    
16. ----函数名： Convert2Seconds(seconds)：时间转换函数。
    
17. ----输入：                seconds                  ----字符串格式。
    
18. ----输出：  hours, minutes, seconds         ----小时、分钟、秒。
    
19. ----说明：                此函数提供的是将秒计时转换为小时、分钟、秒的格式。
    
20. -----************************************************************
    
21. -----************************************************************
    
22. ----函数名： ltrim (r, s)， rtrim (r, s)：左截、右截取串函数。
    
23. ----输入：r：截取或去掉的字符串，s：源字符串。
    
24. ----输出：截取后字符串。
    
25. ----说明：无。
    
26. -----************************************************************
    
27. -----************************************************************
    
28. ----函数名：触发脚本书写函数：addtri，addtri_multiline，addtri_noecho
    
29. ----addtri(triname,trimatch,trigroup,triscript,triflag,trisequence)
    
30. ----输入：触发名字，触发内容，触发群名，脚本名或函数名，标示，顺序。
    
31. ----输出：建立触发。
    
32. ----说明：这里的新模块下的触发建立函数，主要是封装模块的核心。其triscript已经可以识别函数名的直接填写。这无疑使得模块封装更加方便。
    
33. -----************************************************************
    
34. -----************************************************************
    
35. ----函数名：Alias添加函数：addali（非正则模式），addali_reg（正则模式）。
    
36. ----addali=function(aliname,alimatch,aligroup,aliscript)
    
37. ----输入：Alias名，触发内容，触发群名，触发脚本。
    
38. ----输出：建立Alias。
    
39. ----说明：这里的addali也是通过脚本aliscipt的方式运行Alias。
    
40. -----************************************************************
    
41. -----************************************************************
    
42. ----函数名：删除触发，删除触发群，删除变量：
    
43. ----deltri(triname)，deltrigp(groupname)，delvar(varname)
    
44. ----输入：触发名或触发群名，变量名。
    
45. ----输出：删除对应单独的触发或对应的触发群；删除变量。
    
46. ----说明：无。
    
47. -----************************************************************
    
48. -----************************************************************
    
49. ----函数名：linktri函数：linktri2(triggerlist)
    
50. ----输入：触发名或触发群名，变量名。
    
51. ----输出：把triggerlist表里的触发字符串连接成一个触发。
    
52. ----说明：连接数字项表格个各个值成为trigger。
    
53. ----此函数默认占用w[1]="",w[2]=全部表达式，列表中的参数从w[3]开始。
    
54. ----括号开始的变量为w[2]=("..rtrim("|",_str)..")"，里面有()则为w[3]，第一个w[1]=""
    
55. -----************************************************************
    
56. -----************************************************************
    
57. ----函数名：ctonum(str)---中文数字转换函数。
    
58. ----输入：str="一百三十五"
    
59. ----输出：135
    
60. ----说明：无
    
61. -----************************************************************
    
62. -----************************************************************
    
63. ----两个表格的操作函数：针对数字项表格的操作函数。
    
64. ----并集函数： table_union(a,b)，交集函数：table_intersection (a,b)，
    
65. ----移除重复项函数：talbe_removeduplicate(t)，
    
66. ----相等判定函数：table_is_equal(list1,list2)，
    
67. ----查询索引函数：simTableIndex(str,list)
    
68. ----表格是否为空表判定函数： table_is_empty(t)
    
69. -----************************************************************
    
70. -----************************************************************
    
71. ----system.allstop()
    
72. ----说明：重新刷新脚本函数。全部停止重置机器。
    
73. -----************************************************************
    
74. -----************************************************************
    

复制代码

-----************************************************************
status.mod文件中主要函数介绍：
-----************************************************************

1. 
   
2. 
   
3. -----************************************************************
   
4. ----函数名：status_oncha(name, line, w,s)，status_onjifa(name, line, w)技能查询并存储函数。
   
5. ----说明：应用此函数可以把skills和jifa skills都存入到me.skills表和me.jifa表，以及MUSH变量表中。
   
6. -----************************************************************
   
7. -----************************************************************
   
8. ----函数模块名：me模块。
   
9. ----说明：主要是自身状态的基本参数。提供睡觉、吃饭、发呆检测模块供参考。
   
10. -----************************************************************
    
11. -----************************************************************
    
12. ----函数模块名：Convert_KM(value)
    
13. ----说明：把亿、万模式转换为数字。
    
14. -----************************************************************
    
15. -----************************************************************
    
16. ----函数模块名：skills模块
    
17. ----说明：抓取自身技能，提供me.skills表和me.jifa表。
    
18. -----************************************************************
    
19. -----************************************************************
    
20. ----函数名：me.Checkitem(Comparelist)
    
21. ----说明：获取自身物品列表。这是一个方法型函数。Comparelist为对比表。
    
22. -----************************************************************
    
23. -----************************************************************
    
24. ----函数名：me.idhere(Callback)
    
25. ----IDhere列表函数。
    
26. -----************************************************************
    
27. -----************************************************************
    
28. ----函数模块：npc模块：
    
29. ----抓取NPC名字，颜色，门派等信息的模块。
    
30. -----************************************************************
    

复制代码

-----************************************************************
walk.mod文件中主要函数介绍：
-----************************************************************

1. 
   
2. 主要行走模块：do_walkgo(pathstring,steptime,walk_ok,walk_fail)
   
3. steptime：每步间隔时间（秒）。
   
4. walk_ok：行走后执行动作函数；
   
5. walk_fail：行走失败后执行动作函数；
   

复制代码

-----************************************************************
rest.mod文件中主要函数介绍：（这部分模块由于系统及自身喜好不同，也许存在些BUG。有兴趣的自己查阅修正吧。）
-----************************************************************

1. 
   
2. 
   
3. 打坐吐纳模块：do_dazuo(goal,condition,dazuo_ok,dazuo_fail)，do_tuna(goal,condition,tuna_ok,tuna_fail)
   
4. 学习、练习模块：do_qxuexi(wildcards,qxuexi_ok,qxuexi_fail)，do_qlianxi(wildcards,qlianxi_ok,qlianxi_fail)
   
5. 读书模块：do_qreadbook(wildcards,qreadbook_ok,qreadbook_fail)
   
6. 状态检查模块： checkstatus(item,condition,goal)
   
7. 修炼模块：do_xiulian(xiulian_ok,xiulian_fail)
   
8. 
   

复制代码

littleknife

本实例以新版领悟模块为参考实例，推出参考代码。供广大MUSHer爱好者参考使用。。仅供学习。。使用请保留版权信息，谢谢。

1. 
   
2. ------------***********************************************
   
3. -- File name   : quest_lingwu.mod
   
4. -- Description : 领悟模块，2014版。涵盖命令行模式和脚本模式。需配合基础框架，绘图模块参考了子襄(isstillsun)的代码。
   
5. -- Version: 20140420
   
6. -- Author: littleknife(applehoo@126.com)
   
7. --问题：武器、食物需自己带在身上。
   
8. ------------***********************************************
   
9. 论坛代码不好显示，这里下载自行研究吧：
   

复制代码

zztuzki

侠客岛读石壁机器人就是这样的，学习之

redcoat

超教棒，支持一下

zgbl

木有违规，发吧

zgbl

胡小刀，这些模块都完成之后，把这个和其他的好用的mush工具，一起整理一下弄一个新的北侠专用mush打包放主页去，当然懒做的话给份名单，我来帮忙

littleknife

噢了。

labaz

来晚了，顶顶

lzkd

哈哈,果断精华