https://github.com/ianthehenry/bauble
a playground for making 3D art with lisp and math
https://github.com/ianthehenry/bauble
3d 3d-graphics art glsl graphics janet janet-lang lisp playground procedural-generation sdf sdfs shaders signed-distance-field signed-distance-functions wasm webassembly webgl
Last synced: 5 months ago
JSON representation
a playground for making 3D art with lisp and math
- Host: GitHub
- URL: https://github.com/ianthehenry/bauble
- Owner: ianthehenry
- License: mit
- Created: 2022-07-30T05:49:10.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-13T23:14:38.000Z (9 months ago)
- Last Synced: 2024-08-14T01:48:22.935Z (9 months ago)
- Topics: 3d, 3d-graphics, art, glsl, graphics, janet, janet-lang, lisp, playground, procedural-generation, sdf, sdfs, shaders, signed-distance-field, signed-distance-functions, wasm, webassembly, webgl
- Language: Janet
- Homepage: https://bauble.studio
- Size: 2.37 MB
- Stars: 353
- Watchers: 6
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - ianthehenry/bauble - a playground for making 3D art with lisp and math (Janet)
README
# [Bauble](https://bauble.studio)
Bauble is a toy for composing signed distance functions in a high-level language ([Janet](https://janet-lang.org/)), compiling them to [GLSL](https://www.khronos.org/opengl/wiki/OpenGL_Shading_Language), and rendering them via WebGL.
Try it out at , or watch this video introduction where I model an infinite number of hot air balloons:
[](https://www.youtube.com/watch?v=0-OtdjiR7dc&list=PLjT5GDnW_UMBS6ih0kG7jWB0n1SnotnEu)
Note that Bauble has changed (for the better!) quite a bit since that video, so it doesn't translate one to one. But it should be able to give you a good idea of the gist.
For more examples, I sometimes tweet videos of Bauble's development, which you can find here:
https://twitter.com/ianthehenry
# Dependencies
- For the CLI
- [`janet`](https://janet-lang.org/)
- For the web UI
- [`emscripten`](https://emscripten.org/)
- [`redo`](https://github.com/apenwarr/redo)
- [`yarn`](https://yarnpkg.com/)
- For tests
- [`pngcrush`](https://pmt.sourceforge.io/pngcrush/) (tests only)
Bauble requires at least Janet 1.36.0 (the first release with integer literal syntax). It may work with newer versions of Janet, assuming that the image format is compatible, but it's better to [update the version of Janet that Bauble includes](build/janet/janet-version) to match your local version if you want to upgrade.
To build the CLI, install Janet dependencies like this:
```
$ (cd src && jpm -l deps)
```
To build the web UI, install JavaScript dependencies as well:
```
$ yarn
$ (cd studio && yarn)
```
Bauble depends on [`codemirror-lang-janet`](https://github.com/ianthehenry/codemirror-lang-janet). If you want to make changes to the grammar, clone that repo and run [`yalc publish`](https://github.com/wclr/yalc) from the root of it. Then run `yalc link codemirror-lang-janet` in this repository, and you'll be able to see your changes locally.
# Development
To build the CLI:
```
$ (cd src && jpm -l build)
```
To run the CLI:
```
$ src/build/bauble help
```
To build the web UI:
```
$ redo
```
To create a minified, optimized build, use:
```
$ BUILD_MODE=prod redo
```
Lint the JS with:
```
(cd studio && yarn eslint .)
```
And you can serve a local Bauble like this:
```
$ node_modules/.bin/alive-server public
```
# Testing
There are two types of tests. Regular [Judge](https://github.com/ianthehenry/judge) unit tests:
```
$ (cd src && judge)
```
And snapshot tests, which require installing separate dependencies:
```
# you only have to do this once
$ (cd tests && jpm -l deps)
```
After installing dependencies, run tests like this:
```
$ (cd tests && jpm -l janet suite.janet)
```
Snapshot tests will write a file called `tests/summary.html`. It's not a very good file.
Before you commit snapshot changes, run:
```
$ (cd tests && jpm -l janet gc.janet)
```
Which will delete old snapshots and compress new ones. This depends on `pngcrush`.
# CLI
To run the Bauble CLI:
```
$ cd src
$ jpm -l deps
$ jpm -l build
$ build/bauble
```
Or, after installing dependencies, you can just invoke it with the interpreter:
```
$ cd src
$ jpm -l janet cli/init.janet
```
Currently the CLI is the only way to export high-resolution images, render images with non-square aspect ratios, view raw GLSL shader source, and export 3D meshes.