angeljumbo / sssnake

cli snake game that plays itself

sssnake

The classic snake game for the terminal that can play itself and be used like a screensaver.

Installation

You need ncurses :

apt install libncurses-dev       #Debian/Ubuntu/Mint
yum install ncurses-devel        #RHEL/CentOS/Fedora and Rocky Linux/AlmaLinux
pacman -S ncurses                #Arch Linux
zypper install ncurses-devel     #OpenSUSE 
xbps-install -S ncurses-devel    #Void linux

With that you can just do:

git clone https://github.com/AngelJumbo/sssnake.git
cd sssnake
make
make install

Usage

You can check the manpage or use the -h option to see the details of what this program can do. So instead I would like to show you a few things that I like to run.

sssnake -m autopilot -s 15 -j 10

sssnake -m autopilot -s 15 -z -t -l ascii

sssnake -m screensaver -s 15 -z -x 8 -y 8 --try-hard 1

Planned features

Definitely be added

• Pause key Spacebar is now the pause key.
• Increase and decrease speed keys You can increase or decrease the speed with + and - in autopilot/screensaver modes.
• An alternative/replacement to the A* algorithm (probably BFS) BFS is now available with: --short-path=bfs.

May be added

• Hamiltonian cycles.
• Custom colors.
• IDA* to find the shortest path.

Faq

Can I control the snake?

Yes, that's the default mode or you can try the arcade mode where the game increases the speed every time you eat. The controls are wasd, the arrow keys or hjkl(vim keys).

Does the snake fills the entire screen/terminal with the autopilot?

If you use the "--try-hard" options the snake will get pretty close and sometimes it will fill the terminal. I implemented two algorithms "--try-hard 1" is good for big terminals/boards. You can test it running:

sssnake -m autopilot -s 15 --try-hard 1

"--try-hard 2" uses more cpu and it can get laggy with big boards but it has more chances to fill the board. Try:

sssnake -m autopilot -s 10 -x 10 -y 10 --try-hard 2

Neither of the two algorithms work well with junk.

Why the name "sssnake"?

All the snake games in the terminal that I found use ascii characters and lets be honest, they are kinda ugly. I try to do something more visually appealing, something "sexy" and it can play itself so it is "smart". Smart and sexy snake => sssnake.

A* vs BFS

At first this project was just an implementation of A* in the snake game, after finding chuyangliu's project I implemented their greedy solver with my A* instead of their BFS. Noticing that the behavior of the two implementations is different I decided to implement BFS in this project also as an alternative to A*. You can see the result here:

Commands of the video: For A*:

sssnake -m autopilot -x 20 -y 20 -s 17 --try-hard 2 -z

For BFS:

sssnake -m autopilot -x 20 -y 20 -s 17 --try-hard 2 -z --short-path=bfs

Credits

• Min heap implementation base on Martin Broadhurst min-heap ( http://www.martinbroadhurst.com/min-heap-in-c.html )
• A* base on (https://www.geeksforgeeks.org/a-search-algorithm/)
• The two "--try-hard" algorithms that I implemented were inspired by chuyangliu's greedy solver ( https://github.com/chuyangliu/snake/blob/master/docs/algorithms.md#greedy-solver )

sssnake's Issues

[feature] game field scaling

It would be neat, if one could configure for one unit to be n terminal rows and 2n terminal columns (n∈ℕ).
This would allow a zoomed snake game without having to zoom in the terminal application itself.

Distro Packaging

Can you add a version and release tarball for distro packagers to reference?

Allow the snake to cross the border

Either draw a border or allow the snake to cross the border to the other side of the screen.

Make an AUR package for arch users.

Screensaver Mode - any key press should exit

Feature request - in screen saver mode, only q will exit. Please make any key press exit.

Error in make

When trying to use the make, the following undefined reference happen:

/usr/bin/ld: /tmp/ccTdzNGY.o: in function `draw_point':
main.c:(.text+0x69d): undefined reference to `addwstr'
/usr/bin/ld: main.c:(.text+0x6b1): undefined reference to `addwstr'
/usr/bin/ld: main.c:(.text+0x6c5): undefined reference to `addwstr'
/usr/bin/ld: main.c:(.text+0x6d9): undefined reference to `addwstr'
/usr/bin/ld: main.c:(.text+0x6ed): undefined reference to `addwstr'
/usr/bin/ld: /tmp/ccTdzNGY.o:main.c:(.text+0x701): more undefined references to `addwstr' follow
collect2: error: ld returned 1 exit status
make: *** [makefile:5: sssnake] Error 1

Make does nothing

I just cloned to repo, and make tells me there is nothing to do:

$ git clone https://github.com/AngelJumbo/sssnake.git
Cloning into 'sssnake'...
remote: Enumerating objects: 248, done.
remote: Counting objects: 100% (63/63), done.
remote: Compressing objects: 100% (31/31), done.
remote: Total 248 (delta 44), reused 43 (delta 32), pack-reused 185
Receiving objects: 100% (248/248), 121.15 KiB | 1.75 MiB/s, done.
Resolving deltas: 100% (154/154), done.
$ cd sssnake
$ make
make: 'sssnake' is up to date.