2. 安装启动

这篇文章将教你如何从头开始下载、安装、启动 Muddery。

2.1. 快速安装

以下是安装、运行 Muddery 的主要步骤：

  1. 下载并安装 Python3.9 和 GIT，打开终端

  2. cd 进入你的开发目录

  3. git clone https://github.com/muddery/muddery

国内连接 github 较慢可以从 gitee 同步代码：
git clone https://gitee.com/muddery/muddery

  1. python -m venv env （如果机器上同时存在 Python2 和 Python3，请使用 python3 安装虚拟环境）

  2. source env/bin/activate （Linux, Mac） 或 env\Scripts\activate （Windows）

  3. pip install -e muddery

  4. muddery init mygame

  5. cd mygame

  6. muddery setup

  7. muddery start

Muddery 现在应该正常运行了，你可以通过网页浏览器打开游戏主页： http://localhost:8000

在网页浏览器中还可以打开游戏编辑器： http://localhost:8002

详细的安装步骤参见下文。如果你在安装过程中遇到了问题，可以加入 QQ 群 230774532 寻求帮助 （点击 GroupLink 加群）


2.2. 详细步骤

2.2.1. 一、所需软件

2.2.1.1. 操作系统

不论什么操作系统，只要能支持 Python 就行。

  • Linux/Unix

  • Windows (Win7, Win8, Win10, Win11等)

  • Mac OSX (建议>=10.5)

2.2.1.2. 软件工具


2.2.2. 二、安装系统

2.2.2.1. Windows 环境

Windows 用户首先需要知道 Muddery 服务器是在命令行中运行的。在 Windows 开始菜单中找到 所有程序 > 附件 > 命令提示符 （Win7）或 所有应用 > Windows系统 > 命令提示符 （Win10）并运行，你就可以见到 Windows 的命令行界面了。

从Python 官网 https://www.python.org/downloads/windows/ 下载最新的 Python 安装包（高于 3.8.10版）。你需要 Windows 的管理员权限来安装它。安装时要注意勾选所有的安装选项，特别是把 Python 添加到 path 中的那一项（这可以让你在任何终端窗口中使用 Python，而不需要找到 Python 程序在你硬盘上的实际安装位置）。

你还需要下载并安装 GIT。你可以使用默认的安装选项，但当你被问及 “Adjust your PATH environment” 时，你需要选择第二个选项 “Use Git from the Windows Command Prompt”，这样使用程序的地点可以更加灵活。

如果之后你在安装 Muddery 时还有问题，你可能需要安装 pypiwin32 （ https://pypi.python.org/pypi/pypiwin32 ），没遇到问题就不要装了。

相关软件都安装完毕后，打开命令行程序，cd 进入你想要放置 Python 开发环境的文件夹。

然后下载 muddery 的代码：

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

国内连接 github 较慢可以从 gitee 同步代码：

git clone https://gitee.com/muddery/muddery.git

这会创建一个名为 muddery 的文件夹，Muddery 的源码都在这个文件夹中。

接下来安装虚拟环境，先执行 python --version 查看 Python 的版本，如果显示的不是 Python3.8.10 或以上版本，请使用其他的 python 解释器，如 python3 或 python3.8。使用 3.8 版本的 Python 解释器安装虚拟环境：

python -m venv env
或
python3 -m venv env
或
python3.8 -m venv env

安装完成后会在当前目录中生成一个新的目录 env。激活虚拟环境：

env\Scripts\activate

如果命令提示符变成 （env） ,说明虚拟环境已经激活了（之后如果需要的话，你还可以使用 deactivate 命令来关闭它）。只有激活了虚拟环境，我们才能正常使用 Muddery，每次打开新的命令行程序都需要激活一下。

现在我们可以安装 Muddery 了：

pip install -e muddery

-e 表示通以链接的方式安装 Muddery，这样你每次通过 GIT 更新 Muddery 的代码，软件包也会立即更新。

Muddery 以及它所依赖的软件现在都安装好了。


2.2.2.2. Linux 环境

首先安装 Python3。

以 Ubuntu 20.04 为例：

sudo apt-get update
sudo apt-get install python3.8 python3.8-dev python3-setuptools python3.8-venv gcc

然后创建一个文件夹用来做开发：

mkdir muddev
cd muddev

下载 muddery 的代码：

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

