1 Star 4 Fork 3

mudcore / mud

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

MUDCORE游戏开发示例

如果你是使用mudcore框架全新开发MUD游戏,可参考此示例模版。框架使用说明文档:https://bbs.mud.ren/threads/66

项目安装

点击项目上的 Use this template 生成项目到自己的仓库,然后使用以下指令clone代码:

# 下载代码
git clone --recurse-submodules <你的项目地址>

如果你已经克隆了项目但忘记了 --recurse-submodules,那么可以在项目根目录中运行以下指令更新子模块:

# 更新子模块
git submodule update --init --recursive

如果需要保持框架为最新版,请在项目根目录中运行以下指令:

# 更新框架
git submodule update --remote

启动游戏

Ubuntu系统下直接运行以下指令或使用run.sh脚本启动游戏

driver config.cfg

项目配置文件:

  • config.cfg - 精简版运行时配置文件

如需完整版运行时配置文件请参考mudcore框架目录中的config.example.ini,另外config.mini.ini也值得参考。

如果你还没有编译驱动,可以先运行build.sh自动下载编译。

目录说明

目录 说明
.vscode Visual Studio Code 配置目录,方便开发调试
data 游戏存档目录,包括游戏配置文件示例.env.example
include 游戏代码头文件目录
log 游戏日志目录
mudcore MUDCORE框架子模块目录,请勿修改其中代码
system 游戏系统文件目录
www websocket HTTP网页子模块目录,包括2个版本可切换

其中 mudcore 目录为引入的框架子模块,不要改动其中的任何代码,使用帮助见mudcore/README.md,其它游戏目录为开发者自己定义的,可根据需要自由调整。

项目其它目录结构建议配置:

目录 说明
config 游戏各种特色设置配置文件目录,注意不得保存敏感数据
cmds 游戏动作指令目录
daemons 游戏守护进程目录,推荐放在system目录下
docs 游戏文档文件目录
inherit 必须继承使用的功能模块文件目录
obj 实体对象目录,继承标准对象使用
std 标准对象目录,具体对象继承使用
verbs 游戏谓词指令目录
world 游戏世界环境目录

关于环境配置

因为推荐使用git管理代码,有一些核心配置(如数据库密码)为了安全不建议直接写在代码中,MUDCORE 推荐的做法是在/data/目录中新建一个.env文件,重要配置在这里定义,在游戏中使用env()函数读取或写入。此文件不会提交到仓库中,具体可参考.env.example文件。

MIT License Copyright (c) 2022 mud.ren Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

mudcore框架模板,可直接用来开发新MUD游戏。 展开 收起
Shell 等 2 种语言
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/mudcore/mud.git
git@gitee.com:mudcore/mud.git
mudcore
mud
mud
main

搜索帮助