diff --git a/README.md b/README.md new file mode 100644 index 00000000..4b3470ad --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ + + +**Lilium Voyager** is a fork of [ioquake3](https://github.com/ioquake/ioq3) for running _Star Trek Voyager: Elite Force_ multiplayer. It is based on Thilo Schulz' [iostvef engine](http://thilo.kickchat.com/efport-progress/). The focus for Lilium Voyager is to maintain Elite Force multiplayer support on newer ioquake3 versions. + +Differences from iostvef 1.38; + + * Better compatibility with newer operating systems (from ioq3). + * VoIP uses Opus codec instead of Speex (from ioq3). + * Player origin rounding is compatible with the original QVMs. + * Network compatible with iostvef 1.37. + * Support for ioquake3's OpenGL2 renderer. + +Lilium Voyager code commits: [compare/upstream...master](https://github.com/zturtleman/lilium-voyager/compare/upstream...master) + +The source code for the Elite Force game, cgame, and ui code is not included as it remains under a non-free license. + + +## Compiling + +Lilium Voyager is compiled using `make`. For details see [building ioquake3](http://wiki.ioquake3.org/Building_ioquake3). + +The Visual Studio project files are not supported. + + +## Discussion + +[Magical Clover Forum](https://forum.clover.moe). It supports creating an account or logging in using a GitHub account. + + +## License + +Lilium Voyager is licensed under [the GNU GPLv2](COPYING.txt) (or at your option, any later version). + + +## Credits + +* Quake 3 - id Software +* ioquake3 - ioquake3 contributors +* [iostvef](http://thilo.kickchat.com/efport-progress/) - Thilo Schulz & contributers +* Lilium Voyager - Zack Middleton + + +## Contributing + +Please submit all patches at the [Magical Clover Forum](https://forum.clover.moe) +or as a GitHub pull request. +