README.md

   1 # Lugaru HD
   2
   3 [![build status](https://gitlab.com/osslugaru/lugaru/badges/master/build.svg)](https://gitlab.com/osslugaru/lugaru/commits/master)
   4
   5 This repository holds the official development effort of the open source game
   6 Lugaru (and in particular of its HD version) for Linux, Mac OSX and Windows.
   7
   8 Developments from various forks have been integrated in the same code base in
   9 an attempt to get a unified game to further develop (e.g. with new features,
  10 new target platforms and new campaigns) and distribute.
  11
  12 This is the same game as the one distributed by Wolfire Games on
  13 [Lugaru HD's website](http://www.wolfire.com/lugaru), though this repository
  14 contains some further developments which are not (yet) featured in the
  15 commercial version.
  16
  17 ## The game
  18
  19 Lugaru (pronounced Loo-GAH-roo) is a cross-platform third-person action game.
  20 The main character, Turner, is an anthropomorphic rebel bunny rabbit with
  21 impressive combat skills. In his quest to find those responsible for
  22 slaughtering his village, he uncovers a far-reaching conspiracy involving the
  23 corrupt leaders of the rabbit republic and the starving wolves from a nearby
  24 den. Turner takes it upon himself to fight against their plot and save his
  25 fellow rabbits from slavery.
  26
  27 ## History
  28
  29 Lugaru was originally developed by David Rosen of [Wolfire Games](http://www.wolfire.com)
  30 and was [open sourced in 2010](http://blog.wolfire.com/2010/05/Lugaru-goes-open-source).
  31 It was made cross-platform with the help of [Ryan C. Gordon](http://icculus.org).
  32
  33 Various forks were made at that time, and the most interesting developments
  34 were put back together under the OSS Lugaru organization, originally on
  35 [Google Code](https://code.google.com/p/lugaru) and then on
  36 [Bitbucket](https://bitbucket.org/osslugaru/lugaru).
  37
  38 This new repository on [GitLab](https://gitlab.com/osslugaru/lugaru) is run
  39 by the same team, and aims at revitalizing the development effort to clean
  40 things up, ensuring the code base builds and runs fine on all supported
  41 platforms, and easing the packaging of Lugaru in Linux distributions.
  42
  43 Ideally, the updated code base could also be used to update the Lugaru HD
  44 version sold by Wolfire Games once proven better than the current commercial
  45 builds.
  46
  47 ## Compiling
  48
  49 See the `COMPILING.txt` for compilation instructions on all supported
  50 platforms.
  51
  52 ## Licensing
  53
  54 The source code is distributed under the GNU General Public License version 2
  55 or (at your option) any later version (GPLv2+).
  56
  57 The assets (campaigns, graphical and audio assets, etc.) are distributed
  58 under various licenses (CC-BY-SA 3.0 and Freeware) as described in the
  59 `CONTENT-LICENSE.txt` file.
  60
  61 The third party dependencies of the `Dependencies` folder are distributed
  62 under their respective licenses.