Skip to content

teaqu/shader-studio

Repository files navigation

Shader Studio

A GLSL fragment shader viewer for VS Code with hot reloading, designed specifically for Shadertoy-style shaders.

Marketplace: https://marketplace.visualstudio.com/items?itemName=teaqu.shader-studio
Docs: https://teaqu.github.io/shader-studio/

screenshot shader explorer screenshot

Installation

Install through VS Code extensions. Search for "Shader Studio".

Visual Studio Code Market Shader Studio

Development

Building the Extension

This repository is an npm workspace managed with Turborepo. Run build commands from the repository root unless a command says otherwise.

Prerequisites:

  • Node.js 18 or newer
  • npm 9 or newer

Install dependencies:

npm install

Build everything needed by the VS Code extension:

npm run build

That command builds the UI packages, copies their compiled assets into the extension package, and then builds the extension host code.

Useful targeted builds:

npm run build:types
npm run build:ui
npm run build:shader-explorer
npm run build:snippet-library
npm run build:extension

For extension packaging work, run the extension package script:

cd extension
npm run build

To create a .vsix package locally:

cd extension
npm run vsce-package

Docs

https://teaqu.github.io/shader-studio/

Docs are in /docs and configured with MkDocs (/mkdocs.yml).

Install dependencies:

python3 -m venv .venv
source .venv/bin/activate
pip install -r docs/requirements.txt
  • Local build: mkdocs build
  • Local preview: mkdocs serve

GitHub Pages deployment workflow is at .github/workflows/docs.yml.

Packages

 
 
 

Contributors