boltbox v1.0.1
About The Project
My friends and I loved playing jackbox, however we found ourselves contemplating new game types that could be added, and were met with a lack of resources to easily and quickly implement them, enter BoltBox.
BoltBox is complex under the hood but makes implementing games easy and quick:
- New games can be remotely installed using NPM
- All games can have extensions installed adding new content to the (extra lines or promts for example)
- Keep game devolpement simple and fun while being extendable and modular
This project is still heavily under devolpement and has a long way to go so help and patience is highly appreciated!
Getting Started
The installiation process for BoltBox should be as painless as possile and will hopefully get even easier in the future. To get a local copy up and running follow these simple example steps.
Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
Installation
- Clone the repo
git clone https://github.com/BurntIce16/BoltBox.git - Install NPM packages
npm install - Launch the BoltBox server
npm start; - Connect the "host" machine to the server at port 3001 and follow the onscreen instructions
- Destroy your friendships 😈
Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
Roadmap
- Basic local networking
- Implement client interface
- Implement host interface
- Design and implement modular framework for NPM based game installiation
- Multi-language Support
- French
- Spanish
- Built in game browser through NPM
See the open issues for a full list of proposed features (and known issues).
License
Distributed under the MIT License.
Contact
Clayton Midgley - @BurntIce16 - clayton.midgley@gmail.com
Project Link: https://github.com/BurntIce16/BoltBox