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 ## Project links
  18
  19 This project is community-driven and uses the following communication channels:
  20 - GitLab repository (including issues): https://gitlab.com/osslugaru/lugaru
  21 - Project website: https://osslugaru.gitlab.io
  22 - Mailing list: http://icculus.org/mailman/listinfo/lugaru
  23 - IRC channel: [#lugaru on Freenode](http://webchat.freenode.net/?channels=lugaru)
  24
  25 ## The game
  26
  27 Lugaru (pronounced Loo-GAH-roo) is a cross-platform third-person action game.
  28 The main character, Turner, is an anthropomorphic rebel bunny rabbit with
  29 impressive combat skills. In his quest to find those responsible for
  30 slaughtering his village, he uncovers a far-reaching conspiracy involving the
  31 corrupt leaders of the rabbit republic and the starving wolves from a nearby
  32 den. Turner takes it upon himself to fight against their plot and save his
  33 fellow rabbits from slavery.
  34
  35 ## History
  36
  37 Lugaru was originally developed by David Rosen of [Wolfire Games](http://www.wolfire.com)
  38 and was [open sourced in 2010](http://blog.wolfire.com/2010/05/Lugaru-goes-open-source).
  39 It was made cross-platform with the help of [Ryan C. Gordon](http://icculus.org).
  40
  41 Various forks were made at that time, and the most interesting developments
  42 were put back together under the OSS Lugaru organization, originally on
  43 [Google Code](https://code.google.com/p/lugaru) and then on
  44 [Bitbucket](https://bitbucket.org/osslugaru/lugaru).
  45
  46 This new repository on [GitLab](https://gitlab.com/osslugaru/lugaru) is run
  47 by the same team, and aims at revitalizing the development effort to clean
  48 things up, ensuring the code base builds and runs fine on all supported
  49 platforms, and easing the packaging of Lugaru in Linux distributions.
  50
  51 Ideally, the updated code base could also be used to update the Lugaru HD
  52 version sold by Wolfire Games once proven better than the current commercial
  53 builds.
  54
  55 ## Compiling
  56
  57 See the `COMPILING.md` for compilation instructions on all supported
  58 platforms.
  59
  60 ## Licensing
  61
  62 The source code is distributed under the GNU General Public License version 2
  63 or (at your option) any later version (GPLv2+).
  64
  65 The assets (campaigns, graphical and audio assets, etc.) in the `Data` folder
  66 are distributed under the Creative Commons Attribution - Share Alike license,
  67 some in version 3.0 Unported (CC-BY-SA 3.0) and others in version 4.0
  68 International (CC-BY-SA 4.0) as described in the `CONTENT-LICENSE.txt` file.