jwz@jwz.org
-To build:
+To set up your Android development environment:
Install JDK 7 (http://www.oracle.com/technetwork/java/javase/downloads/)
Install Android Studio (http://developer.android.com/sdk/)
On MacOS, the value you want is probably ~/Library/Android/sdk/
Also set "ndk.dir" in project/local.properties.
+To build:
+
+ ./configure
cd android
make
- If it fails, try a "make clean" and then try make again.
- Make sure you have the needed Android SDK platform versions installed.
-
Hopefully an "xscreensaver-debug.apk" file will appear in
android/project/xscreensaver/build/outputs/apk/.
Load that onto your device and go to:
- Settings / Display / Wallpaper / Live Wallpapers.
+ Settings / Display / Daydream
+ or just click on the XScreenSaver icon, which is a shortcut to that.
+
+ To create and configure an emulator image, use the GUI tool and and
+ give the emulator a name (say, "Nexus_5").
+
+ $ANDROID_HOME/sdk/tools/android avd
+
+ Configuration options are in $HOME/.android/avd/*.avd/config.ini
- To launch the emulator:
- $ANDROID_HOME/sdk/tools/emulator -avd Nexus_5_API_21_x86
+ To launch it:
- To load it into the currently-running emulator:
+ $ANDROID_HOME/sdk/tools/emulator -avd Nexus_5
+
+ Warning! On my system at least, the emulator runs out of memory
+ when trying to display the Daydream page if all of the savers are
+ loaded. This is troubling. You can work around this by editing
+ your *.avd/config.ini and setting vm.heapSize=128; or by editing
+ android/Makefile and paring down the $ANDROID_HACKS list to a
+ smaller subset (60 or so with the default heapSize).
+
+
+ To load it into the currently-running emulator or device:
$ANDROID_HOME/platform-tools/adb install -r \
project/xscreensaver/build/outputs/apk/xscreensaver-debug.apk
+ Extremely verbose log output, including stack traces:
+ $ANDROID_HOME/platform-tools/adb logcat
-The files in these subdirectories are source code, more or less:
+ Non-fatal log output for only this app:
+ $ANDROID_HOME/platform-tools/adb logcat \
+ -s xscreensaver:d AndroidRuntime:d libEGL:d
- project/xscreensaver/*.xml
- project/xscreensaver/src/org/jwz/xscreensaver/
- project/GLWallpaperService/ (a third-party library, unchanged)
+ Note that sometimes "logcat" will just sit there forever saying
+ "waiting for device". This is because the emulator is a piece of
+ shit and sometimes decides to just randomly not service connections.
+ If you restart the emulator, and wait minutes for the whole damned
+ thing to boot up again, it will probably work next time. Probably.
-These directories are boilerplate for Android apps:
- project/xscreensaver/res/layout/
- project/xscreensaver/res/values/
- project/xscreensaver/res/xml/
+Directory structure:
+
+ Boilerplate for the Java version of "make":
+ project/*gradle*
+ project/*.properties
+ project/xscreensaver/*gradle*
+ project/xscreensaver/build.*
+ project/xscreensaver/*.properties
+
+ The other half of the Makefile:
+ project/xscreensaver/jni/*.mk
+
+ Source code:
+ project/xscreensaver/src/org/jwz/xscreensaver/*.java
+ project/xscreensaver/res/layout/*.xml
+
+ Other relevant source code is in ../jwxyz/ and ../hacks/.
+
+ Icons:
project/xscreensaver/res/drawable-ldpi/
project/xscreensaver/res/drawable-mdpi/
- project/xscreensaver/res/drawable-hdpi/
- project/xscreensaver/res/drawable/thumbnail.png
+ project/xscreensaver/res/drawable/
-These are files that we generate:
+ Files that we generate:
- project/xscreensaver/src/org/jwz/xscreensaver/gen/
+ gen/function-table.h
+ project/xscreensaver/AndroidManifest.xml
+ project/xscreensaver/res/drawable/*.png
+ project/xscreensaver/res/values/settings.xml
+ project/xscreensaver/res/values/strings.xml
+ project/xscreensaver/res/xml/*.xml
+ project/xscreensaver/src/org/jwz/xscreensaver/gen/*.java
-These too (intermediate build files):
+ Other files generated as a part of the build process:
- .gradle/
gen/
- project/GLWallpaperService/build/
- project/build/
+ project/.gradle/
project/xscreensaver/build/
+ project/xscreensaver/build/outputs/apk/ -- app appears here
+ project/xscreensaver/jni/
project/xscreensaver/libs/
project/xscreensaver/obj/
+ project/xscreensaver/res/
+ project/xscreensaver/res/drawable/
+ project/xscreensaver/res/values/
project/xscreensaver/res/xml/
+ project/xscreensaver/src/org/jwz/xscreensaver/gen/
-These are files that we *will* generate but don't yet:
-
- project/xscreensaver/res/drawable/*.png
- XScreenSaverView.c
-
-When adding a new hack, edit:
-
- project/xscreensaver/jni/Android.mk
- project/xscreensaver/build.gradle
- generate_files.pl
+When adding a new hack, edit android/Makefile, then "make clean" and "make".
+
+
+TODO list, and known bugs:
+
+ - See the top of ../jwxyz/jwxyz-gl.c for a low level TODO list,
+ but here's what's wrong with the savers from a high level view:
+
+ - Rotation is wonky (on some devices?)
+
+ - The Android emulator is a piece of shit and crashes all the time,
+ so it's possible that some of these work fine on real devices.
+ I don't actually have an Android device, so I have no idea.
+
+ - As mentioned above, the Android emulator runs out of memory if
+ more than about 60 of the Daydreams are installed with the default
+ heapSize. Again, I don't know if this is an issue on real devices.
+ I sure hope not.
+
+ - The code that attempts to grab a screen shot before the Daydream begins
+ doesn't work.
+
+ - When a saver exits abnormally, we catch the exception and attempt to
+ display the error message in a dialog. The catch works, but the dialog
+ box does not.
+
+ anemone needs thick lines
+ anemotaxis needs thick lines
+ antinspect crashes emulator, sometimes
+ antmaze crashes emulator, sometimes
+ antspotlight crashes emulator, sometimes
+ apple2 text, images into pixmaps doesn't work
+ atlantis crashes emulator, sometimes
+ barcode pixmaps
+ binaryring pixmaps
+ blitspin images
+ bouboule ?
+ braid thick lines
+ bsod pixmaps, XCopyArea problems
+ bumps XPutImage
+ carousel blank
+ celtic thick lines
+ circuit crashes emulator
+ cityflow crashes emulator, sometimes
+ compass thick lines
+ crackberg crashes emulator, sometimes
+ cube21 crashes emulator, sometimes
+ cubenetic crashes emulator, sometimes
+ cubicgrid crashes emulator, sometimes
+ deluxe thick lines
+ dnalogo codeword is blank
+ dymaxionmap crashes emulator
+ endgame crashes emulator
+ engine text
+ epicycle thick lines
+ flipflop images
+ flipscreen3d images
+ fliptext text
+ fontglide text
+ fuzzyflakes thick lines
+ gflux images
+ glblur crashes emulator, sometimes
+ gleidescope images
+ glhanoi crashes emulator, but a few seconds in
+ glplanet crashes emulator
+ glslideshow images
+ goop polygons
+ halftone XFillArc crash
+ halo XOR
+ hypertorus crashes emulator
+ interaggregate window background should be white
+ jigglypuff incredibly slow
+ jigsaw crashes emulator
+ juggler3d crashes emulator
+ maze no logo, lines look weird
+ mirrorblob images
+ moebius crashes emulator
+ moire2 pixmaps
+ molecule crashes emulator
+ mountain polygons
+ munch XOR
+ noseguy pixmaps
+ pacman launches really slowly; fails at loading XPMs
+ pedal polygons
+ phosphor pixmaps
+ photopile pixmaps
+ pipes blank
+ polyhedra crashes emulator
+ polyominoes pixmaps
+ projectiveplane crashes emulator
+ pulsar crashes emulator
+ qix polygons
+ queens crashes emulator
+ rocks polygons
+ skytentacles crashes emulator
+ slip pixmaps
+ sonar crashes emulator
+ speedmine polygons
+ spheremonics crashes emulator
+ splitflap text
+ spotlight pixmaps
+ starfish polygons
+ starwars crashes emulator
+ substrate background should be white
+ surfaces crashes emulator
+ tessellimage pixmaps
+ truchet thick lines
+ twang background should be black
+ unicrud pixmaps
+ xanalogtv pixmaps
+ xjack blank
+ xmatrix pixmaps
+ xrayswarm thick lines
+ zoom pixmaps
projects / xscreensaver / blobdiff