A system to replicate scripts from the filesystem into Roblox Studio.
npm install -g rbxfs
rbxfs
File names map to different script types:
*.server.lua
- Script
*.client.lua
- LocalScript
*.lua
- ModuleScript
RBXFS supports configuration via a file called rbxfs.json
in the root of your project.
The default configuration values are:
{
"rootDirectory": "",
"rootObject": ""
}
It assumes that your code begins in the current directory and matches the Roblox hierarchy starting from game
. You might have folders named ReplicatedStorage
, ServerScriptStorage
, and these would map to the top-level services.
To synchronize files in the src
directory to ReplicatedStorage.MyGame
, use this configuration:
{
"rootDirectory": "src",
"rootObject": "ReplicatedStorage.MyGame"
}
Developing requires Node.js 8.x.
See plugin
for the ROBLOX plugin source. This can be synced to ROBLOX using the last released version of the plugin.
See lib
for the Node.js server source. Use npm link
to use the Git version in your projects.
I hadn't heard of RbxRefresh when I built this!
Other than that:
ModuleScript
files unnecessarily verboseRBXFS is available under the MIT license. See LICENSE.md for details.