RELEASE-NOTES.md

   1 # OSS Lugaru Release Notes
   2
   3 This file contains the subsequent release notes for each version of Lugaru as
   4 released by the OSS Lugaru team, in reverse chronological order.
   5
   6 The numbers preceded by a hash (e.g. #9) reference GitLab issue numbers on
   7 the [OSS Lugaru repository](https://gitlab.com/osslugaru/lugaru).
   8
   9 ## Version 1.1
  10
  11 First release of the open source Lugaru project! It contains most commits
  12 made from various contributors since the open sourcing in 2010, and is
  13 therefore more advanced than the preceding Lugaru HD release by Wolfire.
  14
  15 ### Highlights
  16
  17 - Multiple campaigns support, making it easier to install and play mods!
  18 - The Temple campaign by Silb is included by default as alternative to the
  19   Turner official campaign.
  20 - All assets (animations, textures, models, maps, sounds, etc.) of Lugaru HD
  21   by Wolfire are under a free and open source license (CC-BY-SA 3.0)!
  22 - Window and input management ported from SDL 1.2 to SDL 2.0, improving the
  23   support for modern screen resolutions and fullscreen mode, as well as
  24   better input handling.
  25
  26 ### Detailed changes
  27
  28 **Project:**
  29
  30 - Migrated the project from Bitbucket to GitLab.com, the latter being more
  31   interesting feature-wise and based on an open source core
  32 - Migrated the project from mercurial to git as the latter is better known,
  33   and necessary as part of the GitLab migration
  34 - Set up continuous integration (CI) and binaries deployment with gitlab-ci:
  35   Linux GCC, Linux Clang, Windows MinGW32, Windows MinGW64
  36 - Removed obsolete bundled dependencies, both binaries and source code
  37
  38 **Engine:**
  39
  40 - Added support for installing and playing multiple campaigns
  41   * The current campaign can be changed in the level selection menu
  42 - Migrated from SDL 1.2 to SDL 2 (#2), with in particular:
  43   * improved screen resolution detection and handling, especially in
  44     fullscreen
  45   * switched input method from keycodes to scancodes
  46 - Dehardcoded game data loading, making proper system-wide installs possible
  47   on Linux (#21)
  48 - Renamed debug mode to devtools and improved the corresponding documentation
  49   Devtools are toggled with `--devtools` switch or adding a `Devtools: 1`
  50   entry to the config.txt (#32)
  51 - Use standard directories to store game config and user data (#22):
  52   * Linux: XDG_CONFIG_HOME (default `~/.config/lugaru`) and XDG_DATA_HOME
  53     (default `~/.local/share/lugaru`)
  54   * OSX: `~/Library/Application Support/Lugaru`
  55   * Windows: `%APPDATA%\Lugaru`, i.e. `C:\Users\<you>\AppData\Roaming\Lugaru`
  56 - Add Linux installation instructions, together with desktop file, metainfo,
  57   icon and man page (#15, #27, #28)
  58 - Improved command line options parsing and added `--help` output (#14)
  59 - Fixed `nomousegrab`option (#5)
  60 - Added Fullscreen parameter in the options GUI, and Alt+Return as hotkey to
  61   toggle fullscreen mode
  62 - Increased default resolution from 640x480 to 1024x768 and bumped default
  63   visual details to the maximum level (#15)
  64 - Added "stereo" anaglyph 3D display mode to play with 3D glasses
  65 - Lots of code refactoring and modernisation, fixed warnings
  66 - Lots of bug fixes
  67 - Fixed compilation against modern compilers (GCC 5/6 - including MinGW - and
  68   Clang 3.8/3.9 so far)
  69
  70 **Game content:**
  71
  72 - All Wolfire assets are now licensed under CC-BY-SA 3.0 by David Rosen,
  73   making Lugaru fully free (relicensed in commit 51203b5)
  74 - Added the Temple campaign by Silb to the main repo (licensed under CC-BY-SA
  75   3.0, http://forums.wolfire.com/viewtopic.php?f=7&t=1066)
  76 - Fixed erroneous hardcoded paths to textures in some maps