yquake2remaster/doc/01_index.md
Yamagi Burmeister 5386e73af9 Add file listsings.
"What file goes were?" is an often asked question, so give a listing of
the complete kit. While at it provide checksums for the paks.
2019-04-03 21:17:13 +02:00

26 lines
1.1 KiB
Markdown

# Yamagi Quake II Documentation
Welcome to the Yamagi Quake II documentation. Here is documented how
Yamagi Quake II is installed and configured. Please make sure to read
through the whole guide before asking questions!
Some general hints:
* No matter what's the current keyboard layout or on which platform the
game is running, the console is always opened and closed by pressing
**Left Shift + Escape**.
* Yamagi Quake II saves its configuration, savegames and screenshots to
*~/.yq2* (unixoid platforms) or *My Documents\YamagiQ2* (Windows).
If Yamagi Quake II is started with the `-portable` switch all data is
saved in the same directory as the executables.
The documentation is split into several documents:
* [Index File](01_index.md)
* [Installation Guide](02_installation.md)
* [Configuration Guide](03_configuration.md)
* [List Of All New Console Variables](04_cvarlist.md)
* [Packaging Guide For Maintainers](05_packaging.md)
* [Contributing Guide](06_contributing.md)
* [Multiplayer Server Configuration](07_multiplayer.md)
* [File Listings](08_filelists.md)