GameCreate /

Filename Size Date modified Message
gamecreate
man
service
35 B
2.4 KB
44 B
1023 B
2.1 KB
5.7 KB
59 B
1.8 KB
171 B
2.1 KB
##########
GameCreate
##########

.. contents::

About
=====

GameCreate is a powerful game server management software solution
(or "game panel"), that allows game service administrators to manage all of
their services from a single web interface.

Features
========

* Control game servers from a single web interface
* Simple server configuration with built-in support for dozens of titles
* Built-in FTP server makes it easy for users to upload maps or modifications
* 24x7 monitoring keeps servers running around the clock
* Extensive statistics in graph and table form
* Unique 'temporary servers' feature lets your users have their own server for a few hours

Requirements
============

A GNU/Linux system or compatible is needed.

There is nothing to compile, so no compilers are needed.

    Conforming to: Red Hat
        (you may need to tweak the build package for your system.
        Please submit any useful tweaks to the authors. Thanks.)

gamecreate:runtime
    Requires:
      abi: ELF32(SysV x86)
      soname: ELF32/libc.so.6(GLIBC_2.0 GLIBC_2.1 GLIBC_2.1.3 GLIBC_2.2.3 GLIBC_2.2.4 SysV x86)
      soname: ELF32/libdl.so.2(GLIBC_2.0 GLIBC_2.1 SysV x86)

Installation
============

Installing is done by the following three commands::

    $ ./configure
    $ make
    # make install (as root)

Run ``./configure``, with some options is recommended. The standard options
are documented in the INSTALL file. The most interesting ones are
the usual ``--prefix=/usr``, ``--localstatedir=/var``, ``--sysconfdir=/etc``
and an extra ``--servicedir=/srv``.

Use the ``./preconfigure`` script to quickstart the build using these settings.

For more configuration details run::

    $ ./configure --help

If there are any errors during configuration, check your build environment
and try to find the error, otherwise file a bug-report on the issue tracker
or contact one of the authors.

These files will be installed.

    * ${servicedir}/games/gamecreate
    * ${servicedir}/games/gamecreate.ini -> ${sysconfdir}/gamecreate.conf (symlink)
    * ${servicedir}/games/.screenrc
    * ${sysconfdir}/gamecreate.conf
    * ${sysconfdir}/cron.daily/gamecreate
    * ${sysconfdir}/logrotate.d/gamecreate
    * ${sysconfdir}/init.d/gamecreate
    * ${localstatedir}/log/gamecreate.log
    * ${mandir}/man6/gamecreate.6

File Permissions
****************

Packagers should be aware of some suggested file permissions. GameCreate
needs a service directory to write into (configurable from the GameCreate
web app). This package recommends the /srv/games directory, which will
also contains user configuration files with plain text passwords. The
*gamecreate* user and *games* group are used to restrict privliges. See
also: the init-script, (./src/gamecreate.init.in), which uses the
*gamecreate* runuser to drop privileges at startup. The configfile and
the log file store a plain text password for the gamecreate domain login,
so make sure to limit access to these two files as well.

Assumes the system has a *games* user/group (UID=12, GID=20).

The following modes are used from source installs, (ownership requires root)::

    -rw-rw----    1 root        gamecreate     /etc/gamecreate.conf
    -rw-r--r--    1 root        root           /etc/cron.daily/gamecreate
    -rw-r--r--    1 root        root           /etc/logrotate.d/gamecreate
    -rw-r--r--    1 root        root           /usr/share/man/man6/gamecreate.6.gz
    -rwxr-xr-x    1 root        root           /etc/init.d/gamecreate
    drwxrws---    1 root        games          /srv/games
    -rwxr-xr--    1 gamecreate  gamecreate     /srv/games/gamecreate
    lrwxrwxrwx    1 root        root           /srv/games/gamecreate.ini -> ../../../etc/gamecreate.conf
    -rwxr-xr-x    1 root        root           /srv/games/multiserv.so
    -rw-rw----    1 root        gamecreate     /var/log/gamecreate.log

Multi-user Screen Mode
**********************

A stub .screenrc file is privided (see ./service/games.screenrc) and
installed. Runuser *gamecreate* screen processes will source the .screenrc
config to allow superusers to attach to multi-user screen sessions and
interact with individual server back-ends. Requires screen setuid *root*.

This file must be installed to the *gamecreate* user $HOME directory (i.e., /srv/games)::

    * ${servicedir}/games/.screenrc

Usage
=====

To run ``gamecreate`` just type on a console::

    # service gamecreate start (preferred)
or  # /srv/games/gamecreate [options]

There are a few command line options. See the manual page or run for details::

    # gamecreate

Or look into the documention in the doc/ directory.

The first run of ``gamecreate`` must be done manually from the shell to
initialize the configuration file.

Windows
=======

GameCreate also runs under Windows. To download the binary
with all necessary files, visit GameCreate's homepage:

    http://www.gamecreate.com

License
=======

This software is distributed under the terms of the MIT License. A copy
of the license can be found in the file COPYING included with the source code of
the program. If not, see <http://www.rpath.com/permanent/mit-license.html>.

The GameCreate application (found in the subdirectory gamecreate/) has its own
license, which can be found in the file LICENSE included with the program.

Ideas, questions, patches and bug reports
=========================================

Home page:
    http://bitbucket.org/superstition/gamecreate/wiki/

Primary distribution point:
    http://bitbucket.org/superstition/gamecreate/downloads/

Ideas, questions, patches and bug reports:
    http://bitbucket.org/superstition/gamecreate/issues/

If you add something, or fix a bug, please send a patch (in 'diff -u'
format) to the issue tracker or one of the authors listed below.

------------ -----   -----       ----       ---       --         -
Erik Southworth, 2010 (s6v)

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.