Blender VS Code Addon for VS Codium

[aab18011]

Guide to Using the Blender VSCode Extension with VS Codium

This guide provides a step-by-step process for users who want to use the Blender VSCode extension in VS Codium instead of Visual Studio Code (VS Code). It explains how to convert the extension into a .vsix file from its GitHub repository and install it in VS Codium, including troubleshooting common issues.

Since VS Codium doesn’t use the Visual Studio Marketplace by default, this guide shows how to manually package the Blender VSCode extension into a .vsix file and install it in VS Codium.

Prerequisites

Before starting, ensure you have the following installed:

• Node.js and npm: Required to run the vsce tool. Download from nodejs.org.
• Git: Needed to clone the repository. Download from git-scm.com.
• VS Codium: The open-source editor. Download from vscodium.com.

Steps to Create the .vsix File

To use the Blender VSCode extension in VS Codium, you need to package its source code into a .vsix file using the vsce tool. Follow these steps:

1. Clone the GitHub Repository

Open a terminal and clone the Blender VSCode extension repository:

git clone https://github.com/JacquesLucke/blender_vscode.git
cd blender_vscode

This downloads the source code, including the essential package.json file.

2. Install vsce

Install the vsce (Visual Studio Code Extension CLI) tool globally:

npm install -g vsce

Verify the installation:

vsce --version

3. Install Project Dependencies

Install all project dependencies, including TypeScript, which is required to compile the extension:

npm install

This ensures TypeScript (tsc) is available locally for the packaging process.

4. Package the Extension

Package the extension into a .vsix file:

vsce package

This generates a file like blender-development-1.0.0.vsix in the current directory, based on the version in package.json.

5. Troubleshoot "tsc not found" Error

If you see the error sh: 1: tsc: not found when running vsce package, it means the TypeScript compiler (tsc) isn’t found. Here’s how to fix it:

• Check Dependencies: Ensure npm install was run successfully. Verify TypeScript is installed by checking for ./node_modules/typescript/bin/tsc.

• Modify the Compile Script: If the error persists, open package.json and locate the scripts section. If "compile": "tsc -p ./" is present, change it to:

  "compile": "node ./node_modules/typescript/bin/tsc -p ./"

  Save the file and rerun vsce package. This uses the local TypeScript compiler explicitly.

For more on packaging extensions, see the VS Code Extension Publishing Documentation.

Installing the .vsix File in VS Codium

After creating the .vsix file, install it in VS Codium with these steps:

1. Open VS Codium

Launch VS Codium on your computer.

2. Access the Extensions View

Click the Extensions icon in the sidebar or press Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (Mac).

3. Install from VSIX

• Click the "..." (More Actions) button at the top of the Extensions view.
• Select "Install from VSIX...".
• Browse to your .vsix file (e.g., blender-development-1.0.0.vsix) and select it.
• VS Codium will install the extension and may prompt you to reload the editor.

4. Verify the Installation

• In the Extensions view, confirm the Blender Development extension is listed and enabled.
• Test it by opening the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and running a command like "Blender: New Addon".