Bump version to 1.1.0

Closes #152

.gitattributes

@@ -2,14 +2,23 @@
 *.c text eol=lf
 *.cc text eol=lf
 *.cmake text eol=lf
+*.gradle text eol=lf
 *.h text eol=lf
-*.md text eol=lf
+*.java text eol=lf
 *.json text eol=lf
+*.md text eol=lf
 *.plist text eol=lf
+*.pro text eol=lf
+*.properties text eol=lf
+*.xml text eol=lf
 *.yml text eol=lf
 .clang-format text eol=lf
 .editorconfig text eol=lf
 .gitattributes text eol=lf
 .gitignore text eol=lf
+gradlew text eol=lf
 CMakeLists.txt text eol=lf
 LICENSE text eol=lf
+
+# Force CRLF
+*.bat text eol=crlf

.github/workflows/ci-build.yml

@@ -2,19 +2,12 @@ name: Build
 
 on:
   push:
-    paths:
-      - '.github/workflows/ci-build.yml'
-      - 'src/**.cc'
-      - 'src/**.h'
-      - '**/CMakeLists.txt'
-      - '**/*.cmake'
+    branches:
+      - main
   pull_request:
-    paths:
-      - '.github/workflows/ci-build.yml'
-      - 'src/**.cc'
-      - 'src/**.h'
-      - '**/CMakeLists.txt'
-      - '**/*.cmake'
+    types:
+      - opened
+      - synchronize
 
 defaults:
   run:
@@ -38,6 +31,50 @@ jobs:
       - name: cppcheck
         run: cppcheck --std=c++17 src/
 
+  android:
+    name: Android
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Clone
+        uses: actions/checkout@v3
+
+      - name: Setup Java
+        uses: actions/setup-java@v2
+        with:
+          distribution: temurin
+          java-version: 11
+          cache: gradle
+
+      - name: Cache cmake build
+        uses: actions/cache@v3
+        with:
+          path: os/android/app/.cxx
+          key: android-cmake-v1
+
+      - name: Setup signing config
+        if: env.KEYSTORE_FILE_BASE64 != '' && env.KEYSTORE_PROPERTIES_FILE_BASE64 != ''
+        run: |
+          cd os/android
+          echo "$KEYSTORE_FILE_BASE64" | base64 --decode > debug.keystore
+          echo "$KEYSTORE_PROPERTIES_FILE_BASE64" | base64 --decode > debug-keystore.properties
+        env:
+          KEYSTORE_FILE_BASE64: ${{ secrets.ANDROID_DEBUG_KEYSTORE_FILE_BASE64 }}
+          KEYSTORE_PROPERTIES_FILE_BASE64: ${{ secrets.ANDROID_DEBUG_KEYSTORE_PROPERTIES_FILE_BASE64 }}
+
+      - name: Build
+        run: |
+          cd os/android
+          ./gradlew assembleDebug
+
+      - name: Upload
+        uses: actions/upload-artifact@v3
+        with:
+          name: fallout2-ce-debug.apk
+          path: os/android/app/build/outputs/apk/debug/app-debug.apk
+          retention-days: 7
+
   linux:
     name: Linux (${{ matrix.arch }})
 

.github/workflows/release.yml

@@ -10,6 +10,52 @@ defaults:
     shell: bash
 
 jobs:
