Quick Start

A quick guide to getting started with RocketBlend.

Install RocketBlend

Before getting started with RocketBlend, ensure it's installed on your system. You can use tools like go install, package managers like Homebrew and Scoop or grab a pre-compiled binary at the official releases page.

For more details, or for other options, see the installation guide.

Create a new project

Once you have everything ready, you can create your first project! Open a terminal in your desired location and run the command rocketblend new hello-world

$ rocketblend new hello-world
⣻ Creating project...

To see a more detailed output of what's happening, add the -v flag.

Once complete you'll have a new .blend project and a rocketblend.json file used to define all your packages for your project.

$ ls
hello-world.blend  rocketblend.json

Install a package

To install a package, you can run the rocketblend install command. RocketBlend uses references to install packages from remote sources such as Github. You can create your own packages or use ones already defined online, but the easiest way to get started is to use the official library.

$ rocketblend install github.com/rocketblend/official-library/packages/v0/builds/blender/4.0.1
⣯ Installing package...

In this example, we're changing the project to use a Blender 4.1.1 build.

If you have purchased a build or add-on, you can create a custom package definition locally. Then use the rocketblend insert command to insert it into your library.

Running this command without specifying a package will install all dependencies for a project. This is particularly helpful when sharing projects across multiple machines.

Open a project

With the project successfully configured, you can initiate it by executing the rocketblend run command. Blender will then launch with all the necessary dependencies defined for the project.

By default, RocketBlend doesn't change any of your existing add-ons. It just adds the new ones you specified. This way, it works well with what you already have.

However, If you set strict mode to true in the projects rocketblend.json file, only the add-ons listed in that file will be enabled. All other add-ons, including default ones like Cycles, will be turned off unless they are listed.

Any changes to add-ons are temporary and only for that Blender session. They won't be saved to your user preferences, therefore the add-on menu in Blender might show incorrectly. This is done to retain any previously defined add-on preferences.