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.2 - 11 February 2017
  10
  11 Second release of the open source Lugaru project! It continues the refactoring
  12 work to make the old Lugaru code more modular and easier to maintain and
  13 extend. A particular attention was given to the development tools (in game
  14 editor) to improve the modability of the game.
  15
  16 ### Highlights
  17
  18 - Keep track of and display the game's version number in the console and
  19   main menu.
  20 - Many fixes and improvements to development tools, most of them should now
  21   work as described in the documentation.
  22 - New monospace font for the console, more readable.
  23 - Configurable campaign end message.
  24 - Various fixes to mod levels and campaigns.
  25 - A lot of behind-the-scenes refactoring that should help bring more
  26   interesting changes in future releases.
  27
  28 ### Detailed changes
  29
  30 **Engine:**
  31
  32 - Fix displaying the localized key names instead of the QWERTY ones (#62)
  33 - Fixed bushes appearing above ground on first level loaded
  34 - Add a monospace font for the console text to increase legibility (#23)
  35 - Devtools: improve handling of `map` command to avoid crashes (#23)
  36 - Devtools: prevent the `clothes` command from saving invalid paths (#59)
  37   * Added `clotheslist` command to inspect player clothes
  38 - Devtools: reviewed and fixed conflicting hotkeys and crashes (#73, #89)
  39 - Devtools: fix regression from 1.1 in changing player type (wolf/rabbit) (#88)
  40   * Some bindings were changed, see `Docs/DEVTOOLS.txt` for the updated list.
  41 - Campaign end message now configurable in the campaign definition file (#60)
  42 - Fix long dialog lines printed out of the dialog area (#86)
  43 - Lots of code refactoring and modernisation, fixed warnings
  44 - Many bug fixes
  45
  46 **Game content:**
  47
  48 - Fix incorrect number of levels in the Seven Tasks campaign file (caused a
  49   crash on Win32) (#70)
  50 - Fix crash in "Temple of the Wind" (sventemple) and "Snowy Grotto"
  51   (svengrotto) levels (#76, #79)
  52 - Add and fix missing black fur texture for Ash in the Empire campaign (#84)
  53
  54 **Project:**
  55
  56 - Applied `clang-format` code formatting to the source, using a custom
  57   Mozilla-based style (#18, !14)
  58 - Start properly versioning the game with version number displayed in the menu
  59   and console (#82, !15)
  60
  61
  62 ## Version 1.1 - 14 December 2016
  63
  64 First release of the open source Lugaru project! It contains most commits
  65 made from various contributors since the open sourcing in 2010, and is
  66 therefore more advanced than the preceding Lugaru HD release by Wolfire.
  67
  68 ### Highlights
  69
  70 - Multiple campaigns support, making it easier to install and play mods!
  71 - Those Lugaru mods are included by default as alternative to the Turner
  72   official campaign:
  73   * Temple, by Silb
  74   * Empire, by Jendraz
  75   * The Seven Tasks, by Philtron R.
  76 - All assets (animations, textures, models, maps, sounds, etc.) of Lugaru HD
  77   by Wolfire are under a free and open source license (CC-BY-SA 3.0)!
  78 - Window and input management ported from SDL 1.2 to SDL 2.0, improving the
  79   support for modern screen resolutions and fullscreen mode, as well as
  80   better input handling.
  81
  82 ### Detailed changes
  83
  84 **Project:**
  85
  86 - Migrated the project from Bitbucket to GitLab.com, the latter being more
  87   interesting feature-wise and based on an open source core
  88 - Migrated the project from mercurial to git as the latter is better known,
  89   and necessary as part of the GitLab migration
  90 - Set up continuous integration (CI) and binaries deployment with gitlab-ci:
  91   Linux GCC, Linux Clang, Windows MinGW32, Windows MinGW64
  92 - Removed obsolete bundled dependencies, both binaries and source code
  93
  94 **Engine:**
  95
  96 - Added support for installing and playing multiple campaigns
  97   * The current campaign can be changed in the level selection menu
  98 - Migrated from SDL 1.2 to SDL 2 (#2), with in particular:
  99   * improved screen resolution detection and handling, especially in
 100     fullscreen
 101   * switched input method from keycodes to scancodes
 102 - Dehardcoded game data loading, making proper system-wide installs possible
 103   on Linux (#21)
 104 - Renamed debug mode to devtools and improved the corresponding documentation
 105   Devtools are toggled with `--devtools` switch or adding a `Devtools: 1`
 106   entry to the config.txt (#32)
 107 - Added automatic progress saving upon level completion, and not only when
 108   closing the game.
 109 - Use standard directories to store game config and user data (#22):
 110   * Linux: XDG_CONFIG_HOME (default `~/.config/lugaru`) and XDG_DATA_HOME
 111     (default `~/.local/share/lugaru`)
 112   * OSX: `~/Library/Application Support/Lugaru`
 113   * Windows: `%APPDATA%\Lugaru`, i.e. `C:\Users\<you>\AppData\Roaming\Lugaru`
 114 - Add Linux installation instructions, together with desktop file, metainfo,
 115   icon and man page (#15, #27, #28)
 116 - Improved command line options parsing and added `--help` output (#14)
 117 - Fixed `nomousegrab`option (#5)
 118 - Added Fullscreen parameter in the options GUI, and Alt+Return as hotkey to
 119   toggle fullscreen mode
 120 - Increased default resolution from 640x480 to 1024x768 and bumped default
 121   visual details to the maximum level (#15)
 122 - Added "stereo" anaglyph 3D display mode to play with 3D glasses
 123 - Lots of code refactoring and modernisation, fixed warnings
 124 - Lots of bug fixes
 125 - Fixed compilation against modern compilers (GCC 5/6 - including MinGW - and
 126   Clang 3.8/3.9 so far)
 127
 128 **Game content:**
 129
 130 - All Wolfire assets are now licensed under CC-BY-SA 3.0 by David Rosen,
 131   making Lugaru fully free (relicensed in commit 51203b5)
 132 - Added the Temple campaign by Silb to the main repo (licensed under CC-BY-SA
 133   3.0, http://forums.wolfire.com/viewtopic.php?f=7&t=1066)
 134 - Fixed erroneous hardcoded paths to textures in some maps