Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
masterfeizz committed May 8, 2016
1 parent 603b36a commit 48cdca2
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
# ctrQuake
ctrQuake is a free, unofficial port of Quake for the Nintendo 3DS. It is fully playable, but still in early stages.

## Installation guide
- Follow the guide for running homebrew at [http://smealum.github.io/3ds/](http://smealum.github.io/3ds/)
- Download the latest `ctrQuake.zip` from the [releases page](https://github.com/masterfeizz/ctrQuake/releases)
- Extract `ctrQuake.zip` to the root of your SD card
- Launch ctrQuake from the Homebrew Launcher

## Usage
You must first bind the keys on the options screen before playing
## Default keybinds
- L Trigger: Jump
- R Trigger: Shoot
- Dpad Up: Next Weapon
- Dpad Down: Previous Weapon
- ABXY: Camera controls
- CirclePad: Movement
- C-Button: Camera controls (N3DS only)

## Playing the full game
The released version of ctrQuake only includes the shareware episode. To play the full game you must copy the pak1.pak from your copy of the game and place it in the id1 folder inside ctrQuake

To use mods: place mod folder in the same directory as ctrQuake.3dsx and create a shortcut with the folder name as argument. See tf.xml as example
## Mods
To use mods: place mod folder in the same directory as ctrQuake.3dsx and create a shortcut with the launch parameters. See tf.xml as example

## TODO List
- [ ] Better input handling
Expand Down

0 comments on commit 48cdca2

Please sign in to comment.