Skip to content

Latest commit

 

History

History
75 lines (61 loc) · 2.08 KB

readme.md

File metadata and controls

75 lines (61 loc) · 2.08 KB

Private Box

A tool for creating your own worlds using the box critters engine.

instructions from after rework (not well formatted)

requires https either setup https on your server or host somewhere else like heroku

if you setup https please tell me how you did it because i keep getting ssl errors

port config is in index.js run with node.js

on client script, set ip and nickname to your liking run client connect script in console on boxcritters

Getting started

Prerequisites

To use Private Box you need:

  • Ruby >= 2.4.0
  • 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

Else, if you are on Windows, run

_start_server.bat

to start the WebSocket server, and

_start_client.bat

to start the client. Then go to https://localhost:4000 and see the magick!

Built With

  • EaselJS (CreateJS)
  • Jekyll
  • Node.js
  • Express.js
  • Socket.IO

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