国内连接 github 较慢可以从 gitee 同步代码：

git clone https://gitee.com/muddery/muddery.git

这会创建一个名为 muddery 的文件夹，Muddery 的源码都在这个文件夹中。

接下来安装虚拟环境，先执行 python –version 查看 Python 的版本，如果显示的不是 Python3.8 版本，请使用其他的 python 解释器，如 python3 或 python3.8。使用 3.8 版本的 Python 解释器安装虚拟环境：

python -m venv env
或
python3 -m venv env
或
python3.8 -m venv env

安装完成后会在当前目录中生成一个新的目录 env。激活虚拟环境：

source env/bin/activate

env 的字样会出现在命令提示符边上，表示虚拟环境已经激活了（我们可以使用 deactivate 命令来关闭它）。只有激活了虚拟环境才能正常使用 Muddery。

现在可以安装 Muddery 了：

pip install -e muddery

-e 表示通以链接的方式安装 Muddery，这样你每次通过 GIT 更新 Muddery 的代码，软件包也会立即更新。

Muddery 以及它所依赖的软件现在都安装好了。

如果在安装中遇到报错说某些软件包太老了，或缺少某些软件包，可以用 python -m pip install --upgrade pip 更新你的环境。然后再执行 pip install -e muddery 。


2.2.2.3. MacOSX 环境

MacOSX 已经预装了 Python，但版本可能过低。Muddery 至少需要 Python 3.8.10 版，可以到Python 官网 https://www.python.org/downloads/mac-osx/ 下载最新的 Python 安装包（高于 3.8.10版）。

安装好 Python3.8.10 和 GIT 之后，可按上文 Linux 的方式继续获取 Muddery 源码、安装虚拟环境、安装 Muddery。


2.2.3. 三、设置游戏

现在你已经安装好 Muddery 了，只要激活了 Muddery 的虚拟环境，你就可以使用 muddery 命令。现在创建你的游戏的文件夹，你可以将游戏命令为任何你喜欢的名字，在这里我们把它起名为“mygame”。

muddery init mygame

一个新的 mygame 文件夹会创建出来，你还会看到一些信息文字。mygame 文件夹是一个游戏框架，你可以在这里创建所有与游戏相关东西。

你的服务器的配置文件为 mygame/server/settings.py 。如果你想要自定义Muddery的基本设置，你可以现在就修改。如果你不确定该怎么做，你不用修改任何东西，Muddery 会使用最佳的默认设置。

如果你要安装中文环境，请执行以下命令创建游戏文件夹：

muddery init mygame example_cn

这会安装一个很简单的中文游戏示例。命令中的 example_cn 是游戏示例模板的名字，本网站的演示游戏 http://muddery.org/games/example_cn/index.html” 就是使用这个模板创建的。


2.2.4. 四、启动和停止服务器

要启动服务器，你需要进入 mygame 目录。

cd mygame

然后执行：

muddery setup

系统会自动配置数据库和游戏内容，还会让你设置游戏编辑器的用户名和密码。

然后执行：

muddery start

游戏服务器将会启动，之后就开始正常运行了。

要停止Muddery运行，请输入：

muddery stop

启动游戏服务器时，会启动3个独立的服务：游戏后台、游戏网页客户端和游戏编辑器，每个服务都可以单独启动和终止。要单独启停这些服务，可以在游戏根目录中执行以下命令：

muddery start -s 或 muddery start --server 启动游戏后台
muddery start -c 或 muddery start --client 启动游戏网页客户端
muddery start -e 或 muddery start --editor 启动游戏编辑器

muddery stop -s 或 muddery stop --server 关闭游戏后台
muddery stop -c 或 muddery stop --client 关闭游戏网页客户端
muddery stop -e 或 muddery stop --editor 关闭游戏编辑器

2.2.5. 五、连接到服务器

Muddery 服务器现在运行起来了。如果没有改过默认配置，Muddery 会在端口 8000 上启动一个 web 服务器。在浏览器上打开页面 http://localhost:8000 ，你就可以连接到游戏的网页客户端进行游戏。

在浏览器上打开页面 http://localhost:8002 ，可以连接到游戏的编辑器，你可以自己编辑、修改游戏的内容。编辑器的用户名和密码就是在执行 muddery setup 时设置的用户名和密码。