Welcome to Bloxcode!

Join the Discord server to get help, ask questions, and get updates.

This project aims to enable people to implement roblox scripts using visual programming blocks provided by Blockly.

Why does this project exist?

Because while googling for a way to use a scratch-type visual programming interface to implement roblox scripts, I didn't really find anything, although others had gone looking for the same thing before me.

How does it work?

Bloxcode is made up of two components:

• A Roblox Studio plugin that manages scripts
• A desktop application that exposes a visual programming interface

Once the plugin is installed in Roblox Studio, if both Bloxcode and Roblox studio are started, they will remain in sync.

Installation:

Eventually this will be published as an official plugin. Until then, you can install the plugin into Roblox Studio manually:

• Create a new server Script in ServerStorage
• Paste the contents of Sync.lua into the script
• Right click the script and select Save Local Plugin

Once the plugin is active, it will display a notice indicating if it is connected to Bloxcode or not.

Removal:

Navigate to the Plugins tab in Roblox Studio and click on the Plugins Folder. Delete the script that was saved earlier and restart Roblox Studio.

Bloxcode desktop application

Bloxcode provides a Blockly interface for editing scripts. Currently the app has a very basic interface that will be updated to be more user-friendly in the future.

Building the Desktop Application

Prerequisites

• Node.js (v14 or higher recommended)
• npm (comes with Node.js)

Build Instructions

1. Install dependencies

   cd app
   npm install

2. Run in development mode (optional, to test before building)

   npm start

3. Build the executable

   npm run make

The installer will be located at app/out/make/squirrel.windows/x64/bloxcode-1.0.0 Setup.exe.

Note: This creates a Windows installer using Squirrel. Run the Setup.exe to install Bloxcode on your system.

Creating and editing scripts

1. Select a container: In the tree view on the left, select a container object (like Workspace, ServerScriptService, or any Folder) where you want to create a script.

2. Create a new script: Click "New Script" or "New LocalScript" button that appears when a container is selected. The new script will automatically open in the editor.

3. Edit existing scripts: Click on any Script or LocalScript in the tree to open it in the Blockly editor.

Each script consists of:

• A .blox source file containing the visual blocks
• A Lua script generated from those blocks when you save

HowTo

Bloxcode Tutorial Videos

Limitations

• Only a tiny subset of the roblox api is currently implemented

Can I help make Bloxcode better?

Yes, please! If there are any features you would like to see implemented, or any bugs you find, head over to the github issues list for the project and see if someone has already filed an issue. If you find someone has already filed an issue, add a thumbs-up to the issue to upvote. If not, please file an issue and include details on what you would like changed.

Also feel free to browse through discussions or start your own.

Help is also wanted in implementing new blocks that expose the Roblox API. If you would like to help with adding new blocks, check out the existing block definitions and toolbox definition. The general workflow for implementing a new block:

• Fork your own version of this repository
• Define a new block using Block Factory (TODO: add a guide on how to use this)
• Copy over the block definition (javascript) and Lua generator stub into the block definitions file.
• Add the lua code to the generator stub
• Test out your changes locally (TODO: add a guide on how to do this)
• Submit a pull request