Private Box
Alternative client and server for Box Critters.
Getting started
Prerequisites
To use Private Box you need:
- Node.js >= 10.16.3
Installation
First, clone or download the repo, then, if you are on *nix/UNIX-Like (Linux, BSD) systems that supports make
, do:
make deps
on the command line. If you are on Windows or similar, you can skip this above.
Usage
To start the WebSocket server and the client, if you are on *nix/UNIX-Like systems, run:
make dev
Else, if you are on Windows, run
_start.bat
to start the WebSocket server and the client. Then go to https://localhost:3000 and see the magick!
Built With
- EaselJS (CreateJS)
- Node.js
- Express.js
- Socket.IO
- doubleb.js
Versioning
We use Box Critters versioning (client- 1, 23, 5678, etc.)
Contributors
License
Private Box by the Box Critters Modding Community is licensed under the Mozilla Public License version 2.0 (MPL-v2.0). For more info see the LICENSE file.
Acknowledgments
- README Template by tumble1999
- Inspiration
- etc.