Skip to content

@tmrw-realityos/charm


Project Charm

Reality OS Graphics experimental frontend

Prerequisites

See README.md in the repository root.

Running charm folder

bash
pnpm build # builds every subprojects recursively
pnpm lint # runs ts-standard in all sub projects
pnpm test # runts all "test" scripts recursively
pnpm release # releases the charm package

Writing unit tests

Remember to import new unit tests from test/tests.ts.

Running The Other Example Web Apps

bash
pnpm -C ../charm-examples/gltf-demo dev
pnpm -C ../charm-examples/bvh-example dev
pnpm -C ../charm-examples/example-raytracer dev

Head to http://localhost:5173

Editor configurations

VSCode

Suggested extensions:

  • ESLint
  • Deno (set deno.enablePaths to ./packages/charm/test)

Also exclude dist/ folder from search to avoid modifying autogenerated code.

Sublime

Suggested packages:

** LSP ** LSP-typescript ** LSP-eslint ** LSP-deno