README.android
author Sam Lantinga <slouken@libsdl.org>
Thu, 06 Jan 2011 16:11:21 -0800
changeset 4964 6c645018741e
parent 4954 144d9df7e611
child 4965 91d0085b7560
permissions -rw-r--r--
Build the SDL library as a shared object on Android, so it will work correctly with SDL_image and SDL_ttf.

================================================================================
Simple DirectMedia Layer for Android
================================================================================

Requirements: Android SDK and Android NDK r4 or later
http://developer.android.com/

================================================================================
 How the port works
================================================================================

- Android applications are Java-based, optionally with parts written in C
- As SDL apps are C-based, we use a small Java shim that uses JNI to talk to 
the SDL library
- This means that your application C code must be placed inside an android 
Java project, along with some C support code that communicates with Java
- This eventually produces a standard Android .apk package


================================================================================
 Building an app
================================================================================

Instructions:
1. Copy the android-project directory wherever you want your Android project to go
2. Move this SDL directory into the <project>/jni directory
3. Place your application source files in the <project>/jni/src directory
4. Edit <project>/jni/src/Android.mk to include your source files
5. Run 'ndk-build' (a script provided by the NDK). This compiles the C source

If you want to use the Eclipse IDE, skip to the Eclipse section below.

6. Edit <project>/local.properties to point to the Android SDK directory
7. Run 'ant debug' in android/project. This compiles the .java and eventually 
creates a .apk with the native code embedded
8. 'ant install' will push the apk to the device or emulator (if connected)


================================================================================
 Using Eclipse
================================================================================

NEED CONTENT


================================================================================
 Loading files
================================================================================

NEED CONTENT


================================================================================
 Troubleshooting
================================================================================

NEED CONTENT


================================================================================
 Known issues
================================================================================

- SDL audio (although it's mostly written, just not working properly yet)
- TODO. I'm sure there's a bunch more stuff I haven't thought of