+  android:
+    name: Android
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Clone
+        uses: actions/checkout@v3
+
+      - name: Setup Java
+        uses: actions/setup-java@v2
+        with:
+          distribution: temurin
+          java-version: 11
+          cache: gradle
+
+      - name: Cache cmake build
+        uses: actions/cache@v3
+        with:
+          path: os/android/app/.cxx
+          key: android-cmake-v1
+
+      - name: Setup signing config
+        if: env.KEYSTORE_FILE_BASE64 != '' && env.KEYSTORE_PROPERTIES_FILE_BASE64 != ''
+        run: |
+          cd os/android
+          echo "$KEYSTORE_FILE_BASE64" | base64 --decode > release.keystore
+          echo "$KEYSTORE_PROPERTIES_FILE_BASE64" | base64 --decode > release-keystore.properties
+        env:
+          KEYSTORE_FILE_BASE64: ${{ secrets.ANDROID_RELEASE_KEYSTORE_FILE_BASE64 }}
+          KEYSTORE_PROPERTIES_FILE_BASE64: ${{ secrets.ANDROID_RELEASE_KEYSTORE_PROPERTIES_FILE_BASE64 }}
+
+      - name: Build
+        run: |
+          cd os/android
+          ./gradlew assembleRelease
+
+      - name: Upload
+        run: |
+          cd os/android/app/build/outputs/apk/release
+          cp app-release.apk fallout2-ce-android.apk
+          gh release upload ${{ github.ref_name }} fallout2-ce-android.apk
+          rm fallout2-ce-android.apk
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   linux:
     name: Linux (${{ matrix.arch }})
 

CMakeLists.txt

@@ -170,6 +170,8 @@ target_sources(${EXECUTABLE_NAME} PUBLIC
     "src/palette.h"
     "src/party_member.cc"
     "src/party_member.h"
+    "src/pcx.cc"
+    "src/pcx.h"
     "src/perk_defs.h"
     "src/perk.cc"
     "src/perk.h"
@@ -237,8 +239,8 @@ target_sources(${EXECUTABLE_NAME} PUBLIC
     "src/window.h"
     "src/word_wrap.cc"
     "src/word_wrap.h"
-    "src/world_map.cc"
-    "src/world_map.h"
+    "src/worldmap.cc"
+    "src/worldmap.h"
     "src/xfile.cc"
     "src/xfile.h"
 )
@@ -274,11 +276,24 @@ if(WIN32)
     )
 endif()
 
+if (WIN32)
+    target_sources(${EXECUTABLE_NAME} PUBLIC
+        "os/windows/fallout2-ce.ico"
+        "os/windows/fallout2-ce.rc"
+    )
+endif()
+
 if(APPLE)
+    target_sources(${EXECUTABLE_NAME} PUBLIC "os/macos/fallout2-ce.icns")
+    set_source_files_properties("os/macos/fallout2-ce.icns" PROPERTIES MACOSX_PACKAGE_LOCATION "Resources")
+
     set_target_properties(${EXECUTABLE_NAME} PROPERTIES MACOSX_BUNDLE_INFO_PLIST "${CMAKE_SOURCE_DIR}/os/macos/Info.plist")
     set(MACOSX_BUNDLE_GUI_IDENTIFIER "com.alexbatalov.fallout2-ce")
     set(MACOSX_BUNDLE_BUNDLE_NAME "${EXECUTABLE_NAME}")
+    set(MACOSX_BUNDLE_ICON_FILE "fallout2-ce.icns")
     set(MACOSX_BUNDLE_DISPLAY_NAME "Fallout 2")
+    set(MACOSX_BUNDLE_SHORT_VERSION_STRING "1.1.0")
+    set(MACOSX_BUNDLE_BUNDLE_VERSION "1.1.0")
 endif()
 
 add_subdirectory("third_party/fpattern")

LICENSE.md

@@ -0,0 +1,51 @@
+# Sustainable Use License
+
+Version 1.0
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations below.
+
+## Limitations
+
+You may use or modify the software only for your own internal business purposes or for non-commercial or personal use. You may distribute the software or provide it to others only if you do so free of charge for non-commercial purposes. You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms. If you modify the software, you must include in any modified copies of the software a prominent notice stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed, and your license will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your license will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your license to terminate automatically and permanently.
+
+## No Liability
+
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+## Definitions
+
+The "licensor" is the entity offering these terms.
+
+The "software" is the software the licensor makes available under these terms, including any portion of it.
+
+"You" refers to the individual or entity agreeing to these terms.
+
+"Your company" is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. Control means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+"Your license" is the license granted to you for the software under these terms.
+
+"Use" means anything you do with the software requiring your license.
+
+"Trademark" means trademarks, service marks, and similar rights.

