V-Gears/doc/RUN.md

V-Gears Data Run Guide

Run the engine

If you have followed the build and installaton guides, you'll have the game data installed to ~/.v-gears/, and the binaries compilled somewhere (we'll assum they are in ~/V-Gears/build/bin, change the directories according to your system).

Run the engine from any directory:

~/V-Gears/build/bin/v-gears

The engine looks for its data directory in this order, and changes into it:

1. The directory given with --data-dir, for example v-gears --data-dir ~/games/v-gears.
2. The directory in the VGEARS_DATA_DIR environment variable.
3. The current directory, if it has the V-Gears files (plugins.cfg and a data folder).
4. ~/.v-gears/ (%USERPROFILE%\v-gears\ in Windows), the same default as the data installer.

If the chosen directory doesn't have the V-Gears files yet, the engine copies them there from the data/ folder of the repository (or from share/v-gears in an installed package; VGEARS_TEMPLATE_DIR overrides it). Files that are already there are never overwritten. The data of the original game still has to be added with the data installer.

The data installer also has a Launch game button, which starts the engine with the installation directory.

Key Mappings

Here is a list of key mappings, adapted from the PSX version of the game:

• 🠉: Up
• 🠊: Right
• 🠋: Down
• 🠈: Left
• ⨯: ?
• □: ?
• ○: Space bar
• △: Esc
• ⯇: Enter
• ▬: ?
• R1: ?
• L1: ?
• R2: ?
• L2: ?