Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 1.38 KB

README.md

File metadata and controls

73 lines (51 loc) · 1.38 KB

ToyBox

ToyBox Game Engine

Getting Started

To get started you can add ToyBox to your project by installing it via NPM:

npm install toybox-engine --save

Or you can use ToyBox CLI ( https://github.com/ManojlovicMilos/ToyBoxCli ) to initialize new project. To install CLI globaly run:

npm install toybox-engine-cli -g

And create new project by calling:

tbx -init "Your New Project Name"

Documentation

You can find reference manual and other guides at: https://github.com/ManojlovicMilos/ToyBox/wiki

Prerequisites

ToyBox aside from NPM and it's dependency packages have no other prequisities. However ToyBox CLI may require following software:

  • Git
  • 7zip

To see what CLI functionalities require additional software call:

tbx -help details

Deployment

To get fully built production package zip use CLI:

npm -pack

or

npm -7zip -pack

Versions

Current version is 0.2.0

Versions 0.1.X and older are no longer supported.

Authors

  • Miloš Manojlović

Contributing

If you consider contributing contact me via toyboxengine@gmail.com .

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

We use following packages to make ToyBox work:

You are awesome! Keep up the good work :)