magicshader - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #llm #deep-learning #java #windows #awesome #kubernetes #vue #mcp #ios #openai #open-source

magicshader

(★ 247)

🔮 Tiny helper for three.js to debug and write shaders

파일 탐색기

최종 버전 다운로드 (.zip)

- example.js
- index.html
- 1.gif
- full.gif
- spector.gif
.gitignore
.npmignore
index.js
package.json
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/luruke/magicshader

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd magicshader

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm i -D magicshader

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🔮 MagicShader

> ⚠️ probably won't work with modern version of threejs, last time I tested was with r114  
> pr is welcome

A thin wrapper on top of `RawShaderMaterial`, that allows to easily create new uniforms and live-edit them via `dat.gui`.

No need to create the uniforms manually and bind them with `dat.gui`.  
Just write some comments in your GLSL, and everything will work magically ✨

## 🕵️‍♂️ How to use
Install via npm

```
npm i -D magicshader
```

and just use it instead of `RawShaderMaterial`:

```javascript
import MagicShader from 'magicshader';

const material = new MagicShader({...})
```

The parameters are exactly the same.

## 🤷‍♀️ Ok...where the magic is?

Now you can add the `// ms({})`  magic comment after your uniforms.

Example:

```javascript
const material = new MagicShader({
  vertexShader: `
    precision highp float;
    
    attribute vec3 position;
    uniform mat4 modelViewMatrix;
    uniform mat4 projectionMatrix;
    
    void main() {
      gl_Position = projectionMatrix * modelViewMatrix * vec4(position, 1.0);
    }
  `,
  fragmentShader: `
    precision highp float;

uniform vec3 color; // ms({ value: '#ff0000' })

void main() {
      gl_FragColor = vec4(color, 1.0);
    }
  `
});
```

This will give you:  
![1](https://raw.githubusercontent.com/luruke/magicshader/master/images/1.gif "1")

No need to init your uniform or bind `dat.gui`.  
You can just work on your GLSL files.

## 👨‍💻 What else?
```javascript
const material = new MagicShader({
  name: 'Cube Shader!',
  vertexShader: `
    precision highp float;
    
    attribute vec3 position;
    uniform mat4 modelViewMatrix;
    uniform mat4 projectionMatrix;

uniform vec3 translate; // ms({ value: [0, 0, 0], step: 0.01 })
    uniform float scale; // ms({ value: 0.5, options: { small: 0.5, medium: 1, big: 2 } })
    uniform mat4 aMatrix4; // ms({ value: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] })

void main() {
      vec3 pos = position + translate;
      pos *= scale;

gl_Position = projectionMatrix * modelViewMatrix * vec4(pos, 1.0);
    }
  `,
  fragmentShader: `
    precision highp float;
    
    uniform vec3 color; // ms({ value: '#ff0000' })
    uniform float brightness; // ms({ value: 0, range: [0, 0.5], step: 0.1 })
    uniform vec2 dummyValue; // ms({ value: [1024, 768], range: [[0, 2000], [0, 1500]] })
    uniform bool visible; // ms({ value: 1, name: 'Visibility' })
    uniform int test; // ms({ value: 0 })

void main() {
      gl_FragColor = vec4(color + brightness, 1.0);
    }
  `
});
```

Will result in:  
![full](https://raw.githubusercontent.com/luruke/magicshader/master/images/full.gif "full")

## 🕵️‍ SpectorJS

With the [SpectorJS extension](https://github.com/BabylonJS/Spector.js/blob/master/documentation/extension.md) enabled, you can live-edit the shaders. You can even add and modify "magic" uniforms on the fly.

![full](https://raw.githubusercontent.com/luruke/magicshader/master/images/spector.gif "full")

## 💅 Ok, cool. Just finished my app and I'm ready to deploy

Then you can hide the `dat.gui` UI
```javascript
import MagicShader, { gui } from 'magicshader';
gui.destroy();
```

## 😴 TODO

- [ ] Do more tests...
- [ ] add support for sampler2D and FBO?
- [ ] check if it works with firefox/safari shader editor
- [ ] inspect/edit threejs default uniforms (like `projectionMatrix`)