泥芯(MudCore) - LPMUD 游戏开发框架

LPMUD游戏开发框架核心代码，仅仅包括核心代码，可以在此基础上开发任何MUD，本框架需配合 FluffOS utf-8版使用。

当前版本：v1.6.*

这个项目的诞生源于我的LPC零基础开发教程，在写教程的过程中，发现很多同学并不关心底层细节，只想能直接开发游戏项目，国内绝大多数MUD游戏都是《东方故事2》底层，在已有MUD基础上修改的优点是可以快速上手，但这个算不上独立的游戏框架。能不能把底层独立出来，开发任何类型的MUD都可以使用？在思考后，我开始了这个项目，特色是只提供底层代码和接口，几乎不提供任何游戏性的内容，独立于游戏项目之外，只需简单配置即可实现MUD游戏开发。

本项目不考虑旧版驱动的兼容性，只支持 FluffOS v2019 以后的版本。

• 框架下载地址：https://github.com/mudcore/mudcore
• 国内镜像地址：https://gitee.com/mudcore/mudcore
• 框架示例项目：https://github.com/mudcore/mymud
• 框架基础模板：https://github.com/mudcore/mud (可用模板直接开发新MUD)
• 框架使用教程：https://bbs.mud.ren/threads/66
• 框架集成示例：https://bbs.mud.ren/threads/99

致谢：本框架开发代码、结构、功能和思路上大量的参考借鉴了ES2系列游戏、重生的世界MUD、火影忍者MUD、DeadSouls等，感谢这些优秀MUD。

框架特色

框架提供大量常用模拟外部函数和最基本的游戏底层（包括指令系统、聊天频道、表情系统和档案存取功能），可以用来快速开发MUD游戏，框架部分独立维护，更新升级不影响个人项目。个人项目目录结构和功能灵活自主，框架提供的功能可灵活选择使用，只需要继承对应模块即可。

框架使用说明

安装

如果你是新项目使用mudcore框架，请直接使用mudcore项目模板安装：

git clone --recurse-submodules https://github.com/mudcore/mud.git

如果是已有MUD集成框架，请把本框架放在你的MUD项目中（保持默认目录名称 mudcore），推荐安装方式：

1. 如果你的游戏使用git管理，请添加框架为子模块：

git submodule add https://github.com/mudcore/mudcore.git

2. 如果你的游戏没有使用git管理，请在游戏目录直接安装框架：

git clone https://github.com/mudcore/mudcore.git

配置

如果你使用mudcore项目模板安装，不需要做任何配置可直接运行，否则请按以下配置集成框架到你的MUD游戏中：

1. 运行时配置文件<config.ini>中定义包含mudcore框架文件目录：

include directories : /include:/mudcore/include

2. 全局包含头文件<globals.h>中做如下配置：

// 定义日志目录
#define LOG_DIR "/log/"

// 定义存档目录
#define DATA_DIR "/data/"

// 引用框架头文件(放在最后)
#include <mudcore.h>

对新MUD开发，如果不想使用框架提供的登录注册功能，请在 <globals.h> 中定义连线对象LOGIN_OB 和 USER_OB 指向自己实现功能的文件。

如果需要预加载，请定义 PRELOAD 并指定文件位置，在对应文件内列出预加载对象文件，如果需要加载目录下所有文件，直接在文件中列表目录即可，如：

# 自动载入指定目录中的守护进程（不包括子目录）
/system/daemons/
# 自动更新系统头文件
/mudcore/system/daemons/header_d.c

如果使用系统自带注册登录系统，但想使用个人的欢迎界面，请定义 MOTD 并指定位置，如果需要更多的玩家信息初始化，可以定义 CHAR_D 并从 setup() 方法中初始化。

如果要使用框架提供的指令系统，请在<globals.h>中做如下示例定义：

// 管理员
#define WIZARD "mudren"

// 管理员指令路径
#define CMD_PATH_WIZ ({"/cmds/wiz/", "/mudcore/cmds/wizard/"})

// 玩家指令路径
#define CMD_PATH_STD ({"/cmds/std/", "/mudcore/cmds/player/"})

指令需要实现以下方法：

int main(object me, string arg)
{
    // todo 指令功能

    return 1;
}

int help(object me)
{
    // todo 指令使用说明

    return 1;
}

3. 主控对象文件继承框架对象（可选）：

inherit CORE_MASTER_OB;

4. 模拟外部函数文件继承框架对象（可选）：

inherit CORE_SIMUL_EFUN_OB;

提示：请务必不要直接修改 mudcore 的任何代码，如果需要增加功能，请通过继承和覆盖的方式实现。

使用泥芯框架从零开始开发新游戏详细示例教程：https://bbs.mud.ren/threads/66

框架目录结构

system系统目录

核心对象

所有核心对象有去掉CORE_前缀的同名宏定义，方便覆盖和继承，如LOGIN_OB。

系统头文件(Include Headers)

头文件在 /include/ 目录中，主要是常量宏定义和函数声明，框架基本提供如下头文件：

继承特征模块(Inherit Objects)

继承文件在 /inherit/ 目录，实现了核心的功能片段，方便直接使用，具体参考 /docs/inherit/ 目录。基本提供如下继承文件：

所有特征模块有去掉CORE前缀的同名宏定义，方便覆盖和继承，如_CLEAN_UP。

守护进程(Daemons)

守护进程是独立出来的系统服务，每个进程有自己的API可以调用，具体参考 /docs/dameons/ 目录。

所有守护进程有去掉CORE_前缀的同名宏定义，方便覆盖和继承，如LOGIN_D。

另外，在MUDCORE的/system/daemons/http/下面提供了http服务示例：

• iqa_d.c : 智能答问守护进程
• qq_d.c : QQ群聊天互通守护进程
• sms_d.c : 手机验证码短信守护进程

系统函数(Simul-Efuns)

除驱动自带的 efun 外，框架提供了部分模拟外部函数，具体使用参考 /docs/simul_efun/ 目录，或查看函数源码（/system/kernel/simul_efun/）。

默认指令

泥芯框架提供了部分基础指令辅助使用，具体指令参考/mudcore/cmds/目录和/mudcore/verbs/目录。