aboutsummaryrefslogtreecommitdiff
path: root/Src/external_dependencies/openmpt-trunk/README.md
diff options
context:
space:
mode:
authorJef <jef@targetspot.com>2024-09-24 08:54:57 -0400
committerJef <jef@targetspot.com>2024-09-24 08:54:57 -0400
commit20d28e80a5c861a9d5f449ea911ab75b4f37ad0d (patch)
tree12f17f78986871dd2cfb0a56e5e93b545c1ae0d0 /Src/external_dependencies/openmpt-trunk/README.md
parent537bcbc86291b32fc04ae4133ce4d7cac8ebe9a7 (diff)
downloadwinamp-20d28e80a5c861a9d5f449ea911ab75b4f37ad0d.tar.gz
Initial community commit
Diffstat (limited to 'Src/external_dependencies/openmpt-trunk/README.md')
-rw-r--r--Src/external_dependencies/openmpt-trunk/README.md86
1 files changed, 86 insertions, 0 deletions
diff --git a/Src/external_dependencies/openmpt-trunk/README.md b/Src/external_dependencies/openmpt-trunk/README.md
new file mode 100644
index 00000000..c360b99a
--- /dev/null
+++ b/Src/external_dependencies/openmpt-trunk/README.md
@@ -0,0 +1,86 @@
+
+README
+======
+
+
+OpenMPT and libopenmpt
+======================
+
+This repository contains OpenMPT, a free Windows/Wine-based
+[tracker](https://en.wikipedia.org/wiki/Music_tracker) and libopenmpt,
+a library to render tracker music (MOD, XM, S3M, IT MPTM and dozens of other
+legacy formats) to a PCM audio stream. libopenmpt is directly based on OpenMPT,
+offering the same playback quality and format support, and development of the
+two happens in parallel.
+
+
+License
+-------
+
+The OpenMPT/libopenmpt project is distributed under the *BSD-3-Clause* License.
+See [LICENSE](LICENSE) for the full license text.
+
+Files below the `include/` (external projects) and `contrib/` (related assets
+not directly considered integral part of the project) folders may be subject to
+other licenses. See the respective subfolders for license information. These
+folders are not distributed in all source packages, and in particular they are
+not distributed in the Autotools packages.
+
+
+How to compile
+--------------
+
+
+### OpenMPT
+
+ - Supported Visual Studio versions:
+
+ - Visual Studio 2017, 2019, and 2022 Community/Professional/Enterprise
+
+ To compile the project, open `build/vsVERSIONwin7/OpenMPT.sln` (VERSION
+ being 2017, 2019, or 2022) and hit the compile button. Other target
+ systems can be found in the `vs2017*`, `vs2019*`, and `vs2022*` sibling
+ folders.
+
+ Note that you have to build the `PluginBridge` and `PluginBridgeLegacy`
+ projects manually for architectures other than the one you are building
+ OpenMPT for, as Visual Studio only builds one architecture configuration
+ at a time.
+
+ Please note that we do not support building with a later Visual Studio
+ installation with an earlier compiler version. This is because, while
+ later Visual Studio versions allow installing earlier compilers to be
+ available via the later version's environment, in this configuration,
+ the earlier compiler will still use the later C and C++ runtime's
+ headers and implementation, which significantly increases the matrix of
+ possible configurations to test.
+
+ - OpenMPT requires the compile host system to be Windows 8.1 (or later) amd64,
+ or Windows 11 (or later) ARM64.
+
+ - In order to build OpenMPT for Windows XP, the Visual Studio 2017 XP
+ targetting toolset as well as the Windows 8.1 SDK need to be installed. The
+ SDK is optionally included with Visual Studio 2017, but must be separately
+ installed with later Visual Studio versions.
+
+ The Windows 8.1 SDK is available from
+ <https://developer.microsoft.com/en-us/windows/downloads/sdk-archive/> or
+ directly from
+ <https://download.microsoft.com/download/B/0/C/B0C80BA3-8AD6-4958-810B-6882485230B5/standalonesdk/sdksetup.exe>
+ .
+
+ - Microsoft Foundation Classes (MFC) are required to build OpenMPT.
+
+
+### libopenmpt and openmpt123
+
+See [Dependencies](libopenmpt/dox/dependencies.md) and
+[Getting Started](libopenmpt/dox/gettingstarted.md).
+
+
+Contributing to OpenMPT/libopenmpt
+----------------------------------
+
+
+See [contributing](doc/contributing.md).
+