README.md

@@ -34,6 +34,16 @@ $ sudo apt install libsdl2-2.0-0
 
 - Run `fallout2-ce.app`.
 
+### Android
+
+> **NOTE**: Fallout 2 was designed with mouse in mind. There are many controls that require precise cursor positioning, which is not possible with fingers. When playing on Android you'll use fingers to move mouse cursor, not a character, or a map. Double tap to "click" left mouse button in the current cursor position, triple tap to "click" right mouse button. It might feel awkward at first, but it's super handy - you can play with just a thumb. This is not set in stone and might change in the future.
+
+- Use Windows installation as a base - it contains data assets needed to play. Copy `Fallout2` folder to your device, for example to `Downloads`. You need `master.dat`, `critter.dat`, `patch000.dat`, and `data` folder.
+
+- Download `fallout2-ce.apk` and copy it to your device. Open it with file explorer, follow instructions (install from unknown source).
+
+- When you run the game for the first time it will immediately present file picker. Select the folder from the first step. Wait until this data is copied. A loading dialog will appear, just wait for about 30 seconds. The game will start automatically.
+
 ## Contributing
 
 Integrating Sfall goodies is the top priority. Quality of life updates are OK too. Please no large scale refactorings at this time as we need to reconcile changes from Reference Edition, which will make this process slow and error-prone. In any case open up an issue with your suggestion or to notify other people that something is being worked on.
@@ -42,6 +52,6 @@ Integrating Sfall goodies is the top priority. Quality of life updates are OK to
 
 There are literally hundreds if not thousands of fixes and features in sfall. I guess not all of them are needed in Community Edition, but for the sake of compatibility with big mods out there, let's integrate them all.
 
-## Legal & License
+## License
 
