README

Modular Gaming 是一个开源的基于浏览器的持久游戏框架，基于 Kohana 3.3 构建，具有如 ORM 和 KOstache 等模块。

在 BSD 许可证 下发布，Modular Gaming 可以合法用于任何开源、商业或个人项目。

要求

• PHP 5.3.3+
• MySQL
• Composer (依赖管理器)

安装

步骤 1：下载

从 Github 下载 Modular Gaming 并安装 composer 依赖项。

    $ git clone https://github.com/modulargaming/modulargaming.git
    $ cd modulargaming

    $ curl -s https://getcomposer.org/installer | php
    $ php ./composer.phar install --dev

或者您也可以使用 composer create-project 下载项目和依赖项。

    $ composer create-project modulargaming/modulargaming modulargaming dev-master

如果您不能使用 Composer，您可以从 http://www.sourceforge.net/projects/modulargaming/files/ 下载 Modular Gaming 的打包版本。

步骤 2：文件权限

$ chmod 0777 application/{cache,logs}
$ chmod 0777 assets
$ chmod 0777 media

步骤 3：运行安装程序

打开 .htaccess 并进行以下更改

• 设置正确的 RewriteBase

启动安装程序，通过您的网络浏览器浏览到 Modular Gaming 安装。

• 安装完成后，删除 install.php 文件。

步骤 4：管理员

在 /user/register 上注册您的管理员账户。使用 minion 任务将您新创建的账户提升为管理员。

$ php minion User:Promote --username=admin

现在，您应该通过访问 /admin/ 的管理面板来验证您是否有管理员访问权限。

步骤 5：cron 任务

$ php ./minion Pet:Decrease
$ php ./minion Item:Restock

步骤 6：配置 modulargaming

打开 .htaccess 并进行以下更改

• 设置正确的环境，开发或生产。

打开 application/bootstrap.php 并进行以下更改

• 设置应用程序的默认目录（如果自动不工作）

• 设置默认的 cookie salt

• 设置应用程序的默认 时区

打开 application/config/auth.php 并进行以下更改

• 设置默认的 hash key

打开 application/config/email.php 并进行以下更改

• 设置默认的 from 地址

测试

我们使用BDD，使用2个不同的工具，phpspec和behat。

$ curl -s https://getcomposer.org/installer | php
$ ./composer.phar install --dev

文档

包含在所有模块化游戏发布版中的用户指南模块还允许您本地查看文档。您可以通过 /guide 在您的网站上访问它。

报告错误

如果您遇到了错误，请通过 报告您发现的错误 来帮助我们。只需登录或注册并提交一个新问题，尽可能多提供有关错误的信息，例如：

• 重现步骤
• 预期结果
• 实际结果

这将帮助我们尽快修复错误，如果您想自己修复，请随意在我们的GitHub上fork并提交一个pull request！

贡献

鼓励并欢迎贡献；然而，请查阅仓库中包含的LICENSE.md文件中的开发者证书来源。所有提交都必须使用-s开关进行签名。