Windows, Linux and macOS release - v1.2.0

Author: luiscastilho

docs/CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog][1], and this project adheres to
 [Semantic Versioning][2].
 
+## [1.2.0] - 2021-06-23
+
+### Added
+
+- macOS release
+- Linux release
+- Added code to check for updates
+- Setup a GitHub Pages site
+
+### Fixed
+
+- Generate icons script now works with more recent versions of ImageMagick
+
+### Changed
+
+- Improved save and load scene code to work on macOS and Linux
+- Improved logger code to work on macOS and Linux
+
 ## [1.1.3] - 2021-06-06
 
 ### Fixed
@@ -67,7 +85,8 @@ same resolution where they were created
 - Visual initiative order widget to help in combats
 - An [exclusive video map][3] from [Animated Dungeon Maps][4]
 
-[unreleased]: https://github.com/luiscastilho/dungeoneering/compare/v1.1.3...HEAD
+[unreleased]: https://github.com/luiscastilho/dungeoneering/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/luiscastilho/dungeoneering/compare/v1.1.3...v1.2.0
 [1.1.3]: https://github.com/luiscastilho/dungeoneering/compare/v1.1.2...v1.1.3
 [1.1.2]: https://github.com/luiscastilho/dungeoneering/compare/v1.1.1...v1.1.2
 [1.1.1]: https://github.com/luiscastilho/dungeoneering/compare/v1.1.0...v1.1.1

docs/_layouts/default.html

@@ -30,30 +30,30 @@
         {% if site.show_downloads %}
         <h4 class="downloads-title">Download latest version</h4>
         <ul class="downloads">
-          <li class="hidden">
-            <a href="https://github.com/luiscastilho/dungeoneering/releases/download/latest/dungeoneering-linux64.zip">
+          <li>
+            <a href="https://github.com/luiscastilho/dungeoneering/releases/download/latest/dungeoneering-windows64.zip">
               <span class="download-icon">
-                <img src="assets/img/linux32.png" alt="Linux logo" width="18" height="18">
+                <img src="assets/img/windows32.png" alt="Windows logo" width="18" height="18">
               </span><span class="download-text">
-                <strong>Linux</strong>
+                <strong>Windows</strong>
               </span>
             </a>
           </li>
-          <li class="hidden">
-            <a href="https://github.com/luiscastilho/dungeoneering/releases/download/latest/dungeoneering-macos.zip">
+          <li>
+            <a href="https://github.com/luiscastilho/dungeoneering/releases/download/latest/dungeoneering-linux64.zip">
               <span class="download-icon">
-                <img src="assets/img/macos32.png" alt="macOS logo" width="18" height="18">
+                <img src="assets/img/linux32.png" alt="Linux logo" width="18" height="18">
               </span><span class="download-text">
-                <strong>macOS</strong>
+                <strong>Linux</strong>
               </span>
             </a>
           </li>
           <li>
-            <a href="https://github.com/luiscastilho/dungeoneering/releases/download/v1.1.3/dungeoneering-v1.1.3-win64.zip">
+            <a href="https://github.com/luiscastilho/dungeoneering/releases/download/latest/dungeoneering-macos.zip">
               <span class="download-icon">
-                <img src="assets/img/windows32.png" alt="Windows logo" width="18" height="18">
+                <img src="assets/img/macos32.png" alt="macOS logo" width="18" height="18">
               </span><span class="download-text">
-                <strong>Windows</strong>
+                <strong>macOS</strong>
               </span>
             </a>
           </li>

docs/_sass/jekyll-theme-minimal.scss

