Release 2.14.5

README

@@ -1,7 +1,7 @@
 Seven Kingdoms: Ancient Adversaries
 -----------------------------------
 
-Release version 2.14.4
+Release version 2.14.5
 Project website: www.7kfans.com
 
 This is a GPL release of the Seven Kingdoms: Ancient Adversaries thanks to
@@ -11,67 +11,69 @@ details of the license. We are indebted to Enlight for making the 7kfans
 project possible and giving a new chance to build a community for fans
 of the game.
 
-Who should use this version of 7KAA?
- * Any linux user.
- * Anyone who wants to try the latest bugfixes.
- * Anyone who likes the slightly improved game play.
-
-Who shouldn't use this version of 7KAA?
- * Any multiplayer user under Windows. The new netcode, while it promises
-   actual cross-platform capatability, does not work well in lobby, nor
-   does not work on anything other than LAN (VPN okay) and 2 players. Please
-   use 2.13.xx series with DPlay instead if stability and full-features are
-   needed.
-
-Changes in this release:
- * Added the game data to the source tree.
- * Added an NSIS install script.
- * Started rewriting the lobby code to be UDP instead of TCP. It is not done
-   and does not work properly for >2 player or over anything but LAN. The game
-   port is now UDP 19255.
+Summary of changes in this release
+---------
+ * Switched to using SDL2.
+ * Gained support for full-screen stretching.
+ * Gained support for MacOS.
+ * Switched to using enet, replacing SDL_net.
+ * Audio code improvements.
+ * The multiplayer connection code has stablized.
+ * New game hotkeys.
+ * Migrate population across extended town networks.
+ * Added ability to migrate 10 people at a time across between towns.
+ * Gettext translation support.
+ * Several bug fixes.
 
 Thanks to all who made this release possible.
 
 
-What you will find in this archive
+What is missing from the open source version of the game
 ---------
-* The GPL source and data files.
+* The original game music. The music is provided by 7kfans, but separately
+  from the source tree. It is not under the GPL license, but it is free to
+  download and use with 7KAA.
+* The original game intro video. Support may be restored in future releases.
+* Any other content from original game CDs, game manual, including the version
+  2.12b game binary or older. This also includes the I*Magic Online service.
 
 
-What you will NOT find in this archive
+System Requirements
 ---------
-* The original game music. The are provided in a separate package from 
-  7kfans.com. It is not under the GPL license, but it is free to download
-  and use with 7KAA.
-* The original translations resource file. This file was created by third
-  party distributors and Enlight does not have the right to distribute it.
-  This will be replaced by the 7kfans project.
-* Any other content from original game CDs, game manual including the version
-  2.12b game binary or older. This also includes the I*Magic Online service.
+
+The game is known to run on recent versions of
+* Windows
+* Linux
+* MacOS
+
+The game is known to build and work on both x86 and x86_64 architectures. But
+please note that playing multiplayer games between different architectures has
+not been tested deeply. It would be best if to try with x86 builds on everyone's
+system when arranging a multiplayer match until other arrangements are better
+tested.
 
 
 Building the game
 ---------
 
-General Requirements
+Required dependencies
 * GCC 4.xx or later
