82678235ab
This PR refactors all of the methods on `Vfs` from accepting `&mut self` to accepting `&self` and keeping data wrapped in a mutex. This builds on previous changes to make reference count file contents and cleans up the last places where we're returning borrowed data out of the VFS interface. Once this change lands, there are two possible directions we can go that I see: * Conservative: Refactor all remaining `&mut Vfs` handles to `&Vfs` * Interesting: Embrace ref counting by changing `Vfs` methods to accept `self: Arc<Self>`, which makes the `VfsEntry` API no longer need an explicit `Vfs` argument for its operations. * Change VfsFetcher to be immutable with internal locking * Refactor Vfs::would_be_resident * Refactor Vfs::read_if_not_exists * Refactor Vfs::raise_file_removed * Refactor Vfs::raise_file_changed * Add Vfs::get_internal as bits of Vfs::get * Switch Vfs to use internal locking * Migrate all Vfs methods from &mut self to &self * Make VfsEntry access Vfs immutably * Remove outer VFS locking (#260) * Refactor all snapshot middleware to accept &Vfs instead of &mut Vfs * Remove outer VFS Mutex across the board |
||
|---|---|---|
| .cargo | ||
| .github/workflows | ||
| assets | ||
| benches | ||
| bin | ||
| docs | ||
| plugin | ||
| rojo-insta-ext | ||
| rojo-test | ||
| src | ||
| test-projects | ||
| tests | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| .luacheckrc | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| design.gv | ||
| LICENSE.txt | ||
| mkdocs.yml | ||
| README.md | ||
Rojo is a tool designed to enable Roblox developers to use professional-grade software engineering tools.
With Rojo, it's possible to use industry-leading tools like Visual Studio Code and Git.
Rojo is designed for power users who want to use the best tools available for building games, libraries, and plugins.
Features
Rojo enables:
- Working on scripts and models from the filesystem, in your favorite editor
- Versioning your game, library, or plugin using Git or another VCS
- Streaming
rbxmxandrbxmmodels into your game in real time - Packaging and deploying your project to Roblox.com from the command line
Soon, Rojo will be able to:
- Automatically convert your existing game to work with Rojo
- Sync instances from Roblox Studio to the filesystem
- Automatically manage your assets on Roblox.com, like images and sounds
- Import custom instances like MoonScript code
Documentation
If you find any mistakes, feel free to make changes in the docs folder of this repository and submit a pull request!
Contributing
Check out our contribution guide for detailed instructions for helping work on Rojo!
Pull requests are welcome!
Rojo supports Rust 1.36.0 and newer. The minimum supported version of Rust is based on the latest versions of the dependencies that Rojo has.
License
Rojo is available under the terms of the Mozilla Public License, Version 2.0. See LICENSE.txt for details.