@@ -141,15 +141,15 @@ ul.downloads {
 }
 
 .downloads li {
-  width:100%;
+  width:33%;
   float:left;
   border-right:1px solid #e0e0e0;
   height:40px;
 }
 
 .downloads li:last-child {
-    border-right:none;
-  }
+  border-right:none;
+}
 
 .downloads li:first-child a {
   border-radius:5px 0 0 5px;
@@ -165,7 +165,7 @@ ul.downloads {
   color:#F64B29;
   display:block;
   text-align:center;
-  padding-top:6px;
+  padding-top:3px;
   height:34px;
 }
 
@@ -183,11 +183,6 @@ strong {
   font-weight:700;
 }
 
-.downloads li + li + li {
-  border-right:none;
-  width:100%;
-}
-
 .downloads a strong {
   font-size:14px;
   display:block;

docs/index.md

@@ -24,11 +24,11 @@ The application should work with the instructions above. If it doesn't, create a
 
 ### macOS
 
-Coming soon!
+The macOS ZIP is unsigned, meaning macOS will complain about it. Once you unzip the macOS ZIP, right click on `dungeoneering` and choose Open. If asked, grant access to Documents folder since that's where dungeoneering saves its log files on macOS.
 
 ### Linux
 
-Coming soon too!
+To run dungeoneering on Linux, you will need to install Gstreamer v0.10. It's an older version of Gstreamer so it might be difficult to find the right packages to install. If you are using Ubuntu 18.04 or 20.04, [this script](releases/ubuntu_install_prereqs.sh) should install everything you need. If you are using another Linux distribution, create an issue please and I will try to help you.
 
 
 

docs/latest_version

@@ -1 +1 @@
-v1.1.3
+v1.2.0

docs/releases/create_release.sh

@@ -9,87 +9,135 @@ set -euo pipefail
 IFS=$'\n\t'
 
 version="${1:-}"
+platform="${2:-}"
 root_dir="../.."
 
 # Check if we have everything we need
 
-if [ -z "$version" ]; then
-    echo "usage: $(basename $0) version"
+if [ -z "${version}" -o -z "${platform}" ]; then
+    echo "usage: $(basename $0) version platform"
+    exit 1
+fi
+if [ "${platform}" != "windows" -a "${platform}" != "linux" ]; then
+    echo "usage: $(basename $0) version platform"
     exit 1
 fi
 
 spaces_regex="[[:space:]]+"
-if [[ "$version" =~ $spaces_regex ]]; then
+if [[ "${version}" =~ $spaces_regex ]]; then
     echo "ERROR: version shouldn't contain spaces"
     exit 1
 fi
+if [[ "${platform}" =~ $spaces_regex ]]; then
+    echo "ERROR: platform shouldn't contain spaces"
+    exit 1
+fi
 
-if [ ! -d "$root_dir/dungeoneering/application.windows64/" ]; then
+if [ "${platform}" == "windows" -a ! -d "${root_dir}/dungeoneering/application.windows64/" ]; then
     echo "ERROR: dir application.windows64 not found"
     exit 1
 fi
+if [ "${platform}" == "linux" -a ! -d "${root_dir}/dungeoneering/application.linux64/" ]; then
+    echo "ERROR: dir application.linux64 not found"
+    exit 1
+fi
 
-if [ -d "$root_dir/releases/$version/dungeoneering-$version-win64/" ]; then
-    echo "ERROR: dir dungeoneering-$version-win64 already exists"
+if [ "${platform}" == "windows" -a -d "${root_dir}/releases/${version}/dungeoneering-windows64/" ]; then
+    echo "ERROR: dir dungeoneering-windows64 already exists"
+    exit 1
+fi
+if [ "${platform}" == "linux" -a -d "${root_dir}/releases/${version}/dungeoneering-linux64/" ]; then
+    echo "ERROR: dir dungeoneering-linux64 already exists"
     exit 1
 fi
 
-echo "Creating release dungeoneering-$version-win64.zip..."
+echo "Creating release dungeoneering-${platform}64.zip..."
 
 # Go to application root dir
 
-cd $root_dir
+cd ${root_dir}
 
-# Exclude exported application.windows32 dir
+# Exclude uneeded exported applications
 
-echo -n "  Exclude application.windows32 directory..."
-if [ -d dungeoneering/application.windows32/ ]; then
-    rm -r dungeoneering/application.windows32/
+if [ "${platform}" == "windows" ]; then
+    echo -n "  Exclude application.windows32 directory..."
+    if [ -d dungeoneering/application.windows32/ ]; then
+        rm -r dungeoneering/application.windows32/
+    fi
+    echo " done"
+fi
+if [ "${platform}" == "linux" ]; then
+    echo -n "  Exclude application.linux32 directory..."
+    if [ -d dungeoneering/application.linux32/ ]; then
+        rm -r dungeoneering/application.linux32/
+    fi
+    echo " done"
+    echo -n "  Exclude application.linux-arm64 directory..."
+    if [ -d dungeoneering/application.linux-arm64/ ]; then
+        rm -r dungeoneering/application.linux-arm64/
+    fi
+    echo " done"
+    echo -n "  Exclude application.linux-armv6hf directory..."
+    if [ -d dungeoneering/application.linux-armv6hf/ ]; then
+        rm -r dungeoneering/application.linux-armv6hf/
+    fi
+    echo " done"
 fi
-echo " done"
 
 # Create version root dir
 
-echo -n "  Create $version directory..."
-mkdir -p releases/$version
+echo -n "  Create ${version} directory..."
+mkdir -p releases/${version}
 echo " done"
 
-# Move application.windows64 to version dir
+# Move application dir to version dir
 
-echo -n "  Move application.windows64 to dungeoneering-$version-win64..."
-mv dungeoneering/application.windows64 releases/$version/dungeoneering-$version-win64
-echo " done"
+if [ "${platform}" == "windows" ]; then
+    working_dir=dungeoneering-windows64
+    echo -n "  Move application.windows64 to ${working_dir}..."
+    mv dungeoneering/application.windows64 releases/${version}/${working_dir}
+    echo " done"
+fi
+if [ "${platform}" == "linux" ]; then
+    working_dir=dungeoneering-linux64
+    echo -n "  Move application.linux64 to ${working_dir}..."
+    mv dungeoneering/application.linux64 releases/${version}/${working_dir}
+    echo " done"
+fi
 
 # Copy release files to version dir
 
-echo -n "  Copy release files to dungeoneering-$version-win64..."
-cp docs/releases/*.txt releases/$version/dungeoneering-$version-win64/
-cp docs/CHANGELOG.md releases/$version/dungeoneering-$version-win64/CHANGELOG.txt
+echo -n "  Copy release files to ${working_dir}..."
+cp docs/releases/*.txt releases/${version}/${working_dir}/
+cp docs/CHANGELOG.md releases/${version}/${working_dir}/CHANGELOG.txt
 echo " done"
 
 # Copy libraries to lib dir and then remove platform specific files
 
-echo -n "  Copy libraries to dungeoneering-$version-win64/lib..."
-cp -r dungeoneering/code/* releases/$version/dungeoneering-$version-win64/lib
-rm -r releases/$version/dungeoneering-$version-win64/lib/macosx64/
-rm -r releases/$version/dungeoneering-$version-win64/lib/windows32/
+echo -n "  Copy libraries to ${working_dir}/lib..."
+cp -r dungeoneering/code/* releases/${version}/${working_dir}/lib
+rm -r releases/${version}/${working_dir}/lib/macosx64/
+rm -r releases/${version}/${working_dir}/lib/windows32/
+if [ "${platform}" == "linux" ]; then
+    rm -r releases/${version}/${working_dir}/lib/windows64/
+fi
 echo " done"
 
 # Remove unnecessary files from version dir
 
-echo -n "  Remove unnecessary files from dungeoneering-$version-win64..."
-rm releases/$version/dungeoneering-$version-win64/source/dungeoneering.java
-rm -r releases/$version/dungeoneering-$version-win64/data/icons/orig/
-if [ -d releases/$version/dungeoneering-$version-win64/data/campaign/ ]; then
-    rm -r releases/$version/dungeoneering-$version-win64/data/campaign/
+echo -n "  Remove unnecessary files from ${working_dir}..."
+rm releases/${version}/${working_dir}/source/dungeoneering.java
+rm -r releases/${version}/${working_dir}/data/icons/orig/
+if [ -d releases/${version}/${working_dir}/data/campaign/ ]; then
+    rm -r releases/${version}/${working_dir}/data/campaign/
 fi
 echo " done"
 
 # Create release zip file
 
-echo -n "  Create a ZIP file with dungeoneering-$version-win64 contents..."
-cd releases/$version
-zip -qr dungeoneering-$version-win64.zip dungeoneering-$version-win64/
+echo -n "  Create a ZIP file with ${working_dir} contents..."
+cd releases/${version}
+zip -qr ${working_dir}.zip ${working_dir}/
 echo " done"
 
 echo "Done"

docs/releases/ubuntu_install_prereqs.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+#
+# Install Ubuntu gstreamer0.10 packages.
+#
+# Requirements: bash, coreutils, wget, dpkg
+#
+
+set -euo pipefail
+IFS=$'\n\t'
+
+# Check if it's Ubuntu 18.04 or 20.04
+lsb_release -d | grep -qi '18.04'; is_ubuntu_18=$?
+lsb_release -d | grep -qi '20.04'; is_ubuntu_20=$?
+if [ $is_ubuntu_18 -ne 0 -a $is_ubuntu_20 -ne 0 ]; then
+    echo "ERROR: This script only works for Ubuntu 18.04 or 20.04. Please create an issue for other Ubuntu versions or for other Linux distributions."
+    exit 1
+fi
+
+# Create and move to packages dir
+cd ~ && mkdir gstreamer0.10 && cd gstreamer0.10/
+
+# Download packages
+lsb_release -d | grep -qi '20.04' && wget https://launchpad.net/~linuxuprising/+archive/ubuntu/libpng12/+files/libpng12-0_1.2.54-1ubuntu1.1+1~ppa0~focal_amd64.deb
+lsb_release -d | grep -qi '18.04' && wget https://launchpad.net/~ubuntu-security/+archive/ubuntu/ppa/+build/15108504/+files/libpng12-0_1.2.54-1ubuntu1.1_amd64.deb
+wget http://launchpadlibrarian.net/215074266/libgstreamer0.10-0_0.10.36-1.5ubuntu1_amd64.deb
+wget http://launchpadlibrarian.net/421117832/libgstreamer-plugins-base0.10-0_0.10.36-2ubuntu0.2_amd64.deb
+wget http://launchpadlibrarian.net/312211203/gstreamer0.10-gconf_0.10.31-3+nmu4ubuntu2.16.04.3_amd64.deb
+wget http://launchpadlibrarian.net/421117831/gstreamer0.10-x_0.10.36-2ubuntu0.2_amd64.deb
+wget http://launchpadlibrarian.net/312211205/gstreamer0.10-pulseaudio_0.10.31-3+nmu4ubuntu2.16.04.3_amd64.deb
+wget http://launchpadlibrarian.net/421117830/gstreamer0.10-plugins-base_0.10.36-2ubuntu0.2_amd64.deb
+wget http://launchpadlibrarian.net/312211204/gstreamer0.10-plugins-good_0.10.31-3+nmu4ubuntu2.16.04.3_amd64.deb
+wget https://launchpad.net/~mc3man/+archive/ubuntu/gstffmpeg-keep/+files/gstreamer0.10-ffmpeg_0.10.13-5ubuntu1~wily_amd64.deb
+
+# Install packages
+sudo apt install -y libcanberra-gtk-module libcanberra-gtk0
+sudo apt install -y gconf-service gconf-service-backend gconf2 gconf2-common libgconf-2-4 gconf-defaults-service
+lsb_release -d | grep -qi '20.04' && sudo dpkg -i libpng12-0_1.2.54-1ubuntu1.1+1~ppa0~focal_amd64.deb
+lsb_release -d | grep -qi '18.04' && sudo dpkg -i libpng12-0_1.2.54-1ubuntu1.1_amd64.deb
+sudo dpkg -i libgstreamer0.10-0_0.10.36-1.5ubuntu1_amd64.deb
+sudo dpkg -i libgstreamer-plugins-base0.10-0_0.10.36-2ubuntu0.2_amd64.deb
+sudo dpkg -i gstreamer0.10-gconf_0.10.31-3+nmu4ubuntu2.16.04.3_amd64.deb
+sudo dpkg -i gstreamer0.10-x_0.10.36-2ubuntu0.2_amd64.deb
+sudo dpkg -i gstreamer0.10-pulseaudio_0.10.31-3+nmu4ubuntu2.16.04.3_amd64.deb
+sudo dpkg -i gstreamer0.10-plugins-base_0.10.36-2ubuntu0.2_amd64.deb
+sudo dpkg -i gstreamer0.10-plugins-good_0.10.31-3+nmu4ubuntu2.16.04.3_amd64.deb
+sudo dpkg -i gstreamer0.10-ffmpeg_0.10.13-5ubuntu1~wily_amd64.deb

dungeoneering/dungeoneering.pde

@@ -117,7 +117,7 @@ void setup() {
 
     previousClickTime = 0;
 
-    appVersion = "v1.1.3";
+    appVersion = "v1.2.0";
     checkedForUpdates = false;
 
     logger.info("Setup: dungeoneering initialization done");