modeco80/retrovnc
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

update README

Browse source
This commit is contained in:
Lily Tsuru 2024-08-06 22:12:26 -04:00
parent 9e2324fc4a
commit 470aecf08e
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -17,9 +17,21 @@ This is mostly a "fun project" and consists mostly of code I already wrote.
# 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)
For disc-based titles it is probably a good idea to pass the cuesheet file. I will implement stuff later to make this less annoying.
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.