kevin
/
intelligent-snake
mirror of https://github.com/prurigro/intelligent-snake.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added a LICENSE file and README in markdown

This commit is contained in:
Kevin MacMartin 2014-05-29 13:47:39 -04:00
parent 1f6fb19ade
commit b101db9c91
2 changed files with 87 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2014 Kevin M
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

66
README.md Normal file
View File

@ -0,0 +1,66 @@
# Intelligent Snake #
Intelligent Snake is a simple clone of the famous **snake**-style games. It's meant both as a fun time waster as well as a simple working SDL program to learn from and use as a reference.
![Intelligent Snake](http://i.imgur.com/p80DyKz.png)
## Compile ##
### Linux ###
#### Requirements ####
* **make**
* **gcc**
* **SDL** (version 1.2)
* **SDL_ttf**
#### Build ####
* `make`: Build Intelligent Snake and copy required files to ./bin/
* `make clean`: Remove build directories
### Windows ###
#### Requirements ####
* **make**
* **mingw-w64**
* **mingw-w64-sdl** (version 1.2)
* **mingw-w64-sdl_ttf**
#### Build ####
* `make windows`: Build Intelligent Snake for Windows and copy required files to ./windows-bin/
* `make clean`: Remove build directories
## Commands ##
Usage: `./isnake [options]`
### Options ###
* `./isnake`: Start the game with the default options
* `./isnake -g [width] [height]`: Set the grid size: between [30]x[20] and [80]x[50] (DEFAULT: [50]x[30])
* `./isnake -b [blocks]`: Set the number of blocks: between [0] and [40] (DEFAULT: [20])
* `./isnake -l [length]`: Set the snake's starting length: between [3] and [35] (DEFAULT: [3])
* `./isnake -s [speed]`: Set the snake's starting speed: between [1] and [9] (DEFAULT: [1])
* `./isnake -h`: Display help information
## Controls ##
* **Movement**
* **FPS Keys**: `w`, `a`, `s` and `d`
* **Vim Keys**: `k`, `h`, `j` and `l`
* **Arrow Keys**: `up`, `left`, `down` and `right`
* **Quit**: `Escape` and `Q`
* **Restart** (after death): `Space` and `Return`
## Credits ##
* Written by Kevin MacMartin: [GitHub Projects](https://github.com/prurigro?tab=repositories) | [Arch Linux AUR Packages](https://aur.archlinux.org/packages/?SeB=m&K=prurigro)
## License ##
* **Intelligent Snake**: [The MIT License](http://opensource.org/licenses/MIT)
* **Font** ([DroidSans-Bold.ttf](https://www.google.com/fonts/specimen/Droid+Sans)): [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)