-See [Fallout 2 Reference Edition](https://github.com/alexbatalov/fallout2-re). Same conditions apply until the source code in this repository is changed significantly.
+The source code is this repository is available under the [Sustainable Use License](LICENSE.md).

os/android/.gitignore

@@ -7,3 +7,7 @@
 /.idea/navEditor.xml
 /.idea/workspace.xml
 /local.properties
+/debug-keystore.properties
+/debug.keystore
+/release-keystore.properties
+/release.keystore

os/android/app/.gitignore

@@ -1,2 +1,5 @@
 /.cxx
 /build
+
+# TODO: Cleanup root .gitignore
+!/src/debug

os/android/app/build.gradle

@@ -9,8 +9,8 @@ android {
         applicationId 'com.alexbatalov.fallout2ce'
         minSdk 21
         targetSdk 32
-        versionCode 1
-        versionName '1.0'
+        versionCode 2
+        versionName '1.1.0'
         externalNativeBuild {
             cmake {
                 arguments '-DANDROID_STL=c++_static'
@@ -26,10 +26,49 @@ android {
         }
     }
 
+    signingConfigs {
+        // Override default debug signing config to make sure every CI runner
+        // uses the same key for painless updates.
+        def debugKeystorePropertiesFile = rootProject.file('debug-keystore.properties')
+        if (debugKeystorePropertiesFile.exists()) {
+            def debugKeystoreProperties = new Properties()
+            debugKeystoreProperties.load(new FileInputStream(debugKeystorePropertiesFile))
+
+            debug {
+                storeFile rootProject.file(debugKeystoreProperties.getProperty('storeFile'))
+                storePassword debugKeystoreProperties.getProperty('storePassword')
+                keyAlias debugKeystoreProperties.getProperty('keyAlias')
+                keyPassword debugKeystoreProperties.getProperty('keyPassword')
+            }
+        }
+
+        def releaseKeystoreProperties = new Properties()
+        def releaseKeystorePropertiesFile = rootProject.file('release-keystore.properties')
+        if (releaseKeystorePropertiesFile.exists()) {
+            releaseKeystoreProperties.load(new FileInputStream(releaseKeystorePropertiesFile))
+
+            release {
+                storeFile rootProject.file(releaseKeystoreProperties.getProperty('storeFile'))
+                storePassword releaseKeystoreProperties.getProperty('storePassword')
+                keyAlias releaseKeystoreProperties.getProperty('keyAlias')
+                keyPassword releaseKeystoreProperties.getProperty('keyPassword')
+            }
+        }
+    }
+
     buildTypes {
+        debug {
+            // Prevents signing keys clashes between debug and release versions
+            // for painless development.
+            applicationIdSuffix '.debug'
+        }
         release {
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+
+            // Release signing config is optional and might not be present in CI
+            // builds, hence `findByName`.
+            signingConfig signingConfigs.findByName('release')
         }
     }
 
@@ -57,4 +96,5 @@ android {
 
 dependencies {
     implementation fileTree(include: ['*.jar'], dir: 'libs')
+    implementation 'androidx.documentfile:documentfile:1.0.1'
 }

os/android/app/src/debug/res/values/strings.xml

@@ -0,0 +1,3 @@
+<resources>
+    <string name="app_name">Fallout 2 (Debug)</string>
+</resources>

os/android/app/src/main/AndroidManifest.xml

@@ -58,6 +58,7 @@
          An example Java class can be found in README-android.md
     -->
     <application android:label="@string/app_name"
+        android:icon="@mipmap/ic_launcher"
         android:allowBackup="true"
         android:theme="@android:style/Theme.NoTitleBar.Fullscreen"
         android:hardwareAccelerated="true" >
@@ -92,6 +93,10 @@
             </intent-filter>
             -->
         </activity>
+
+        <activity android:name=".ImportActivity"
+            android:theme="@style/AppTheme">
+        </activity>
     </application>
 
 </manifest>

os/android/app/src/main/java/com/alexbatalov/fallout2ce/FileUtils.java

@@ -0,0 +1,56 @@
+package com.alexbatalov.fallout2ce;
+
+import android.content.ContentResolver;
+
+import androidx.documentfile.provider.DocumentFile;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+public class FileUtils {
+
+    static boolean copyRecursively(ContentResolver contentResolver, DocumentFile src, File dest) {
+        final DocumentFile[] documentFiles = src.listFiles();
+        for (final DocumentFile documentFile : documentFiles) {
+            if (documentFile.isFile()) {
+                if (!copyFile(contentResolver, documentFile, new File(dest, documentFile.getName()))) {
+                    return false;
+                }
+            } else if (documentFile.isDirectory()) {
+                final File subdirectory = new File(dest, documentFile.getName());
+                if (!subdirectory.exists()) {
+                    subdirectory.mkdir();
+                }
+
+                if (!copyRecursively(contentResolver, documentFile, subdirectory)) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
+    private static boolean copyFile(ContentResolver contentResolver, DocumentFile src, File dest) {
+        try {
+            final InputStream inputStream = contentResolver.openInputStream(src.getUri());
+            final OutputStream outputStream = new FileOutputStream(dest);
+
+            final byte[] buffer = new byte[16384];
+            int bytesRead;
+            while ((bytesRead = inputStream.read(buffer)) != -1) {
+                outputStream.write(buffer, 0, bytesRead);
+            }
+
+            inputStream.close();
+            outputStream.close();
+        } catch (IOException e) {
+            e.printStackTrace();
+            return false;
+        }
+
+        return true;
+    }
+}

os/android/app/src/main/java/com/alexbatalov/fallout2ce/ImportActivity.java

@@ -0,0 +1,74 @@
+package com.alexbatalov.fallout2ce;
+
+import android.app.Activity;
+import android.app.ProgressDialog;
+import android.content.ContentResolver;
+import android.content.Intent;
+import android.net.Uri;
+import android.os.Bundle;
+
+import androidx.documentfile.provider.DocumentFile;
+
+import java.io.File;
+
+public class ImportActivity extends Activity {
+    private static final int IMPORT_REQUEST_CODE = 1;
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT_TREE);
+        startActivityForResult(intent, IMPORT_REQUEST_CODE);
+    }
+
+    @Override
+    protected void onActivityResult(int requestCode, int resultCode, Intent resultData) {
+        if (requestCode == IMPORT_REQUEST_CODE) {
+            if (resultCode == Activity.RESULT_OK) {
+                final Uri treeUri = resultData.getData();
+                if (treeUri != null) {
+                    final DocumentFile treeDocument = DocumentFile.fromTreeUri(this, treeUri);
+                    if (treeDocument != null) {
+                        copyFiles(treeDocument);
+                        return;
+                    }
+                }
+            }
+
+            finish();
+        } else {
+            super.onActivityResult(requestCode, resultCode, resultData);
+        }
+    }
+
+    private void copyFiles(DocumentFile treeDocument) {
+        ProgressDialog dialog = createProgressDialog();
+        dialog.show();
+
+        new Thread(() -> {
+            ContentResolver contentResolver = getContentResolver();
+            File externalFilesDir = getExternalFilesDir(null);
+            FileUtils.copyRecursively(contentResolver, treeDocument, externalFilesDir);
+
+            startMainActivity();
+            dialog.dismiss();
+            finish();
+        }).start();
+    }
+
+    private void startMainActivity() {
+        Intent intent = new Intent(this, MainActivity.class);
+        startActivity(intent);
+    }
+
+    private ProgressDialog createProgressDialog() {
+        ProgressDialog progressDialog = new ProgressDialog(this,
+            android.R.style.Theme_Material_Light_Dialog);
+        progressDialog.setTitle(R.string.loading_dialog_title);
+        progressDialog.setMessage(getString(R.string.loading_dialog_message));
+        progressDialog.setProgressStyle(ProgressDialog.STYLE_SPINNER);
+        progressDialog.setCancelable(false);
+
+        return progressDialog;
+    }
+}

os/android/app/src/main/java/com/alexbatalov/fallout2ce/MainActivity.java

@@ -1,18 +1,47 @@
 package com.alexbatalov.fallout2ce;
 
+import android.content.Intent;
 import android.os.Bundle;
 
 import org.libsdl.app.SDLActivity;
 
-public class MainActivity extends SDLActivity {
-    protected void onCreate(Bundle savedInstanceState) {
-        // Needed to initialize `files` folder (and make it publicly accessible
-        // for file managers) for user to upload assets.
-        getExternalFilesDir(null);
+import java.io.File;
 
+public class MainActivity extends SDLActivity {
+    private boolean noExit = false;
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
+
+        final File externalFilesDir = getExternalFilesDir(null);
+
+        final File configFile = new File(externalFilesDir, "fallout2.cfg");
+        if (!configFile.exists()) {
+            final File masterDatFile = new File(externalFilesDir, "master.dat");
+            final File critterDatFile = new File(externalFilesDir, "critter.dat");
+            if (!masterDatFile.exists() || !critterDatFile.exists()) {
+                final Intent intent = new Intent(this, ImportActivity.class);
+                startActivity(intent);
+
+                noExit = true;
+                finish();
+            }
+        }
     }
 
+    @Override
+    protected void onDestroy() {
+        super.onDestroy();
+
+        if (!noExit) {
+            // Needed to make sure libc calls exit handlers, which releases
+            // in-game resources.
+            System.exit(0);
+        }
+    }
+
+    @Override
     protected String[] getLibraries() {
         return new String[]{
             "fallout2-ce",

os/android/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
+    <background android:drawable="@color/ic_launcher_background"/>
+    <foreground android:drawable="@mipmap/ic_launcher_foreground"/>
+</adaptive-icon>

os/android/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
+    <background android:drawable="@color/ic_launcher_background"/>
+    <foreground android:drawable="@mipmap/ic_launcher_foreground"/>
+</adaptive-icon>