1.\"
2.\" Copyright (c) 2011-2019 David Demelier <markand@malikania.fr>
3.\"
4.\" Permission to use, copy, modify, and/or distribute this software for any
5.\" purpose with or without fee is hereby granted, provided that the above
6.\" copyright notice and this permission notice appear in all copies.
7.\"
8.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15.\"
16.Dd September 05, 2019
17.Dt NSNAKE 6
18.Os
19.Sh NAME
20.Nm nsnake
21.Nd a snake game for your terminal
22.Sh SYNOPSIS
23.Nm nsnake
24.Op Fl cnsvw
25.Op Fl C Ar color
26.Sh DESCRIPTION
27You are controlling a snake where the goal is eating food spawning randomly on
28the screen.
29.Pp
30There are two types of food, normal and free, respectively
31.Ar + , * .
32.Pp
33The head of the snake is symbolized with an
34.Ar @ .
35.Pp
36Each time you eat a piece of food, the snake will be grown by two. If you
37eat a free piece of food the score will be increased but not the snake's length.
38.Pp
39The following options are available:
40.Bl -tag -width indent
41.It Fl c
42Disable colors, by default if the terminal is capable colors are enabled.
43.It Fl C Ar color
44Specify an alternate color between 0 and 8. (default 2)
45.It Fl n
46Do not try to update score file.
47.It Fl s
48Only display high score sorting by descending and exit.
49.It Fl v
50Be more verbose.
51.It Fl w
52Disable wall crossing. Can be used together with
53.Fl s
54to show score with wall crossing disabled.
55.El
56.Sh KEYS
57To move the snake the following keys may be used:
58.Ss Up, k
59Move to up
60.Ss Down, j
61Move to down
62.Ss Left, h
63Move to left
64.Ss Right, l
65Move to right
66.Ss p
67Suspend the game until p is pressed again.
68.Ss c
69Change the color.
70.Ss q
71Quit the game and save the score.
72.Sh AUTHORS
73nsnake was written by David Demelier <markand@malikania.fr>
74.Sh BUGS
75The snake seems to be faster when moving vertically, this is due to terminal
76character dimensions.
77