Implement custom save locations for Android and Desktop (#3160)

* Implement custom save locations for Android and Desktop

* Request write permission to save to external storage

* Fix race condition for custom saves/loads caused by autosaves

* Remove unnecessary WRITE_EXTERNAL_STORAGE permission for saving files

* Fix padding for custom save/load location buttons

* Use nullability checks as defined in coding style guide

* Use nullability checks as defined in coding style guide

* Use early return for readability

* Rename save/load completion callbacks for custom locations and implement error handling

.github/ISSUE_TEMPLATE/feature_request.md

@@ -2,7 +2,7 @@
 name: Feature request
 about: Suggest an idea for this project
 title: ''
-labels: 'add new feature'
+labels: 'feature'
 assignees: ''
 
 ---

.gitignore

@@ -68,6 +68,7 @@ com_crashlytics_export_strings.xml
 /html/build/
 /ios/build/
 /ios-moe/build/
+/buildSrc/build
 
 /nbbuild/
 /android/nbbuild/
@@ -101,13 +102,6 @@ nb-configuration.xml
 /local.properties
 .gradle/
 gradle-app.setting
-/build/
-/android/build/
-/core/build/
-/desktop/build/
-/html/build/
-/ios/build/
-/ios-moe/build/
 
 ## OS Specific
 .DS_Store
@@ -123,7 +117,6 @@ Thumbs.db
 !/ios-moe/xcode/*.xcodeproj/xcshareddata
 !/ios-moe/xcode/*.xcodeproj/project.pbxproj
 /ios-moe/xcode/native/
-gradle.properties
 SaveFiles/
 android/android-release.apk
 android/assets/GameSettings.json
@@ -140,3 +133,8 @@ desktop/packr/
 desktop/packrCache/
 deploy/
 android/release/
+
+android/assets/mods/
+android/assets/SaveFiles/
+android/assets/GameSettingsOld.json
+android/assets/scenarios/

.travis.yml

@@ -27,13 +27,21 @@ script:
 - ./gradlew check
 - ./gradlew tests:test  
 - if [ -n "$TRAVIS_TAG" ]; then
-    wget  -O jdk-windows.zip https://github.com/ojdkbuild/ojdkbuild/releases/download/java-1.8.0-openjdk-1.8.0.232-1.b09/java-1.8.0-openjdk-1.8.0.232-1.b09.ojdkbuild.windows.x86_64.zip;
+    wget -O jdk-windows-64.zip https://github.com/ojdkbuild/ojdkbuild/releases/download/java-1.8.0-openjdk-1.8.0.232-1.b09/java-1.8.0-openjdk-1.8.0.232-1.b09.ojdkbuild.windows.x86_64.zip  > /dev/null;
+    wget -O jdk-windows-32.zip https://github.com/ojdkbuild/ojdkbuild/releases/download/java-1.8.0-openjdk-1.8.0.252-2.b09-x86/java-1.8.0-openjdk-1.8.0.252-2.b09.ojdkbuild.windows.x86.zip > /dev/null;
+    wget -O butler.zip https://broth.itch.ovh/butler/linux-amd64/LATEST/archive/default > /dev/null;
+    unzip butler.zip;
+    chmod +x butler;
+    ./butler -V;
     ./gradlew desktop:packrWindows32;
+    ./butler push deploy/Unciv-Windows32.zip yairm210/unciv:Windows32 --userversion $TRAVIS_TAG;
     ./gradlew desktop:packrWindows64;
+    ./butler push deploy/Unciv-Windows64.zip yairm210/unciv:Windows64 --userversion $TRAVIS_TAG;
     ./gradlew desktop:packrLinux32;
+    ./butler push deploy/Unciv-Linux32.zip yairm210/unciv:Linux32     --userversion $TRAVIS_TAG;
     ./gradlew desktop:packrLinux64;
+    ./butler push deploy/Unciv-Linux64.zip yairm210/unciv:Linux64     --userversion $TRAVIS_TAG;
     ./gradlew desktop:zipLinuxFilesForJar;
-    ./gradlew android:assembleRelease;
   fi
     
 deploy:
@@ -49,7 +57,6 @@ deploy:
     - deploy/Unciv-Windows32.zip
     - deploy/Unciv-Windows64.zip
     - deploy/linuxFilesForJar.zip
-    - android/build/outputs/apk/release/Unciv-release-unsigned.apk
   on:
     repo: yairm210/Unciv
     tags: true

README.md

@@ -1,18 +1,16 @@
 # Unciv - Civ V for Android (+Desktop)
 
-![](https://lh3.googleusercontent.com/l8fuQ2DnNjoD9pFnHLsli1xt8OClfr6O9GSBJJ9w7IIb2VHOyxqKZ9lNZXtMqOabCfyI=w1920-h867-rw)
+![](/extraImages/GithubPreviewImage.png)
 
-
-[![Google Play](https://img.shields.io/badge/Google-Play-black.svg)](https://play.google.com/store/apps/details?id=com.unciv.app)
+[![Google Play](https://img.shields.io/static/v1?label=Google&message=Play&color=607D8B&logo=google-play)](https://play.google.com/store/apps/details?id=com.unciv.app)
 [![F-Droid](https://img.shields.io/f-droid/v/com.unciv.app)](https://f-droid.org/en/packages/com.unciv.app/)
+[![itch.io](https://img.shields.io/static/v1?label=itch.io&message=Unciv&color=607D8B&logo=itch.io)](https://yairm210.itch.io/unciv)
 
 [![Travis CI w/ Logo](https://img.shields.io/travis/yairm210/UnCiv/master.svg?logo=travis)](https://travis-ci.org/yairm210/UnCiv)
 [![Discord Chat](https://img.shields.io/discord/586194543280390151.svg)](https://discord.gg/bjrB4Xw)
 
 [![LibGDX](https://img.shields.io/badge/libgdx-1.9.10-red.svg)](https://libgdx.badlogicgames.com/)
-[![Kotlin](https://img.shields.io/badge/kotlin-1.3.50-orange.svg)](http://kotlinlang.org/)
-
-
+[![Kotlin](https://img.shields.io/badge/kotlin-1.3.710-0095D5.svg?logo=kotlin)](http://kotlinlang.org/)
 
 
 # What is this?
@@ -27,11 +25,7 @@ Is this order:
 * Polish! As you may have noticed, Unciv is fully functional but rough around the edges. This means:
     * UI+UX improvements (suggestions welcome!)
     * Better automation, AI etc. in-game
-* Development and distribution cycle
-   * Automated tests - done!
-   * Automated F-droid and Google Play version deployment - done!
-   * Standalone Desktop executables - done!
-   * Maybe Itch.io?
+* Development and distribution cycle - Done! (tests, f-droid/Google Play/itch.io deployment)
 * Missing features from Vanilla - Natural wonders (done!), city-state quests, missing civs etc.
 * G&K mechanics - religion, faith etc.
 * BNW mechanics - trade routes etc.
@@ -40,17 +34,16 @@ Is this order:
 
 ## How can I help?
 
-If you're a programmer, get started at [here!](https://github.com/yairm210/Unciv/wiki/Getting-Started)
+Programmers start [here!](https://github.com/yairm210/Unciv/wiki/Getting-Started)
 
-If you want to help with the translation, get started [here!](https://github.com/yairm210/Unciv/wiki/Translating)
+Translators start [here!](https://github.com/yairm210/Unciv/wiki/Translating)
+
+Modders start [here!](https://github.com/yairm210/Unciv/wiki/Mods)
 
 You can join us in any of the open issue, or work on improving anything you want - once you're finished, issue a pull request and it'll go into the next version!
 
 If not, you can help by spreading the word - vote for Unciv where you can, mention it on Reddit or Twitter etc, and help us with new ideas of how to get the word out!
 
-If you REALLY want to donate for some reason, I have a Patreon page [here!](https://www.patreon.com/yairm210)
-        
-If you want to mod, see [here!](https://github.com/yairm210/Unciv/wiki/Mods)
 
 # FAQ
 
@@ -66,15 +59,17 @@ If not, then the feature won't be added until we've finished all the features fr
 
 THE most common request, hands down. Everyone wants their favorite Civ in the game, I get that. But there are so many other things to work on - automations, AI, UI, graphics, bugs, and of course other features from the original game that are currently missing. Eventually we'll have them all, but the key word is "eventually".
 
+In the meantime, you can [mod it yourself!](https://github.com/yairm210/Unciv/wiki/Mods)
+
 ## Will you implement Civ VI?
 
-Maybe, once we've finished with all of Civ V. But considering how long it took to get this far, Civ VII may be out by then.
+Considering how long it took to get this far, no.
 
 ## Is there a desktop version?
 
-There are standalone zip files for each operating system in [Releases](https://github.com/yairm210/UnCiv/releases) which contain everything needed for Unciv to run
+Yes! Windows and Linux versions are available at [itch.io](https://yairm210.itch.io/unciv), and if you're using the Itch app, your game will stay up-to-date - and we release pretty frequently so that's an issue ;)
 
-If you have Java 8, and are familiar with the command line, there are (considerably smaller) JARs in [Releases](https://github.com/yairm210/UnCiv/releases) which you can run with `java -jar Unciv.jar`
+If you have Java 8, and are familiar with the command line, there are (considerably smaller) JARs in [Releases](https://github.com/yairm210/UnCiv/releases) which you can run with `java -jar Unciv.jar`. This is also (currently) the only way to run the game on MacOS.
 
 Be aware that the game will generate files inside the folder where the Jar is located!
 
@@ -94,11 +89,29 @@ Building: `./gradlew desktop:dist`
 
 If the terminal returns `Permission denied` or `Command not found` on Mac/Linux, run `chmod +x ./gradlew` first. *This is a one-time procedure.*
 
+If you get an error that Android SDK folder wasn't found, firstly install it by doing in terminal:
+
+`sudo apt update && sudo apt install android-sdk` (Debian, Ubuntu, Mint etc.)
+
+After that you should put its folder to the file `local.properties` by adding this line:
+
+`sdk.dir = /path/to/android/sdk` which can be `/usr/lib/android-sdk` or something other.
+
+If during the first launch it throws an error that the JDK version is wrong try [this JDK installation](https://www.azul.com/downloads/zulu-community/?package=jdk).
+
 Gradle may take up to several minutes to download files. Be patient.
 After building, the output .JAR file should be in /desktop/build/libs/Unciv.jar
 
 For actual development, you'll probably need to download Android Studio and build it yourself - see Contributing :)
 
+
+## How about IOS?
+
+I'm not planning on it.
+
+It means paying money to Apple, yet another release path,
+ and since I don't have an IOS device it means I can't test it properly.
+
 ## How can I learn to play? Where's the wiki?
 
 All the tutorial information is available in-game at menu > civilopedia > tutorials
@@ -109,5 +122,23 @@ Since this is a Civ V clone, you can search Google for how to play Civ V and the
 
 Alternatively, you could [join us on Discord](https://discord.gg/bjrB4Xw) and ask there =D
 
+## Aren't you basically making a Civ V clone? Is that even legal?
+
+This is a subject that I've heard a lot of hearsay on but no solid sources of law.
+
+From what I gather, it is illegal:
+ - To use the Civilization name
+ - To impersonate the Civ games (so calling yourself civi|zation with a similar logo, for instance)
+ - To use any assets from the original game (images, sound etc) - they belong to Firaxis
+
+From what I understand, intellectual property rights apply to names, characters and settings. They do not apply to mechanics - as I'm sure you know, there are a billion Flappy Bird knockoffs
+
+If anyone has any real legal sources, or can shed some light on the limits of what is and is not allowed, I'd be happy to hear!
+
+## Disclosure
+
+Multiplayer takes advantage of Dropbox, which is *non-free software*, for syncing purposes.
+
+Single player does not use this feature.
 
 # [Credits and 3rd parties](docs/Credits.md)

android/AndroidManifest.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
     package="com.unciv.app" >
 
     <uses-sdk/>
@@ -14,15 +15,17 @@
         android:theme="@style/GdxTheme" >
         <activity
             android:name="com.unciv.app.AndroidLauncher"
+            android:launchMode="singleTask"
             android:label="@string/app_name"
             android:screenOrientation="userLandscape"
-            android:configChanges="keyboard|keyboardHidden|orientation|screenSize">
+            android:configChanges="keyboard|keyboardHidden|orientation|screenSize"
+            tools:ignore="LockedOrientationActivity">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
-
         </activity>
+        <receiver android:name=".CopyToClipboardReceiver"  android:exported="false" />
     </application>
 
 </manifest>