From 273eff5563a583c2e562637cf4ed881984203f18 Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Tue, 20 Jan 2026 16:06:25 -0800
Subject: [PATCH] Updated package support files for Android and Windows
---
.../android/{README.md.in => INSTALL.md.in} | 162 +++++++++---------
build-scripts/pkg-support/mingw/INSTALL.md.in | 48 ++++++
build-scripts/pkg-support/msvc/INSTALL.md.in | 41 +++++
.../pkg-support/msvc/arm64/INSTALL.md.in | 15 ++
.../pkg-support/msvc/x64/INSTALL.md.in | 15 ++
.../pkg-support/msvc/x86/INSTALL.md.in | 15 ++
build-scripts/release-info.json | 24 +--
7 files changed, 233 insertions(+), 87 deletions(-)
rename build-scripts/pkg-support/android/{README.md.in => INSTALL.md.in} (61%)
create mode 100644 build-scripts/pkg-support/mingw/INSTALL.md.in
create mode 100644 build-scripts/pkg-support/msvc/INSTALL.md.in
create mode 100644 build-scripts/pkg-support/msvc/arm64/INSTALL.md.in
create mode 100644 build-scripts/pkg-support/msvc/x64/INSTALL.md.in
create mode 100644 build-scripts/pkg-support/msvc/x86/INSTALL.md.in
diff --git a/build-scripts/pkg-support/android/README.md.in b/build-scripts/pkg-support/android/INSTALL.md.in
similarity index 61%
rename from build-scripts/pkg-support/android/README.md.in
rename to build-scripts/pkg-support/android/INSTALL.md.in
index 10cbd4e3c..68a11930e 100644
--- a/build-scripts/pkg-support/android/README.md.in
+++ b/build-scripts/pkg-support/android/INSTALL.md.in
@@ -1,77 +1,85 @@
-
-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 := @<@PROJECT_NAME@>@
-```
-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>
+
+# Using this package
+
+This package contains @<@PROJECT_NAME@>@ built for the Android platform.
+
+## 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 := @<@PROJECT_NAME@>@
+```
+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.
+
+# Documentation
+
+An API reference and additional documentation is available at:
+
+https://wiki.libsdl.org/@<@PROJECT_NAME@>@
+
+# Discussions
+
+## Discord
+
+You can join the official Discord server at:
+
+https://discord.com/invite/BwpFGBWsv8
+
+## Forums/mailing lists
+
+You can join SDL development discussions at:
+
+https://discourse.libsdl.org/
+
+Once you sign up, you can use the forum through the website or as a mailing list from your email client.
+
+## Announcement list
+
+You can sign up for the low traffic announcement list at:
+
+https://www.libsdl.org/mailing-list.php
+
diff --git a/build-scripts/pkg-support/mingw/INSTALL.md.in b/build-scripts/pkg-support/mingw/INSTALL.md.in
new file mode 100644
index 000000000..b5621a8e2
--- /dev/null
+++ b/build-scripts/pkg-support/mingw/INSTALL.md.in
@@ -0,0 +1,48 @@
+
+# Using this package
+
+This package contains @<@PROJECT_NAME@>@ built for the mingw-w64 toolchain.
+
+The files for 32-bit architecture are in i686-w64-mingw32
+The files for 64-bit architecture are in x86_64-w64-mingw32
+
+You can install them to another location, just type `make` for help.
+
+To use this package, install the latest SDL3 package, point your include path at _arch_/include and your library path at _arch_/lib, link with the @<@PROJECT_NAME@>@ library and copy _arch_/bin/@<@PROJECT_NAME@>@.dll next to your executable.
+
+e.g.
+```sh
+gcc -o hello.exe hello.c -Ix86_64-w64-mingw32/include -Lx86_64-w64-mingw32/lib -l@<@PROJECT_NAME@>@ -lSDL3
+cp x86_64-w64-mingw32/bin/@<@PROJECT_NAME@>@.dll .
+cp _SDL3_INSTALL_PATH_/bin/SDL3.dll .
+./hello.exe
+```
+
+# Documentation
+
+An API reference and additional documentation is available at:
+
+https://wiki.libsdl.org/@<@PROJECT_NAME@>@
+
+# Discussions
+
+## Discord
+
+You can join the official Discord server at:
+
+https://discord.com/invite/BwpFGBWsv8
+
+## Forums/mailing lists
+
+You can join SDL development discussions at:
+
+https://discourse.libsdl.org/
+
+Once you sign up, you can use the forum through the website or as a mailing list from your email client.
+
+## Announcement list
+
+You can sign up for the low traffic announcement list at:
+
+https://www.libsdl.org/mailing-list.php
+
diff --git a/build-scripts/pkg-support/msvc/INSTALL.md.in b/build-scripts/pkg-support/msvc/INSTALL.md.in
new file mode 100644
index 000000000..721564655
--- /dev/null
+++ b/build-scripts/pkg-support/msvc/INSTALL.md.in
@@ -0,0 +1,41 @@
+
+# Using this package
+
+This package contains @<@PROJECT_NAME@>@ built for Visual Studio.
+
+To use this package, edit your project properties:
+- Add the include directory to "VC++ Directories" -> "Include Directories"
+- Add the lib/_arch_ directory to "VC++ Directories" -> "Library Directories"
+- Add @<@PROJECT_NAME@>@.lib to Linker -> Input -> "Additional Dependencies"
+- Copy lib/_arch_/@<@PROJECT_NAME@>@.dll to your project directory.
+
+You can include support for additional audio formats by including the license and DLL files in the lib/_arch_/optional directory in your application. They will be automatically loaded by SDL_mixer as needed.
+
+# Documentation
+
+An API reference and additional documentation is available at:
+
+https://wiki.libsdl.org/@<@PROJECT_NAME@>@
+
+# Discussions
+
+## Discord
+
+You can join the official Discord server at:
+
+https://discord.com/invite/BwpFGBWsv8
+
+## Forums/mailing lists
+
+You can join SDL development discussions at:
+
+https://discourse.libsdl.org/
+
+Once you sign up, you can use the forum through the website or as a mailing list from your email client.
+
+## Announcement list
+
+You can sign up for the low traffic announcement list at:
+
+https://www.libsdl.org/mailing-list.php
+
diff --git a/build-scripts/pkg-support/msvc/arm64/INSTALL.md.in b/build-scripts/pkg-support/msvc/arm64/INSTALL.md.in
new file mode 100644
index 000000000..80078670a
--- /dev/null
+++ b/build-scripts/pkg-support/msvc/arm64/INSTALL.md.in
@@ -0,0 +1,15 @@
+
+# Using this package
+
+This package contains @<@PROJECT_NAME@>@ built for arm64 Windows.
+
+To use this package, simply replace an existing 64-bit ARM @<@PROJECT_NAME@>@.dll with the one included here.
+
+You can include support for additional audio formats by including the license and DLL files in the optional directory in your application. They will be automatically loaded by SDL_mixer as needed.
+
+# Development packages
+
+If you're looking for packages with headers and libraries, you can download one of these:
+- @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-VC.zip, for development using Visual Studio
+- @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-mingw.zip, for development using mingw-w64
+
diff --git a/build-scripts/pkg-support/msvc/x64/INSTALL.md.in b/build-scripts/pkg-support/msvc/x64/INSTALL.md.in
new file mode 100644
index 000000000..585d24390
--- /dev/null
+++ b/build-scripts/pkg-support/msvc/x64/INSTALL.md.in
@@ -0,0 +1,15 @@
+
+# Using this package
+
+This package contains @<@PROJECT_NAME@>@ built for x64 Windows.
+
+To use this package, simply replace an existing 64-bit @<@PROJECT_NAME@>@.dll with the one included here.
+
+You can include support for additional audio formats by including the license and DLL files in the optional directory in your application. They will be automatically loaded by SDL_mixer as needed.
+
+# Development packages
+
+If you're looking for packages with headers and libraries, you can download one of these:
+- @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-VC.zip, for development using Visual Studio
+- @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-mingw.zip, for development using mingw-w64
+
diff --git a/build-scripts/pkg-support/msvc/x86/INSTALL.md.in b/build-scripts/pkg-support/msvc/x86/INSTALL.md.in
new file mode 100644
index 000000000..0e975a3a3
--- /dev/null
+++ b/build-scripts/pkg-support/msvc/x86/INSTALL.md.in
@@ -0,0 +1,15 @@
+
+# Using this package
+
+This package contains @<@PROJECT_NAME@>@ built for x86 Windows.
+
+To use this package, simply replace an existing 32-bit @<@PROJECT_NAME@>@.dll with the one included here.
+
+You can include support for additional audio formats by including the license and DLL files in the optional directory in your application. They will be automatically loaded by SDL_mixer as needed.
+
+# Development packages
+
+If you're looking for packages with headers and libraries, you can download one of these:
+- @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-VC.zip, for development using Visual Studio
+- @<@PROJECT_NAME@>@-devel-@<@PROJECT_VERSION@>@-mingw.zip, for development using mingw-w64
+
diff --git a/build-scripts/release-info.json b/build-scripts/release-info.json
index 27309662e..1a46865b0 100644
--- a/build-scripts/release-info.json
+++ b/build-scripts/release-info.json
@@ -3,7 +3,7 @@
"remote": "libsdl-org/SDL_mixer",
"dependencies": {
"SDL": {
- "startswith": "3.",
+ "startswith": "3.4",
"repo": "libsdl-org/SDL"
}
},
@@ -60,10 +60,10 @@
},
"files": {
"": [
- "CHANGES.txt",
+ "build-scripts/pkg-support/mingw/INSTALL.md.in:INSTALL.md",
+ "build-scripts/pkg-support/mingw/Makefile",
"LICENSE.txt",
- "README.txt",
- "build-scripts/pkg-support/mingw/Makefile"
+ "README.md",
],
"cmake": [
"build-scripts/pkg-support/mingw/cmake/SDL3_mixerConfig.cmake",
@@ -188,14 +188,16 @@
},
"files-lib": {
"": [
- "README.txt"
+ "build-scripts/pkg-support/msvc/@<@ARCH@>@/INSTALL.md.in:INSTALL.md",
+ "LICENSE.txt",
+ "README.md"
]
},
"files-devel": {
"": [
- "CHANGES.txt",
+ "build-scripts/pkg-support/msvc/INSTALL.md.in:INSTALL.md",
"LICENSE.txt",
- "README.txt"
+ "README.md"
],
"cmake": [
"build-scripts/pkg-support/msvc/cmake/SDL3_mixerConfig.cmake.in:SDL3_mixerConfig.cmake",
@@ -267,8 +269,8 @@
"x86",
"x86_64"
],
- "api-minimum": 19,
- "api-target": 29,
+ "api-minimum": 21,
+ "api-target": 35,
"ndk-minimum": 28,
"aar-files": {
"": [
@@ -286,7 +288,9 @@
},
"files": {
"": [
- "build-scripts/pkg-support/android/README.md.in:README.md"
+ "build-scripts/pkg-support/android/INSTALL.md.in:INSTALL.md",
+ "LICENSE.txt",
+ "README.md"
]
},
"dependencies": {