papercats/README.md

64 lines
1.6 KiB
Markdown
Raw Normal View History

2019-02-03 01:49:23 -05:00
# Paper.IO
2017-02-23 23:36:15 -05:00
2019-04-17 23:43:15 -04:00
> This is a clone of the original Paper-IO released by Voodoo, except for one aspect. This will attempt to implement a multi-player aspect of the game (like a real IO game). Currently this has a playground at this [link](https://thekidofarcrania.github.io/BlocklyIO). It's a demo version of what to come. Hopefully by that time, the necessary server infrastructure could be obtained.
2017-02-23 23:38:52 -05:00
2019-04-17 23:43:15 -04:00
> This is just a fun side-project for me. If you would want to use this code, it would be nice to let me know.
## Screenshots
![Screenshot](screenshot.png)
2017-02-26 19:26:22 -05:00
2019-01-15 10:42:15 -05:00
## Install
```bash
2019-04-17 23:43:15 -04:00
# Clone this repository
2019-01-15 10:42:15 -05:00
git clone https://github.com/stevenjoezhang/paper.io.git
2019-04-17 23:43:15 -04:00
# Go into the repository
2019-01-15 10:42:15 -05:00
cd paper.io
2019-04-17 23:43:15 -04:00
# Install dependencies
2019-01-15 10:42:15 -05:00
npm install
```
2017-02-26 19:26:22 -05:00
## Running
After cloning this repository, run the follow commands to install dependencies and set up server. Enjoy!
```bash
npm start
```
2019-01-15 10:42:15 -05:00
2019-02-21 20:36:35 -05:00
You can configure the game by editing `config.json`.
2019-02-21 12:02:18 -05:00
2019-04-17 23:43:15 -04:00
**WARNING: Remember to build again after editing any file, include `config.json`.**
2019-02-22 04:35:16 -05:00
2019-01-15 10:42:15 -05:00
## Build
```bash
2019-03-06 22:05:56 -05:00
npm run build
2019-01-15 10:42:15 -05:00
```
2019-02-21 20:36:35 -05:00
## Bots
2019-02-22 04:35:16 -05:00
Set `bots` in `config.json` to a non-zero value, or execute the command below:
2019-02-21 20:36:35 -05:00
```bash
2019-03-27 09:53:43 -04:00
node paper-io-bot.js ws://localhost:8080
2019-02-22 03:09:27 -05:00
#or
2019-03-27 09:53:43 -04:00
node bot.js ws://localhost:8080
2019-02-21 20:36:35 -05:00
```
2019-02-21 11:19:33 -05:00
## Roadmap & TODO List
2019-02-03 01:49:23 -05:00
2019-02-21 20:36:35 -05:00
- [x] 统一配置文件
2019-02-22 03:09:27 -05:00
- [x] 玩家观战模式
- [ ] 更多游戏玩法
2019-02-21 12:02:18 -05:00
- [ ] 多个游戏房间
- [ ] 加快渲染速度
- [ ] 优化胜负判定
2019-02-03 01:49:23 -05:00
2017-12-29 01:58:33 -05:00
## License
2019-04-17 23:43:15 -04:00
This repo is forked from [BlocklyIO](https://github.com/theKidOfArcrania/BlocklyIO) by theKidOfArcrania.
2019-01-16 03:57:36 -05:00
2019-04-17 23:43:15 -04:00
> This is licensed under MIT. As such, please provide due credit and link back to this repository if possible.