-* SDL 2.0.2
-* SDL_net
-* OpenAL
-* Autoconf (when using git snapshot)
+* SDL 2.0.2 or later (http://libsdl.org/)
+* enet 1.3.xx (http://enet.bespin.org/)
+* OpenAL-soft or equivalent driver (http://kcat.strangesoft.net/openal.html)
+
+Optional dependencies
+* Autoconf 2.65 (when using git snapshot)
 * gettext 0.18 or later
+* Game music bundle
+* NSIS for building a Windows installer
 
 
-Installing
+Running
 --------
-You can download the game data if you do not already have the game
-installed. You can find the game data from the 7kfans sourceforge
-page at http://sourceforge.net/projects/skfans/
-
-To patch the game:
-Copy the executable file "7kaa*" from the src/client directory to your
-installed game directory.  Run the 7kaa.exe executable to start the game
-instead of the classic Enlight version called 7k.exe.
 
-There are precompiled win32 install packages available.
+To run the game from the build directory, you need to point to the game data
+folder. The game data folder is set by the environment variable SKDATA. In
+a bash shell, this can be accomplished by
+$ SKDATA=data src/client/7kaa
 

configure.ac

@@ -2,7 +2,7 @@
 # Process this file with autoconf to produce a configure script.
 
 AC_PREREQ([2.65])
-AC_INIT([7kaa], [2.14.4], [[email protected]], [],
+AC_INIT([7kaa], [2.14.5], [[email protected]], [],
 	[http://7kfans.com/])
 AC_CONFIG_SRCDIR([src/client/AM.cpp])
 AC_CONFIG_HEADERS([include/config.h])

include/Makefile.am

@@ -167,6 +167,7 @@ noinst_HEADERS = \
 	file_reader.h \
 	file_util.h \
 	file_writer.h \
+	gettext.h \
 	input_stream.h \
 	mem_input_stream.h \
 	mouse_dinput.h \

include/version.h

@@ -27,9 +27,9 @@
 #ifndef __VERSION_H
 #define __VERSION_H
 
-#define SKVERSION "2.14.4"
+#define SKVERSION "2.14.5"
 #define SKVERMAJ 2
 #define SKVERMED 14
-#define SKVERMIN 4
+#define SKVERMIN 5
 
 #endif

packaging/windows/install.nsi

@@ -51,6 +51,7 @@ SetCompressor /SOLID lzma
 ;Pages
 
   !insertmacro MUI_PAGE_LICENSE "COPYING"
+  !insertmacro MUI_PAGE_LICENSE "COPYING-Music.txt"
   !insertmacro MUI_PAGE_COMPONENTS
   !insertmacro MUI_PAGE_DIRECTORY
 
@@ -95,7 +96,10 @@ Section "7kaa (required)" 7kaareq
 
   SetOutPath "$INSTDIR"
   File ".\README"
+  Rename "$INSTDIR\README" "$INSTDIR\README.txt"
   File ".\COPYING"
+  Rename "$INSTDIR\COPYING" "$INSTDIR\COPYING.txt"
+  File ".\doc\7kaa-hotkeys-2.14.5.png"
   File /r ".\data\encyc"
   File /r ".\data\encyc2"
   File /r ".\data\image"
@@ -122,33 +126,27 @@ Section "7kaa (required)" 7kaareq
 
 SectionEnd
 
-; Music Files (Non GPL and Public Domain)(can be disabled by user)
-; The music won't be in this installer.
-;Section "Music" music
-;
-;  SetOutPath "$INSTDIR"
-;  File /r ".\music"
-; 
-;SectionEnd
-
-Section "OpenAL" openal
+; Music Files (Not GPL and not Public Domain)(can be disabled by user)
+Section "Music" music
 
   SetOutPath "$INSTDIR"
-  File "lib\OpenAL32.dll"
+  File ".\README-music.txt"
+  File ".\COPYING-music.txt"
+  File /r ".\data\music"
 
 SectionEnd
 
-Section "SDL" sdl
+Section "OpenAL" openal
 
   SetOutPath "$INSTDIR"
-  File "lib\SDL2.dll"
+  File ".\OpenAL32.dll"
 
 SectionEnd
 
-Section "SDL_net" sdlnet
+Section "SDL" sdl
 
   SetOutPath "$INSTDIR"
-  File "lib\SDL_net.dll"
+  File ".\SDL2.dll"
 
 SectionEnd
 
@@ -161,6 +159,7 @@ Section "Start Menu Shortcuts" startshort
   CreateDirectory "$SMPROGRAMS\$StartMenuFolder"
   CreateShortCut "$SMPROGRAMS\$StartMenuFolder\Uninstall.lnk" "$INSTDIR\Uninstall.exe"
   CreateShortCut "$SMPROGRAMS\$StartMenuFolder\Seven Kingdoms AA.lnk" "$INSTDIR\7kaa.exe"
+  CreateShortCut "$SMPROGRAMS\$StartMenuFolder\Hotkeys.lnk" "$INSTDIR\7kaa-hotkeys-2.14.5.png"
 
   !insertmacro MUI_STARTMENU_WRITE_END
 
@@ -171,20 +170,18 @@ SectionEnd
 
   ;Language strings
   LangString secreq ${LANG_ENGLISH} "Files required for 7kaa to run"
-  LangString secmusic ${LANG_ENGLISH} "Music files for 7kaa. These are not licensed under the GPL or part of the Public Domain and may only be distributed with 7kaa"
+  LangString secmusic ${LANG_ENGLISH} "Music files for 7kaa"
   LangString secshort ${LANG_ENGLISH} "Start menu shortcuts"
-  LangString secopenal ${LANG_ENGLISH} "OpenAL shared library (recommended)"
+  LangString secopenal ${LANG_ENGLISH} "OpenAL-soft shared library (recommended if not provided by your hardware driver)"
   LangString secsdl ${LANG_ENGLISH} "SDL shared library (recommended)"
-  LangString secsdlnet ${LANG_ENGLISH} "SDL_net shared library (recommended)"
 
   ;Assign language strings to sections
   !insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
     !insertmacro MUI_DESCRIPTION_TEXT ${7kaareq} $(secreq)
-;      !insertmacro MUI_DESCRIPTION_TEXT ${music} $(secmusic)
+      !insertmacro MUI_DESCRIPTION_TEXT ${music} $(secmusic)
       !insertmacro MUI_DESCRIPTION_TEXT ${startshort} $(secshort)
     !insertmacro MUI_DESCRIPTION_TEXT ${openal} $(secopenal)
     !insertmacro MUI_DESCRIPTION_TEXT ${sdl} $(secsdl)
-    !insertmacro MUI_DESCRIPTION_TEXT ${sdlnet} $(secsdlnet)
   !insertmacro MUI_FUNCTION_DESCRIPTION_END
 
 ;--------------------------------
@@ -211,12 +208,15 @@ Section "Uninstall"
   RMDir /r "$INSTDIR\sound"
   RMDir /r "$INSTDIR\sprite"
   RMDir /r "$INSTDIR\tutorial"
+  RMDir /r "$INSTDIR\music"
   Delete "$INSTDIR\7kaa.exe"
-  Delete "$INSTDIR\COPYING"
-  Delete "$INSTDIR\README"
+  Delete "$INSTDIR\COPYING.txt"
+  Delete "$INSTDIR\README.txt"
+  Delete "$INSTDIR\7kaa-hotkeys-2.14.5.png"
+  Delete "$INSTDIR\COPYING-music.txt"
+  Delete "$INSTDIR\README-music.txt"
   Delete "$INSTDIR\OpenAL32.dll"
   Delete "$INSTDIR\SDL2.dll"
-  Delete "$INSTDIR\SDL_net.dll"
   Delete "$INSTDIR\Uninstall.exe"
 
   ; Remove shortcuts