Skip to content

Development Documentation

Oliver Steele edited this page Feb 20, 2023 · 2 revisions

The development documentation is split between the docs subdirectory of the repository, and this wiki.

Architecture

The application consists of a server and client, connected via the socket.

The server is both a web server (serving the web page to the browser), and a socket server. Multiple clients connect to the same server by requesting the web page from its address.

The server and client are written in the TypeScript language, and use the Vite build framework. They use the Socket.io for communication.

Single-Person Testing

It is easiest to test the software by yourself if you have two different webcams, that can see you from different angles. Otherwise, even if you pretend to be several performers (by running the page in two or three different browsers), they will all see the same image and create the same skeleton (or other avatar), and it is harder to tell whether it is working.

I use an external monitor that includes its own webcam, in addition to the one that is built into the laptop computer. But you can also attach a USB webcam to your laptop. We may have one that you can borrow.

image

Clone this wiki locally