Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
faithvoid authored Oct 6, 2021
1 parent 376422d commit 9212bff
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<img src="https://raw.githubusercontent.com/zturtleman/lilium-voyager/master/misc/lilium.png" width="64">

**Lilium Voyager** is a fork of [ioquake3](https://github.com/ioquake/ioq3) for running _Star Trek Voyager: Elite Force Holomatch_ (multiplayer). It is based on Thilo Schulz' [ioEF engine](http://thilo.tjps.eu/efport-progress/) (also known as iostvoyHM). The focus for Lilium Voyager is to maintain Elite Force multiplayer support on newer ioquake3 versions.
**VoyagerNX** is a port of **Tulip Voyager**, a fork of **Lilium Voyager** which is a fork of [ioquake3](https://github.com/ioquake/ioq3) for running _Star Trek Voyager: Elite Force Holomatch_ (multiplayer). It is based on Thilo Schulz' [ioEF engine](http://thilo.tjps.eu/efport-progress/) (also known as iostvoyHM). The focus for Lilium Voyager is to maintain Elite Force multiplayer support on newer ioquake3 versions.

Differences from ioEF 1.38-rc1 (2011):

Expand All @@ -17,11 +17,21 @@ Lilium Voyager code commits: [compare/upstream...master](https://github.com/ztur

The source code for the Elite Force game, cgame, and ui code is not included as it remains under a non-free license.

## Installation
- Download latest release files
- Copy to /switch/ folder on your SD card, along with the baseEF folder from Holomatch (which can be acquired legally for free from holomat.ch). **Do not overwrite any files!**
- Launch via regular HBMenu (NOT Applet mode!)

## Bugs
- Sleep mode crashes the game and sometimes Atmosphere. This has been reported in other ioquake3 ports on the Switch (ie; iortcw), so I'm not sure where to begin diagnosing the issue.
- Solo Match leads to a softlock at the end of every match. This can be worked around by using "Multi Match" to create a bot match instead. If you end up softlocked, you can close the game by pressing Down to open a terminal, pressing L to bring up a virtual keyboard, typing "/quit", pressing Return, then pressing Enter twice, which should get you back to HBMenu.

## Compiling

Lilium Voyager is compiled using `make`. For details see [building ioquake3](http://wiki.ioquake3.org/Building_ioquake3) and the [ioquake3 readme](README-ioq3.md).

To compile VoyagerNX, make sure your DevKitPro environment is properly set up and run "make -f Makefile.nx"

The Visual Studio project files are not supported.

Additional make variables not in ioquake3:
Expand All @@ -45,9 +55,13 @@ Lilium Voyager is licensed under [the GNU GPLv2](COPYING.txt) (or at your option
* ioquake3 - ioquake3 contributors
* ioEF - Thilo Schulz & contributers
* Lilium Voyager - Zack Middleton
* Tulip Voyager - Daggolin


## Contributing

Please submit all patches as a GitHub pull request.

## TODO

- Add gyroscope support (the gyroscope controls from ioquake3-nx seem to throw tons of errors when attempting to compile them).

0 comments on commit 9212bff

Please sign in to comment.