A modular persistent browser based game framework using Kohana 3.3 with ORM and KOstache.
Kohana is an elegant, open source, and object oriented HMVC framework built using PHP5, by a team of volunteers. It aims to be swift, secure, and small.
ORM is a a powerful Object Relational Mapping (ORM) module that uses the active record pattern and database introspection to determine a model's column information.
Mustache is a template specification we use for our templates, we use Kostache's implementation.
Released under a BSD license, Modular Gaming can be used legally for any open source, commercial, or personal project.
- PHP 5.3.3+
- MySQL
Download Modular Gaming from Github.
$ git clone git@github.com:hinton/mg.git --recursive
Edit application/config/database.php with the correct information.
$ php minion migrations:run
Open application/bootstrap.php and make the following changes:
-
Set the default directory for your application if it does not automatically work
-
Set the default cookie salt
-
Set the default timezone for your application
Open application/config/auth.php and make the following changes:
- Set the default hash key
Open .htaccess and make the following changes:
-
Set the correct RewriteBase
-
Set the correct environment, either development or production.
Open application/config/email.php and make the following changes:
- Set the default from address
$ chmod 0777 application/{cache,logs}
$ chmod -R 0777 assets
$ php ./minion Pet
$ php ./minion Restock
Insert into the database your user id (1) and admin role (2) into roles_users now you can access /admin
We use BDD, with 2 different tools, phpspec and behat.
We use composer to install them, http://getcomposer.org/ or you could install them manually using pear.
$ curl -s https://getcomposer.org/installer | php
$ ./composer.phar install --dev
The userguide module included in all Modular Gaming releases also allows you to view the documentation locally. It is accessible from your site via /guide
If you've stumbled across a bug, please help us out by reporting the bug you have found. Simply log in or register and submit a new issue, leaving as much information about the bug as possible, e.g.
- Steps to reproduce
- Expected result
- Actual result
This will help us to fix the bug as quickly as possible, and if you'd like to fix it yourself feel free to fork us on GitHub and submit a pull request!
Contributions are encouraged and welcome; however, please review the Developer Certificate of Origin in the LICENSE.md file included in the repository. All commits must be signed off using the -s switch.