Skip to content
A ncurses based game for learning Vi/Vim.
C CMake
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
include
maps
src
.gitignore
CMakeLists.txt
LICENSE
README.md
config.h.in
doxygen.conf

README.md

A Vim Story

A ncurses based game for learning Vim

Codacy Badge

Overview

There are a lot of problems faced by beginners to Vim (like getting used to not using arrow keys for example). Although there are a lot of resources for learning Vim, they can get tedious and time consuming.

The project aims to make a game played by using the shortcuts and key mappings in Vim to ease into the famous learning curve of Vim. The idea is to make a retro console game (like bomber-man and the likes) which is controlled solely by Vim key mappings and shortcuts.

Inspired by Vim Adventures and open sourced.

Compiling

Assuming you have libncurses, CMake and Make installed.

mkdir build && cd build

cmake ..

make
make install        # to install (might want to use 'sudo')

a-vim-story         # to run

If you want to install in another directory

cmake -DCMAKE_INSTALL_PREFIX=/usr ..  # to install in /usr

Or if you want to test it in build/ itself

cmake -DCMAKE_INSTALL_PREFIX=. ..
make && make install
./bin/a-vim-story

Documentation

For documentation, a configuration file for Doxygen is provided. Assuming you have doxygen installed, issue these commands:

doxygen doxygen.conf

Author

Utkarsh Maheshwari

License

GPL version 3

You can’t perform that action at this time.