(Quick Reference)

2 Installation - Reference Documentation

Authors:

Version: 0.3.2

2 Installation

2.1 Installing the binary package

Please install / configure the following software packages to get started with the Little Goblin binary package:

Download the binary package

Download the binary package Little Goblin Binary

Java

Download and install the Java 7 runtime from http://java.com/

On Ubuntu: sudo apt-get install openjdk-7-jre

Tomcat 7

Download and install Tomcat 7 from http://tomcat.apache.org

On Ubuntu, use: sudo apt-get install tomcat7

Install an RDBMS (Database)

Download a database and configure it, either: MySQL or Postgresql (the latter is recommended).

Create a database user "goblin" with password "goblin" (for testing)

If you want to use mysql, please download the database driver and place it into your Tomcat's lib folder. (It is not included in the goblin.war for license reasons.)

Configure your version

Create in you home directory a folder .grails and inside a file goblin-config.groovy. You can download an example version from GitHub

  • Set the serverUrl to your machine's or server's name (http://localhost or your domain name)
  • Edit the database settings for the production database.

If you want to create a new database on every server start and delete the old data, keep the setting of dbCreate="create". Otherwise, set it to dbCreate="none".

If you have any questions, you can:

2.2 Installing the source code

Checkout the source code

You can get the source code from the Little Goblin GitHub repository

It is available as a zip or tar archive or (recommended) as a git repository which you can clone via bq. git clone git://github.com/dewarim/LittleGoblin.git

Prerequisites to running from source

After you have installed the dependencies, use the command line to run Grails in Little Goblin's main directory: grails and start the application with run-app

Use as a plugin

Add the following line to your Grails application's BuildConfig.groovy (in the plugins section):

compile ':little-goblin:0.3.2'

As a starting point, look at the BootStrap.groovy code in the plugin's source on how to populate the database with essential objects like an admin user. You can login to your application via http://localhost:8080/$appName/portal/landing, where $appName stands for your Grails application's name. Then it's time to begin customizing the game engine and to add your own content. (Extensive documentation on how to do this will follow - if anything is unclear or does not work, please to not hesitate to ask or add an issue )