diff options
| author | Teddy Wing | 2015-10-08 04:32:10 -0400 | 
|---|---|---|
| committer | Teddy Wing | 2015-10-08 04:33:16 -0400 | 
| commit | 78038c863df19509a5edbc6e8b97a43fdfe24ff6 (patch) | |
| tree | 38a539295c219069ae7715a165da2dc5f8d407bb /doc/space_vlaze.txt | |
| parent | 7ca0e2b4e01b8b37405e6e7f25477bfae107c319 (diff) | |
| download | vim-space-vlaze-78038c863df19509a5edbc6e8b97a43fdfe24ff6.tar.bz2 | |
Add docs
Write Vim help for the plugin including an introduction, information
about the command and map provided, as well as gameplay instructions and
maps.
Also generate help tags.
Diffstat (limited to 'doc/space_vlaze.txt')
| -rw-r--r-- | doc/space_vlaze.txt | 56 | 
1 files changed, 54 insertions, 2 deletions
| diff --git a/doc/space_vlaze.txt b/doc/space_vlaze.txt index de64753..4285131 100644 --- a/doc/space_vlaze.txt +++ b/doc/space_vlaze.txt @@ -1,8 +1,60 @@ -*space_vlaze.vim*	 +*space_vlaze.vim*	A space shooter game +Author:  Teddy Wing <http://teddywing.com> +License: MIT +Version: 0.0.1 + +============================================================================== +INTRODUCTION                                        *space_vlaze-introduction* -INTRODUCTION  Captain Nolan and his crew on the Benten have completed a routine delivery  mission to Chapek 9. As they make their way home through the Maze system,  their ship is suddenly assailed by giant floating popcorn kernels! Help Nolan  and the Benten pop the kernels before it's too late. + +============================================================================== +COMMANDS                                                *space_vlaze-commands* + +:SpaceVlaze                                                       *SpaceVlaze* +    Launch the game. A prompt appears to perform one of the following: + +	1. Play the game +	2. Display the leaderboard +	3. Show this help + +============================================================================== +MAPPINGS                                                *space_vlaze-mappings* + +							*space_vlaze-<leader>sv* +<leader>sv		Launch Space Vlaze. + +============================================================================== +GAMEPLAY                                                *space_vlaze-gameplay* + +Take control of Captain Nolan and the Benten. Navigate the treacherous expanse +of space avoiding or popping the fearsome kernels. + +							*space_vlaze-h* +h			Move the Benten left. + +							*space_vlaze-j* +j			Move the Benten down. + +							*space_vlaze-k* +k			Move the Benten up. + +							*space_vlaze-l* +l			Move the Benten right. + +							*space_vlaze-<space>* +<space>			Fire missiles. + +							*space_vlaze-q* +q			Quit the game. + +============================================================================== +LICENSE                                                  *space_vlaze-license* + +Space Vlaze is released under the MIT license. + + vim:tw=78:ts=8:ft=help:norl: | 
