1 # ncurses Minesweeper
2
3 Terminal game of Minesweeper, implemented in C with ncurses.
4
5 Minesweeper is a logic game where mines are hidden in a grid of squares. The
6 object is to open all the safe squares in the shortest time possible. Use
7 the arrow keys to move and \<SPACE\> to select. Read the Help page for more
8 information.
9
10 Click to watch a video demo on YouTube:
11 [![Minesweeper demo](http://img.youtube.com/vi/g7InqPoMShA/maxresdefault.jpg)](http://www.youtube.com/watch?v=g7InqPoMShA "Minesweeper demo")
12
13 ## Building
14
15 Currently functional on all systems with an ncurses library. PDCurses may be
16 dropped in and linked on Windows, although this hasn't been tested.
17
18 Requirements: `build-essential libncurses-dev`
19
20 Compiling and linking:
21 ```
22 make compile build
23 ```
24
25 **Binary executable deposited at `bin/minesweeper`.** You can copy this to
26 `/usr/bin/minesweeper` to run the game as `minesweeper` from any location in
27 Bash.
28
29 If you're contributing source code to this repository, install `clang-format
30 clang-tidy` and use `make` to target the linter programs. (`clang-format` is
31 a bit finicky; make sure you're running version 10.0.0, or it will yell at you
32 about unsupported configuration in `.clang-format`.)
33
34 ## Program structure
35
36 * Entry point at `src/main.c`
37 * Rendering logic loop at `src/draw/draw.c`
38 * Game logic handler at `src/game/game.c`
39 * Game renderer at `src/draw/game.c`
40
41 All header files correspond to a similarly named source file except
42 `src/draw/pages.h` which encapsulates multiple sources in the same directory.
43
44 ## TODO
45
46 * Rewrite Options screen controls
47 * Rewrite game management logic (memory handling, mine count setting)
48
49 ## Copyright and Licensing
50
51 This package is copyrighted by [Joshua 'joshuas3'
52 Stockin](https://joshstock.in/) and licensed under the [MIT License](LICENSE).
53
54 A form of the following should be present in each source or header file.
55
56 ```txt
57 ncurses-minesweeper Copyright (c) 2020 Joshua 'joshuas3' Stockin
58 <https://joshstock.in>
59 <https://github.com/JoshuaS3/ncurses-minesweeper>
60 This software is licensed under the MIT License.
61 ```
62
63 <<https://joshstock.in>> | josh@joshstock.in | joshuas3#9641
64
1	# ncurses Minesweeper
2
3	Terminal game of Minesweeper, implemented in C with ncurses.
4
5	Minesweeper is a logic game where mines are hidden in a grid of squares. The
6	object is to open all the safe squares in the shortest time possible. Use
7	the arrow keys to move and \<SPACE\> to select. Read the Help page for more
8	information.
9
10	Click to watch a video demo on YouTube:
11	[![Minesweeper demo](http://img.youtube.com/vi/g7InqPoMShA/maxresdefault.jpg)](http://www.youtube.com/watch?v=g7InqPoMShA "Minesweeper demo")
12
13	## Building
14
15	Currently functional on all systems with an ncurses library. PDCurses may be
16	dropped in and linked on Windows, although this hasn't been tested.
17
18	Requirements: `build-essential libncurses-dev`
19
20	Compiling and linking:
21	```
22	make compile build
23	```
24
25	Binary executable deposited at `bin/minesweeper`. You can copy this to
26	`/usr/bin/minesweeper` to run the game as `minesweeper` from any location in
27	Bash.
28
29	If you're contributing source code to this repository, install `clang-format
30	clang-tidy` and use `make` to target the linter programs. (`clang-format` is
31	a bit finicky; make sure you're running version 10.0.0, or it will yell at you
32	about unsupported configuration in `.clang-format`.)
33
34	## Program structure
35
36	* Entry point at `src/main.c`
37	* Rendering logic loop at `src/draw/draw.c`
38	* Game logic handler at `src/game/game.c`
39	* Game renderer at `src/draw/game.c`
40
41	All header files correspond to a similarly named source file except
42	`src/draw/pages.h` which encapsulates multiple sources in the same directory.
43
44	## TODO
45
46	* Rewrite Options screen controls
47	* Rewrite game management logic (memory handling, mine count setting)
48
49	## Copyright and Licensing
50
51	This package is copyrighted by [Joshua 'joshuas3'
52	Stockin](https://joshstock.in/) and licensed under the [MIT License](LICENSE).
53
54	A form of the following should be present in each source or header file.
55
56	```txt
57	ncurses-minesweeper Copyright (c) 2020 Joshua 'joshuas3' Stockin
58	<https://joshstock.in>
59	<https://github.com/JoshuaS3/ncurses-minesweeper>
60	This software is licensed under the MIT License.
61	```
62
63	<<https://joshstock.in>> \| josh@joshstock.in \| joshuas3#9641
64