mirror of
https://github.com/libsdl-org/SDL.git
synced 2025-05-27 23:19:11 +00:00
|
||
---|---|---|
.. | ||
aar | ||
README.md.in |
The Simple DirectMedia Layer (SDL for short) is a cross-platform library designed to make it easy to write multi-media software, such as games and emulators. The Simple DirectMedia Layer library source code is available from: https://www.libsdl.org/ This library is distributed under the terms of the zlib license: http://www.zlib.net/zlib_license.html # @<@PROJECT_NAME@>@-@<@PROJECT_VERSION@>@.aar This Android archive allows use of @<@PROJECT_NAME@>@ in your Android project, without needing to copy any SDL source. ## Gradle integration For integration with CMake/ndk-build, it uses [prefab](https://google.github.io/prefab/). Copy the aar archive (@<@PROJECT_NAME@>@-@<@PROJECT_VERSION@>@.aar) to a `app/libs` directory of your project. In `app/build.gradle` of your Android project, add: ``` android { /* ... */ buildFeatures { prefab true } } dependencies { implementation files('libs/@<@PROJECT_NAME@>@-@<@PROJECT_VERSION@>@.aar') /* ... */ } ``` If you're using CMake, add the following to your CMakeLists.txt: ``` find_package(@<@PROJECT_NAME@>@ REQUIRED CONFIG) target_link_libraries(yourgame PRIVATE @<@PROJECT_NAME@>@::@<@PROJECT_NAME@>@) ``` If you use ndk-build, add the following before `include $(BUILD_SHARED_LIBRARY)` to your `Android.mk`: ``` LOCAL_SHARED_LIBARARIES := SDL3 SDL3-Headers ``` And add the following at the bottom: ``` # https://google.github.io/prefab/build-systems.html # Add the prefab modules to the import path. $(call import-add-path,/out) # Import @<@PROJECT_NAME@>@ so we can depend on it. $(call import-module,prefab/@<@PROJECT_NAME@>@) ``` --- ## Other build systems (advanced) If you want to build a project without Gradle, running the following command will extract the Android archive into a more common directory structure. ``` python @<@PROJECT_NAME@>@-@<@PROJECT_VERSION@>@.aar -o android_prefix ``` Add `--help` for a list of all available options. Look at the example programs in ./examples (of the source archive), and check out online documentation: https://wiki.libsdl.org/SDL3/FrontPage Join the SDL discourse server if you want to join the community: https://discourse.libsdl.org/ That's it! Sam Lantinga <slouken@libsdl.org>