Snek/README.md

45 lines
1.4 KiB
Markdown
Raw Normal View History

2020-03-22 21:54:26 +00:00
# Snek
2020-03-22 23:01:00 +00:00
![Snek icon, Miia from Mon Musu](assets/icon.jpg)
2020-03-22 22:22:00 +00:00
2020-03-26 17:20:48 +00:00
A "simple" Snake, done as my final JS class project
2020-03-22 22:22:00 +00:00
[Original subject](https://perso.liris.cnrs.fr/pierre-antoine.champin/enseignement/intro-js/s6.html)
2020-03-22 21:54:26 +00:00
2020-04-08 13:32:00 +00:00
## Features
- 60 FPS 2D animations
- arcade and speedrun game modes
- touchscreen and controller support
2020-04-08 13:59:29 +00:00
- playable at [snek.codinget.me](https://snek.codinget.me)
2020-04-08 13:32:00 +00:00
## Dev dependencies
- All the POSIX tools, most importantly a POSIX-compliant shell, `echo`, `rm`, `seq` and `sed`
- Busybox is known to work
- GNU Coreutils are known to work
- On Windows, WSL is known to work
2020-03-23 19:11:39 +00:00
- Imagemagick, with the `convert` tool in the PATH
2020-04-15 00:27:17 +00:00
- `bc`
2020-03-23 19:11:39 +00:00
- Make
- Node.js and npm, both in the PATH
- Node.js 10 and 12 are known to work
2020-04-13 19:58:53 +00:00
- node-gyp and python are required for the database
2020-03-23 19:11:39 +00:00
2020-04-08 13:32:00 +00:00
## Running the game (dev)
- `git clone` this repo
2020-04-15 10:10:28 +00:00
- `npm install` the dependencies (this will also build the less and js and initialize the database)
2020-04-08 13:32:00 +00:00
- `npm start` the server
2020-04-15 10:10:28 +00:00
- `make` every time you change something
2020-04-08 13:32:00 +00:00
2020-04-15 10:10:28 +00:00
## Running the game (prod, docker)
2020-04-08 13:32:00 +00:00
- Get the [Dockerfile](https://gitdab.com/Codinget/Snek/raw/branch/master/Dockerfile)
2020-04-07 18:09:02 +00:00
- `docker build` it
2020-04-08 13:32:00 +00:00
- `docker run -it -p80:3000` the container
2020-04-07 18:09:02 +00:00
- ideally, put it behind a reverse proxy
2020-04-08 13:32:00 +00:00
2020-04-15 10:10:28 +00:00
## Running the game (prod, direct)
- `git clone` this repo
- `npm install` the dependencies (this will also build the less and js and initialize the database)
- `npm start` the server
2020-04-08 13:32:00 +00:00
## License
[MIT](https://opensource.org/licenses/MIT)