View on GitHub

Freeciv-web

Freeciv-web is an Open Source strategy game implemented in HTML5, which can be played online against other players, or in single player mode against AI opponents.
download .ZIPdownload .TGZ

THE FREECIV-WEB PROJECT

Build Status

Freeciv-web is an open-source turn-based strategy game. It can be played in any HTML5 capable web-browser and features in-depth game-play and a wide variety of game modes and options. Your goal is to build cities, collect resources, organize your government, and build an army, with the ultimate goal of creating the best civilization. You can play online against other players (multiplayer) or play by yourself against the computer.

Freeciv-web is is free and open source software. The Freeciv C server is released under the GNU General Public License, while the Freeciv-web client is released under the GNU Affero General Public License. See License for the full license document.

Freeciv-web is now playable online at http://play.freeciv.org/

Contact: The Freeciv Project - freeciv-dev@gna.org
https://mail.gna.org/listinfo/freeciv-dev

Freeciv-web

Overview

Freeciv-Web consists of these components:

Running Freeciv-web with Vagrant on VirtualBox

Freeciv-web can be setup using Vagrant on VirtualBox to quickly create a local developer image running Freeciv-web on Ubuntu 14.04 on your host operating system such as Windows, OSX or Linux. This is the recommended way to build Freeciv-web on your computer.

  1. Install VirtualBox: https://www.virtualbox.org/ - Install manually on Windows, and with the following command on Linux: bash sudo apt-get install virtualbox

  2. Install Vagrant: http://www.vagrantup.com/ - Install manually on Windows , and with the following command on Linux: bash sudo apt-get install vagrant

  3. Install Git: http://git-scm.com/ then check out Freeciv-web from git to a directory on your computer, by running this git command: bash git clone https://github.com/freeciv/freeciv-web.git --depth=10

  4. Run Vagrant with the following commands in your Freeciv-web directory from step 3: bash vagrant plugin install vagrant-vbguest vagrant up

This will build, compile, install and run Freeciv-web on the virtual server image. Wait for the installation process to complete, watching for any error messages in the logs.

  1. (Skip this step if you run Windows) For Linux or OS X, then you need to setup a SSH tunnel to port 80 like this: bash sudo ssh -p 2222 -gNfL 80:localhost:80 vagrant@localhost -i ~/.vagrant.d/insecure_private_key

Then test Freeciv-web by pointing your browser to http://localhost/ on your host operating system.

To log in to your Vagrant server, run the command: bash vagrant ssh

The Vagrant guest machine will mount the Freeciv-web source repository in the /vagrant directory. Note that running Freeciv-web using Vagrant requires about 4Gb of memory and 3 Gb of harddisk space.

Running Freeciv-web with Docker

Freeciv-web can be built automatically using Docker https://www.docker.com/ Note that building Freeciv-web with Docker is still in beta and testing. This was tested using Docker 1.8.2 with Ubuntu 14.04 as the base image. Also see the Dockerfile for more information.

  1. Install Docker, then get the Freeciv-web source code like this: bash git clone https://github.com/freeciv/freeciv-web.git --depth=10

  2. Build the Freeciv-web docker container by giving the following command: bash docker build -t="freeciv-web" .
  3. Then run the Freeciv-web docker container with this command:

bash docker run -d -p 80:80 --expose=80 -t freeciv-web /bin/sh -c "/docker/scripts/docker-run.sh && sleep infinity"

Note: For users running Freeciv-web on Docker on Windows/msys-git, if the the command in step 3 above fails with an error message, try replacing the slash character with double-slashes like this: bash docker run -d -p 80:80 --expose=80 -t freeciv-web //bin//sh -c "//docker//scripts//docker-run.sh && sleep infinity"

System Requirements for manual install

Install this software if you are not running Freeciv-web with Vagrant:

Compiling and running the Freeciv Web client (old method)

When not using Vagrant, or with other Linux distributions, follow this manual installation procedure to setup Freeciv-web:

  1. Checkout Freeciv-web from github to ~/freeciv-build

  2. Install the system requirements from the previous chapter.

  3. Create mysql database called ‘freeciv_web’ Import mysql tables into a MySQL database from: freeciv-web/src/main/webapp/meta/private/metaserver.sql

  4. Get, prepare, and build freeciv server: > cd freeciv > ./prepare_freeciv.sh

  5. Install Freeciv. This involves running the following commands: > cd freeciv/freeciv
    > make install (as root user)

  6. Build and configure freeciv-web.

    • Run setup_links.sh and sync.sh in the scripts/freeciv-img-extract directory.
    • Run sync-js-hand.sh in the scripts/ directory.
    • Copy freeciv-web/src/main/webapp/WEB-INF/resin-web.xml.dist as resin-web.xml and update the values for your MySQL database.
    • Copy freeciv-web/src/main/webapp/meta/php_code/local.php.dist as local.php and edit to suit your needs.
    • Run ‘setup.sh’ in the freeciv-web directory
    • Copy nginx configuration file from publite2/nginx/freeciv-web to the nginx config directory, /usr/local/nginx/conf, /etc/nginx, or /usr/local/etc/nginx and edit it to suit your needs.
    • Copy scripts/configuration.sh.dist to scripts/configuration.sh and edit it to suit your needs.
    • Copy publite2/settings.ini.dist to publite2/settings.ini and edit it to suit your needs.
    • You may wish to create a freeciv/dl_freeciv.sh if you have trouble with your Internet connection and build the Freeciv server often. See freeciv/dl_freeciv_default.sh and freeciv/dl_freeciv_from_git_svn.sh.dist

  7. Start and stop Freeciv-web with the following commands:
    start-freeciv-web.sh
    stop-freeciv-web.sh
    status-freeciv-web.sh (this script is useful to debug if Freeciv-web is running correctly) (On Vagrant, these scripts are found in PATH)

All software components in Freeciv-web will log to the /logs sub-directory of the Freeciv-web installation.

Freeciv-Web continuous integration on Travis CI

Freeciv-Web is built on Travis CI on every commit. This is the current build status: Build Status

Freeciv-web has CasperJS tests which are run by Travis CI on every commit, and by Vagrant when creating a new image. The tests can be found in tests/freeciv-web-tests.js. Please make sure that patches and commits for Freeciv-web don’t break the CasperJS tests. Thanks!

Developers interested in Freeciv-web

If you want to contibute to Freeciv-web, see the Freeciv bugs on gna.org and the TODO file for some tasks you can work on. Pull requests on Github is welcome!

Contributors to Freeciv-web

Andreas Røsdal @andreasrosdal
Marko Lindqvist
Sveinung Kvilhaugsvik
and the Freeciv.org project!