From 47d96bd21e0df408d9b3a5df52a8726d13f177e1 Mon Sep 17 00:00:00 2001 From: Jonas Kulla Date: Sat, 30 Nov 2013 16:35:37 +0100 Subject: [PATCH] README: Reflect recent audio changes --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f220099..52aa41a 100644 --- a/README.md +++ b/README.md @@ -41,17 +41,18 @@ To select this binding, run `qmake BINDING=BINDING_NULL` * libsigc++ * PhysFS * glew +* OpenAL * SDL2 * SDL2_image * SDL2_ttf +* SDL_sound * pixman -* sfml-system 2.0 -* sfml-audio 2.0 * zlib (only ruby bindings) (If no version specified, assume latest *development version*, ie. freshest one from git/hg/svn) -To run mkxp, you should have a graphics card capable of at least **OpenGL 2.0** with an up-to-date driver installed. +### Supported image/audio formats +These depend on the auxiliary libraries. For maximum RGSS compliance, build SDL2_image with png/jpg support, and SDL_sound with oggvorbis/wav/mp3 support. ### MRI binding: Place a recent version of ruby in the project folder, apply all patches from "patches/ruby" and build it. @@ -59,6 +60,8 @@ Place a recent version of ruby in the project folder, apply all patches from "pa ### mruby binding: Place a recent version of mruby in the project folder and build it. +To run mkxp, you should have a graphics card capable of at least **OpenGL 2.0** with an up-to-date driver installed. + ## Building mkxp employs Qt's qmake build system, so you'll need to install that beforehand. After cloning mkxp, run one of the above qmake calls, or simply `qmake` to select the default binding (currently MRI), then `make`. @@ -94,10 +97,10 @@ In the RMXP version of RGSS, fonts are loaded directly from system specific sear If a requested font is not found, no error is generated. Instead, a built-in font is used (currently "Liberation Sans"). -## What doesn't work +## What doesn't work (yet) -* Audio formats other than ogg/wav (this might change in the future) -* Audio "pitch" parameter +* midi and wma audio files +* Audio "pitch" parameter (OpenAL offers a cheap alternative by playing sound faster/slower) * The Win32API ruby class (for obvious reasons) * Restarting the game with F12 * Creating Bitmaps with sizes greater than the OpenGL texture size limit (around 8192 on modern cards)*