Catalyst based RPG framework
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSES Updated license details Apr 1, 2017
data Linked about page into the menu Oct 20, 2018
ddl Password recovery process complete Oct 21, 2018
design_notes Follow-up to PR3 to convert files to unix format Dec 29, 2016
docs Suggested workflow for git/github Dec 28, 2016
lib Removed the hardcoded transport. Log errors sending emails Oct 29, 2018
misc Authentication and session basics done Jul 4, 2016
root We have a basic map from the database Oct 25, 2018
script Two more non-breaking spaces found Apr 1, 2017
t Renamed account test file to .t Dec 28, 2016
templates A working map finally, complete with movement Oct 29, 2018
.gitignore Updated DSN to use SQLite instead of MySQL as standard Dec 31, 2016
CONTRIBUTING.md Fixed the Discord invite code Aug 17, 2018
Changes Added catalyst project skeleton Jul 2, 2016
LICENSING Updated license details Apr 1, 2017
Makefile.PL Types::Standard comes recommended by mst on #moose Oct 29, 2018
README.md Mistake in server script name Oct 27, 2017
app.psgi Set STDOUT and STDERR to autoflush for use with Flynn Mar 16, 2017
backup_files.sh Assorted scripts for development and installation Jul 24, 2018
build_schema_version.sh Assorted scripts for development and installation Jul 24, 2018
catalyst-rpgcat.service Assorted scripts for development and installation Jul 24, 2018
environment.conf Assorted scripts for development and installation Jul 24, 2018
fastcgi.initd Assorted scripts for development and installation Jul 24, 2018
rpgcat.yaml EMKit fixes to handle alternative transports Oct 29, 2018
set-env.sh Assorted scripts for development and installation Jul 24, 2018
start-rpgcat.sh Assorted scripts for development and installation Jul 24, 2018

README.md

rpgcat

Catalyst based RPG framework

About

The aim of this application is to serve as a fairly functional base to design your own Browser based RPG. It probably won't be fancy but we hope there is enough to get a basic game up and running quite fast. The actual content (the map for example) is left for you to provide!

Installation

This works best if you install a local version of Perl and all associated modules. This can be done as follows:

curl -L https://install.perlbrew.pl | bash
source ~/perl5/perlbrew/etc/bashrc
perlbrew install perl-5.20.1
perlbrew switch perl-5.20.1
perlbrew install-cpanm
cpanm Catalyst::Devel

This next command should output 1.39 (or something more recent)

perl -MCatalyst::Devel -e 'print "$Catalyst::Devel::VERSION\n";'

In github, fork the main rpgwnn/rpgcat repository into your personal repository and clone your repository and install any extra Perl dependencies.

cd ~
git clone git@github.com:YOURUSER/rpgcat.git
cd ~/rpgcat
cpanm --installdeps .

To keep your version in sync with the main repository, configure the upstream repository

git remote add upstream https://github.com/rpgwnn/rpgcat.git

and merge in changes from upstream/master. Full instructions can be found at https://help.github.com/articles/syncing-a-fork/

git fetch upstream
git merge upstream/master

Running

To run the application for development purposes, use the following command:

script/rpgcat_server.pl -r -d --fork

If you don't use --fork, it'll only run a single thread which will cause simultaneous requests to hang until the previous request has finished.

-r causes the server to monitor Perl modules and automatically reload if there are any changes detected.

-d enables debug output which includes timings, headers, etc.

Hopefully your final application will work on PaaS such as Heroku and Flynn without too many changes required.

Licensing

This program is free software; you can redistribute it and/or modify it under the terms of either:

a) the GNU General Public License as published by the Free
Software Foundation; either version 1, or (at your option) any
later version, or

b) the "Artistic License" version 2 which comes with this program.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either the GNU General Public License or the Artistic License for more details.

You should have received a copy of the Artistic License with this program in the file named "LICENSES/Artistic-2_0". If not, please visit http://www.perlfoundation.org/artistic_license_2_0

You should also have received a copy of the GNU General Public License along with this program in the file named "LICENSES/Copying". If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA or visit their web page on the internet at http://www.gnu.org/copyleft/gpl.html