Getting started with CodeXR

The sidebar reads top to bottom, and Servers is where you decide how CodeXR serves its scenes.

Protocol

HTTPS with generated local certificates, HTTPS with your own, or plain HTTP for development. VR headsets require HTTPS: WebXR will not start over an insecure connection.

Default port

The port new servers use.

Auto-open and open mode

Whether a server opens automatically when it launches, and whether it opens in your browser or in a side panel inside VS Code.

Cross-network connections

Enabled by default, so every server you start opens a secure outbound tunnel through Cloudflare. The first time, CodeXR asks permission to download cloudflared, exactly once. Decline and the feature turns itself off; re-enable it here whenever you want and it will ask again.

Active Servers has two parts: Collaboration, where you say who you are, and the list of what is running.

Local network address

For devices on your own wifi, a headset included.

Cross-network invitation link

Ready to copy and send, so several people can work inside the same instance. Guests never enter with the link alone: they also need a six-digit code that only you can give them.

Server controls

Open in browser, server information, stop.

Analysis is the most important section. At the top are your active analyses: click any of them for its details, to open it in the browser, to export it or to close it. Below that, the settings.

Default analysis type

One for files and one for directories.

LivePanel theme

How the 2D panels look inside VS Code.

Default chart type

For the XR experiences, separately for files and directories. This is mainly what shapes the classic analysis.

Default field mapping

Which metric drives each dimension of the chart.

Debounce and automatic re-analysis

How quickly a save triggers a re-analysis, tuned for real time by default, with automatic re-analysis on.

Sorting filters

For the Language and Project Structure trees.

Configuration profiles

So each project can keep its own setup.

The last three blocks are the ones you should rarely need.

Python Environment

Whether Python and the analysis dependencies are correctly installed. CodeXR manages its own isolated environment, so normally you never touch this.

Visualization Settings

How the scenes look, with a one-click reset.

Learn More and Support

The documentation, a little about the creator, and a way to support the project.

Right-click a folder and launch a project analysis in deep mode. CodeXR walks the entire codebase, every file and every function, then serves the scene locally and opens it in your browser.

Every analysis lives in a room with a handful of recurring pieces, and they are in the same place every time.

The people

Everyone connected appears as an avatar with their name floating above, each in their own colour.

The virtual screens

With their own panel to manage them.

The table

Also called the pedestal: where the data itself is rendered, with its controller on the corner closest to you.

The guide screen

Always within reach.

The room, in one frame

Create as many virtual screens as you need. Drag them, reposition them, resize them from the corners.

The virtual screens panelThe guide, in the roomThe Tips tab

On the corner of the table closest to you there is always a controller. It drives everything: the visualizations of the four analysis types, their settings, and the switch between them.

The analysis selector