nsnake

Classic snake game on the terminal; made with C++ and ncurses.

nsnake is a clone of the classic snake game that we all used to
play on our cellphones. You play this game on the terminal,
with textual interface.

Here's some features:

• Customizable gameplay, appearance and keybindings;
• Neat GUI-like interface with nice animations;
• Lots of possible game modes, with scores saved for each;

Controls

The keybindings are completely customizable on the in-game menus.
The default ones are:

All user settings are located at ~/.local/share/nsnake.

Dependencies

nSnake depends on two libraries, ncurses and yaml-cpp.

ncurses

This library shows cute things on the terminal.

For nSnake you need the package ncurses dev. Note that it's not the default
that comes with your distro.

If you know the means to install on other distros, please tell me.

yaml-cpp

This library is used to parse YAML configuration files.

With it nsnake has a human-readable settings file; you can easily backup
and manually change it, although we the preferred method would be from inside
the game.

If you know the means to install on other distros, please tell me.

Usage

Briefly, the following shell commands should configure,
build and install this package on the default directories:

$ make
$ [sudo] make install

If you want to test it before installing, do:

$ make run

Then, it's simple:

$ man nsnake
$ nsnake

To change the default installation directories, check file
INSTALL.md.

Contact

Hello there, I'm Alexandre Dantas (kure)!

Thanks for downloading and playing this game, I'm very glad you had
interest on this humble project.

You can send me comments, bugs, ideas or anything else by email.
And if you have time, please visit my blog!

• My email: eu@alexdantas.net
• My homepage: http://alexdantas.net/
• Mu blog: http://alexdantas.net/stuff

I'd appreciate any commentary - even if it's
just "Hello, I play your game!".

Links

Some interesting links if you're interested on nsnake:

• nSnake homepage
• Up-to-date nsnake news (RSS feed)

Also, it's all over the web!

• Source on GitHub
• Source on Bitbucket
• Source on Sourceforge
• Source on Google Code
• Package on Debian
• Package on Fedora
• Package on Arch Linux (AUR)
• Package on Slackware (SlackBuilds)

Credits

Firstly, I'd like to thank you for playing this game.
Hope you liked it!

The game was mainly done by me, but a lot of people helped me in
many ways. There's a list of them on the AUTHORS file, and you
can see people's contributions to the code here.

Throughout the nsnake development, I found very interesting sources
of ideas; small games made in C, textual games with ncurses, and
stuff like that.

I raise my hat to:

• nInvaders: A space invaders-like game using ncurses.
• homepage: http://ninvaders.sourceforge.net

• comments: "Thanks for the inspiration. If I haven't installed
  this in first place, I'd never have the idea
  for nsnake"

• pacman4console: A console-based pacman game.

• homepage: http://doctormike.googlepages.com/pacman.html

• comments: "The way this package was organized
  is incredible. Thanks for the
  general packaging ideas"

• vadorz: An addicting ncurses space-invaders game.

• homepage: http://code.google.com/p/vadorz/

• comments: "This package is awesome, 'cause it uses ncurses
  AND pdcurses to be able to play in Windows and
  GNU/Linux"

• snake4: Fruit-eating snake game

• homepage: http://shh.thathost.com/

• comments: "Thanks for the Makefile ideas. It's
  very well-written."

• ASCII Generator: A generator of awesome ASCII text arts

• homepage: http://www.network-science.de/ascii/

• Text ASCII Art Generator: Another awesome ASCII text generator

• homepage: http://patorjk.com/software/taag/
• comments: "I've used the Modular font to display
  the Game Over screen"

License

nsnake - The classic snake game with ncurses.
Copyright (C) 2011,2014 Alexandre Dantas

nsnake is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see http://www.gnu.org/licenses/.

homepage: http://www.alexdantas.net/projects/nsnake/
mailto: eu@alexdantas.net