RoRender Plugin

A Roblox plugin to generate maps for RoRenderV4
RoRender Plugin · RoRender Website

View Demo · Report Bug · Request Feature

About The Project

This is the Roblox Plugin side of RoRender V4. This is open sourced so that game developers can customize how their map is rendered. The code here is responsible for 4 things, with the most room for improvements being in UI and Raytracing.

1. Plugin UI and configuration deployment
2. Raytracing and gathering supplemental data for the editor
3. Compressing data
4. Splitting and transmitting the data to the RoRender backend

The data is expected in a very particular format for the editor to function properly, so pull requests and bug fixes will be tested thoroughly before being accepted.

(back to top)

Built With

• 
• 

Thanks to these two projects, I was able to write the entire stack—front end, back end, and plugin—using a single language: TypeScript 🤯. Having one unified language to tackle every part of the project was a game-changer for development speed, and I’m incredibly grateful to the maintainers of these projects for making such an awesome developer experience possible. While I do hope to rewrite the backend in a more performant language someday, for a small project like this, sticking to one language has been an amazing experience.

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Ensure latest npm and Rojo is installed

• npm

  npm install npm@latest -g

• Rojo

Installation

1. Clone the repo

   git clone https://github.com/github_username/repo_name.git

2. Install NPM packages

   npm install

3. Either build it into your local plugin directory, or serve it

   npm run build
   npm run serve

(back to top)

Roadmap

• Auto configure render cube
• Allow users to Resend render to another UUID if initial UUID was invalid
• Viewfinder for render preview
• Beta Testing
• Multi-language Support
  • Chinese
  • Spanish
• Add Changelog

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

Top contributors:

Made with contrib.rocks.

(back to top)

License

Distributed under the Unlicense License. See LICENSE.txt for more information.

(back to top)

Contact

AJ Steinhauser - @roblox_reteach - support@rorender.com

Project Link: https://github.com/AJSteinhauser/rorender-rbx

(back to top)

(back to top)

Project Link: https://github.com/AJSteinhauser/rorender-rbx