Skip to content
byebyebryanPublic

Repository files navigation

Cubey

Cubey is a personal graphics and simulation workshop built with C++20 and Vulkan. Focused projects explore rendering, fluids, procedural environments, materials, and authored forms, with a shared foundation that grows from their needs.

Explore the demos → dev.byebyebryan.com/cubey

Build and run · Project guides · Architecture · Roadmap

Build and run

You need Clang 16+ with C++20 support, CMake 3.25+, Ninja, Git, pkg-config, OpenSSL and Vulkan development packages, a working Vulkan driver, and glslangValidator. Tests require Python 3.11+. See the setup guide for distribution packages and window-backend dependencies.

cmake --preset dev
cmake --build --preset dev
ctest --preset dev

Launch a project, for example:

./build/dev/projects/ocean/ocean

The build and run guide covers sample assets, configuration, controls, headless PNG/MP4 capture, and focused validation. Native projects own their scenes and simulation; the shared foundation supplies Vulkan resources, rendering, assets, host/windowing, and capture.

Repository

Location Contents
projects/ Runnable projects and their technical guides.
include/cubey/, src/cubey/ Public contracts and shared implementation.
examples/ Small foundation examples.
studies/ Retained experiments and paused studies.
site/ Presentation site, selected media, credits, and Pages publishing.
tools/ Repository checks and the local result-report browser.
docs/ Setup, design, architecture, evidence, and history.

Build the presentation site independently with npm ci and npm run verify from site/. It uses tracked captures and needs no native executable or GPU; see the site guide for media preparation and publishing.

Active development lives on main. The original OpenGL shader playground is preserved on legacy. See the design and changelog for repository context and implementation history.

License

Cubey source and original project media use the MIT License. Imported assets retain their own licenses and attribution, listed in the site media guide and public credits. The retained README gallery package preserves its original capture recipes and the Damaged Helmet media-only CC-BY-NC-4.0 exception.

Releases

Packages

Used by

Contributors

Languages