Skip to content

ch4ot1c/sanctuary

Repository files navigation

Sanctuary

Browse your code in peace.

Fly around in 3D and browse a directory tree.

Directories & Images Preview

View Code & Text Preview

Running

npm i -g serve
npm i

First, generate the directory listing from the example: ./scripts/list-directory.js example/

To run: serve -s -l 5001 View in your web browser: localhost:5001

To clone and add Github repos for viewing (in scripts/output/cloned-repos/), run: ./scripts/clone-and-list.js myorg/myrepo.

Supports

  • Images (.jpg, .png)
  • Code (.cpp, .c, .h)
  • Text (.md, .txt)

Future Features

  • More file & MIME types (.svg, .mp4)
  • q, e for flying upward, downward
  • Clear 3D default models for directories and files
  • Handlable UI (Focus, Move)
  • Collapsible directories
  • Secondary edges for file hyperlinks
  • Documentation generator support (Doxygen, JSDoc)
  • HTML5 filesystem support (bro-fs), for temporary cloned repos
  • Support for VR devices
  • Canvas-based image rendering option
  • 2D analog

About

Browse your files and codebases in 3D!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published