Reconcile with reference edition

Closes #110

.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,49 @@ 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
+        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,51 @@ 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
+        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"

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. There is no fancy importing interface (yet), 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.

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

@@ -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

@@ -92,6 +92,10 @@
             </intent-filter>
             -->
         </activity>
+
+        <activity android:name=".ImportActivity"
+            android:theme="@style/AppTheme">
+        </activity>
     </application>
 
 </manifest>

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

@@ -0,0 +1,89 @@
+package com.alexbatalov.fallout2ce;
+
+import android.app.Activity;
+import android.content.Intent;
+import android.net.Uri;
+import android.os.Bundle;
+
+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 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) {
+                        copyRecursively(treeDocument, getExternalFilesDir(null));
+
+                        final Intent intent = new Intent(this, MainActivity.class);
+                        startActivity(intent);
+                    }
+                }
+            }
+
+            finish();
+        } else {
+            super.onActivityResult(requestCode, resultCode, resultData);
+        }
+    }
+
+    private boolean copyRecursively(DocumentFile src, File dest) {
+        final DocumentFile[] documentFiles = src.listFiles();
+        for (final DocumentFile documentFile : documentFiles) {
+            if (documentFile.isFile()) {
+                if (!copyFile(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(documentFile, subdirectory)) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+
+    private boolean copyFile(DocumentFile src, File dest) {
+        try {
+            final InputStream inputStream = getContentResolver().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/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/values/strings.xml

@@ -1,3 +1,3 @@
 <resources>
-    <string name="app_name">Fallout 2 Community Edition</string>
+    <string name="app_name">Fallout 2</string>
 </resources>

src/actions.h

@@ -16,7 +16,7 @@ bool _can_see(Object* a1, Object* a2);
 bool _action_explode_running();
 int actionExplode(int tile, int elevation, int minDamage, int maxDamage, Object* a5, bool a6);
 int actionTalk(Object* a1, Object* a2);
-void _action_dmg(int tile, int elevation, int minDamage, int maxDamage, int damageType, bool animated, bool bypassArmor);
+void actionDamage(int tile, int elevation, int minDamage, int maxDamage, int damageType, bool animated, bool bypassArmor);
 bool actionCheckPush(Object* a1, Object* a2);
 int actionPush(Object* a1, Object* a2);
 int _action_can_talk_to(Object* a1, Object* a2);

src/animation.h

@@ -3,36 +3,14 @@
 
 #include "combat_defs.h"
 #include "obj_types.h"
-#include "sound.h"
 
-typedef enum AnimKind {
-    ANIM_KIND_OBJ_MOVE_TO_OBJ = 0,
-    ANIM_KIND_OBJ_MOVE_TO_TILE = 1,
-    ANIM_KIND_2 = 2,
-    ANIM_KIND_KNOCKDOWN = 3,
-    ANIM_KIND_ANIMATE = 4,
-    ANIM_KIND_ANIMATE_REVERSE = 5,
-    ANIM_KIND_6 = 6,
-    ANIM_KIND_SET_ROTATION_TO_TILE = 7,
-    ANIM_KIND_ROTATE_CLOCKWISE = 8,
-    ANIM_KIND_ROTATE_COUNTER_CLOCKWISE = 9,
-    ANIM_KIND_HIDE = 10,
-    ANIM_KIND_EXEC = 11,
-    ANIM_KIND_EXEC_2 = 12,
-    ANIM_KIND_14 = 14,
-    ANIM_KIND_15 = 15,
-    ANIM_KIND_16 = 16,
-    ANIM_KIND_17 = 17,
-    ANIM_KIND_18 = 18,
-    ANIM_KIND_19 = 19,
-    ANIM_KIND_20 = 20,
-    ANIM_KIND_23 = 23,
-    ANIM_KIND_24 = 24,
-    ANIM_KIND_ANIMATE_FOREVER = 25,
-    ANIM_KIND_26 = 26,
-    ANIM_KIND_27 = 27,
-    ANIM_KIND_28 = 28,
-} AnimKind;
+typedef enum AnimationRequestOptions {
+    ANIMATION_REQUEST_UNRESERVED = 0x01,
+    ANIMATION_REQUEST_RESERVED = 0x02,
+    ANIMATION_REQUEST_NO_STAND = 0x04,
+    ANIMATION_REQUEST_0x100 = 0x100,
+    ANIMATION_REQUEST_INSIGNIFICANT = 0x200,
+} AnimationRequestOptions;
 
 // Basic animations: 0-19
 // Knockdown and death: 20-35
@@ -112,9 +90,13 @@ typedef enum AnimationType {
     LAST_SF_DEATH_ANIM = ANIM_FALL_FRONT_BLOOD_SF,
 } AnimationType;
 
-typedef int AnimationProc(Object*, Object*);
-typedef int AnimationSoundProc(Sound*);
-typedef int AnimationProc2(Object*, Object*, void*);
+#define FID_ANIM_TYPE(value) ((value) & 0xFF0000) >> 16
+
+// Signature of animation callback accepting 2 parameters.
+typedef int(AnimationCallback)(void* a1, void* a2);
+
+// Signature of animation callback accepting 3 parameters.
+typedef int(AnimationCallback3)(void* a1, void* a2, void* a3);
 
 typedef struct STRUCT_530014_28 {
     int tile;
@@ -133,28 +115,31 @@ int _register_priority(int a1);
 int reg_anim_clear(Object* a1);
 int reg_anim_end();
 int animationIsBusy(Object* a1);
-int reg_anim_obj_move_to_obj(Object* a1, Object* a2, int actionPoints, int delay);
-int reg_anim_obj_run_to_obj(Object* owner, Object* destination, int actionPoints, int delay);
-int reg_anim_obj_move_to_tile(Object* obj, int tile_num, int elev, int actionPoints, int delay);
-int reg_anim_obj_run_to_tile(Object* obj, int tile_num, int elev, int actionPoints, int delay);
-int reg_anim_2(Object* obj, int tile_num, int elev, int a4, int a5);
-int reg_anim_knockdown(Object* obj, int tile, int elev, int anim, int delay);
-int reg_anim_animate(Object* obj, int anim, int delay);
-int reg_anim_animate_reverse(Object* obj, int anim, int delay);
-int reg_anim_6(Object* obj, int anim, int delay);
-int reg_anim_set_rotation_to_tile(Object* owner, int tile);
-int reg_anim_rotate_clockwise(Object* obj);
-int reg_anim_rotate_counter_clockwise(Object* obj);
-int reg_anim_hide(Object* obj);
-int reg_anim_11_0(Object* a1, Object* a2, AnimationProc* proc, int delay);
-int reg_anim_12(Object* a1, Object* a2, void* a3, AnimationProc2* proc, int delay);
-int reg_anim_11_1(Object* a1, Object* a2, AnimationProc* proc, int delay);
-int reg_anim_15(Object* obj, int a2, int a3);
-int reg_anim_17(Object* obj, int fid, int a3);
-int reg_anim_18(Object* obj, int a2, int a3);
-int reg_anim_update_light(Object* obj, int fid, int a3);
-int reg_anim_play_sfx(Object* obj, const char* a2, int a3);
-int reg_anim_animate_forever(Object* obj, int a2, int a3);
+int animationRegisterMoveToObject(Object* owner, Object* destination, int actionPoints, int delay);
+int animationRegisterRunToObject(Object* owner, Object* destination, int actionPoints, int delay);
+int animationRegisterMoveToTile(Object* owner, int tile, int elevation, int actionPoints, int delay);
+int animationRegisterRunToTile(Object* owner, int tile, int elevation, int actionPoints, int delay);
+int animationRegisterMoveToTileStraight(Object* object, int tile, int elevation, int anim, int delay);
+int animationRegisterMoveToTileStraightAndWaitForComplete(Object* owner, int tile, int elev, int anim, int delay);
+int animationRegisterAnimate(Object* owner, int anim, int delay);
+int animationRegisterAnimateReversed(Object* owner, int anim, int delay);
+int animationRegisterAnimateAndHide(Object* owner, int anim, int delay);
+int animationRegisterRotateToTile(Object* owner, int tile);
+int animationRegisterRotateClockwise(Object* owner);
+int animationRegisterRotateCounterClockwise(Object* owner);
+int animationRegisterHideObject(Object* object);
+int animationRegisterHideObjectForced(Object* object);
+int animationRegisterCallback(void* a1, void* a2, AnimationCallback* proc, int delay);
+int animationRegisterCallback3(void* a1, void* a2, void* a3, AnimationCallback3* proc, int delay);
+int animationRegisterCallbackForced(void* a1, void* a2, AnimationCallback* proc, int delay);
+int animationRegisterSetFlag(Object* object, int flag, int delay);
+int animationRegisterUnsetFlag(Object* object, int flag, int delay);
+int animationRegisterSetFid(Object* owner, int fid, int delay);
+int animationRegisterTakeOutWeapon(Object* owner, int weaponAnimationCode, int delay);
+int animationRegisterSetLightDistance(Object* owner, int lightDistance, int delay);
+int animationRegisterToggleOutline(Object* object, bool outline, int delay);
+int animationRegisterPlaySoundEffect(Object* owner, const char* soundEffectName, int delay);
+int animationRegisterAnimateForever(Object* owner, int anim, int delay);
 int reg_anim_26(int a1, int a2);
 int _make_path(Object* object, int from, int to, unsigned char* a4, int a5);
 int pathfinderFindPath(Object* object, int from, int to, unsigned char* rotations, int a5, PathBuilderCallback* callback);

src/art.h

@@ -127,7 +127,7 @@ unsigned char* artLockFrameData(int fid, int frame, int direction, CacheEntry**
 unsigned char* artLockFrameDataReturningSize(int fid, CacheEntry** out_cache_entry, int* widthPtr, int* heightPtr);
 int artUnlock(CacheEntry* cache_entry);
 int artCacheFlush();
-int artCopyFileName(int a1, int a2, char* a3);
+int artCopyFileName(int objectType, int a2, char* a3);
 int _art_get_code(int a1, int a2, char* a3, char* a4);
 char* artBuildFilePath(int a1);
 int artGetFramesPerSecond(Art* art);
@@ -144,8 +144,9 @@ bool artExists(int fid);
 bool _art_fid_valid(int fid);
 int _art_alias_num(int a1);
 int artCritterFidShouldRun(int a1);
-int _art_alias_fid(int a1);
-int buildFid(int a1, int a2, int a3, int a4, int a5);
+int artAliasFid(int fid);
+int buildFid(int objectType, int frmId, int animType, int a4, int rotation);
 int artRead(const char* path, unsigned char* data);
+int artWrite(const char* path, unsigned char* data);
 
 #endif

src/automap.cc

@@ -302,7 +302,7 @@ void automapShow(bool isInGame, bool isUsingScanner)
     unsigned char* frmData[AUTOMAP_FRM_COUNT];
     CacheEntry* frmHandle[AUTOMAP_FRM_COUNT];
     for (int index = 0; index < AUTOMAP_FRM_COUNT; index++) {
-        int fid = buildFid(6, frmIds[index], 0, 0, 0);
+        int fid = buildFid(OBJ_TYPE_INTERFACE, frmIds[index], 0, 0, 0);
         frmData[index] = artLockFrameData(fid, 0, 0, &(frmHandle[index]));
         if (frmData[index] == NULL) {
             while (--index >= 0) {
@@ -482,7 +482,7 @@ static void automapRenderInMapWindow(int window, int elevation, unsigned char* b
             continue;
         }
 
-        int objectType = (object->fid & 0xF000000) >> 24;
+        int objectType = FID_TYPE(object->fid);
         unsigned char objectColor;
 
         if ((flags & AUTOMAP_IN_GAME) != 0) {
@@ -1048,7 +1048,7 @@ static void _decode_map_data(int elevation)
         if (object->tile != -1 && (object->flags & OBJECT_SEEN) != 0) {
             int contentType;
 
-            int objectType = (object->fid & 0xF000000) >> 24;
+            int objectType = FID_TYPE(object->fid);
             if (objectType == OBJ_TYPE_SCENERY && object->pid != PROTO_ID_0x2000158) {
                 contentType = 2;
             } else if (objectType == OBJ_TYPE_WALL) {