ShrouvRBLX - Engine

Main Repository containing all ShrouvEngine packages, including the CLI, Engine & Documentation.

Explore the docs »

View Demo . Report Bug . Request Feature

Table Of Contents

• Built With
• Screenshots
• Getting Started
  • Prerequisites
• Usage
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

Built With

• Mantle
• Tarmac
• Roblox-TS
• Flipbook
• ReactLua
• Docusaurus

Screenshots

Getting Started

cd shrouvrblx
npm run install
npm run new

Then visit the wiki to continue setting up your shrouv experience. The documentation provides all usage details.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm
• yarn
• foreman

npm install npm@latest -g

Usage

Start by generating a new experience using the ShrouvCLI

Generate a new ShrouvEngine game using the configurable classic template.

The classic template will automatically be added to your project after you run the following commands:

git clone --recursive https://github.com/mandrillxx/shrouvrblx.git
cd shrouvrblx
npm run install
npm run new

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• mandrillxx - Comp Sci Student - mandrillxx - Built ShrouvEngine

Acknowledgements

• ImgShields