Fixed conflict
[camargo/neiasound.git] / README.md
1 # neiasound #
2
3 ### Introduction ###
4
5 neiasound is a Qt-style OpenAL wrapper for games. Not yet complete but already very useful.
6 It is a clean, convenient api that can be plugged directly into your main loop.
7 It comes with a (very primitive) .wav file reader, and includes [stb_vorbis](http://nothings.org/stb_vorbis/) directly in the source tree. Also supports [libsndfile](http://www.mega-nerd.com/libsndfile/).
8
9 There is also support for streaming dynamic playlists with intros and seamless looping.
10
11 ### How do I get set up? ###
12
13 All you need is to add the relevant source files into your project source lists.
14 It is a good idea to cherry-pick only the nSoundStreamer implementations you actually use.
15 The Wave and stb_vorbis streams are enough in most cases, so the only hard dependencies are OpenAL itself and Qt. libsndfile is optional, but it's there if you need flac or one of the many formats it supports.
16 On Android projects, it is compatible with the standard OpenAL Soft port, and OpenAL-MOB. I recommend OpenAL-MOB for a better experience and reduced latency. If you disable HRTFs, I suspect performance is the same or better.
17
18 Do note that this a Qt library, and the sources need to go through moc when included directly.
19
20 ### Who do I talk to? ###
21
22 If you run into any problems, I (lpcamargo) will be most pleased to help!