/ep-character-creator

A web-based character creator application for the Eclipse Phase role-playing game.

Primary LanguagePHPOtherNOASSERTION

Eclipse Phase Character Creator (EPCC)

A web-based character creator application for the Eclipse Phase role-playing game.

License

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.

You can read the full license description here.

Derivative Work

This is a derivative work of the original Eclipse Phase Character Creator by Oook Game.

You can download the original source code for EPCC V 1.0 (03.2014) from GitHub or Oook.

You may also view the README file that came with the original work here.

EPCC Configuration

There is a single configuration file for EPCC: src/php/config.ini. You will need to maintain a separate version of that file outside of this repository for your production environment.

The rest of the information (Eclipse Phase content) is stored in the database. There is a full SQL dump of the database in src/sql/FullDatabase.sql.

Development VM

I have configured a development virtual machine, using Vagrant and Puppet, that you can use to quickly get up and running. It is a standard LAMP stack running on Ubuntu 13.10, and comes with PDFlib Lite 7.

Prerequisites

Before initializing the VM, you will need to install:

Setup

You can use a terminal to setup the VM with a few commands:

cd ep-character-creator/
vagrant up

If you installed the vagrant-hostsupdate plugin, you will be prompted for a password at then end of the VM provisioning phase, so that Vagrant can update your /etc/hosts file.

FYI: setup typically takes about 30 minutes, a good portion of which is spent downloading and installing PDFlib.

VM Configuration

If you want to change usernames and passwords that are used to access the database, you can edit devbox/config/epcc.yaml before running vagrant up.

Warning: DO NOT use these passwords on your production system.

Testing

You can access the web server on the VM in your browser:

Code

The src/ directory is shared with the VM, so your code changes will show up automatically on the web server.

Logs

You can find web server logs (Apache and PHP) on the VM in /var/log/apache2/:

  • epcc_access.log
  • epcc_error.log