retrovnc/README.md

# retrovnc

A fully headless Libretro frontend that exports a VNC server for display and input.

In layman terms, this lets you play games over VNC. Which isn't all that great, but hey.

This is mostly a "fun project" and consists mostly of code I already wrote.

# Dependencies

- A C++ toolchain
- A Rust toolchain.

# Building

`$ cargo b --release`

# Usage

Make the following directories where you will run retrovnc in:

- `config`
- `system`
- `save`

These folders are used either by retrovnc or cores to store data.

For the most basic usecase:

`$ retrovnc --core <CORE> --rom <ROM>` (see `retrovnc --help` for more options)

E.g: to use swanstation (assuming you have placed requirements in the system folder):

`retrovnc --core cores/swanstation_libretro.so --rom roms/my_game.cue`

After launching a core for the first time, a TOML file in config/ is created to allow you to set core options. You may use this file to set any option given by the core.