Skip to content

Commit

Permalink
#15 readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
kozaka-tv committed Jun 3, 2024
1 parent 0f750dd commit dc58316
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
This project was made to help you to use Rocksmith and make a connection between
Rocksmith (RS), Rock Sniffer, RS Playlist, Custom Forge Song Manager (CFSM) and so on during streaming.

A complete documentation will be provided later.

Main functions (this is just a raw list now):

- Loads a song from the archive of the user according to the playlist request to the Rocksmith (or with the CFSM
monitored directory)
- Creates a setlist what is contains the played songs
- Moves a downloaded file (even over LAN) to the CFSM monitored directory and retry it if CFSM does not loaded properly.
- Creates a setlist what is contains all in the Rocksmith played songs
- Moves a downloaded files to the CFSM monitored directory for parsing
- Do a retry of moving in case CFSM does not recognize the new files properly.

# How to install

TODO
- download the latest version (exe or source)
- run the application (run.exe or run.py)
- change the created config.ini file according to your needs
- run the application again

# How to use

Expand All @@ -27,6 +29,5 @@ TODO
TODO

Hints:

- As default all modules are disabled.
- To enable or disable a module, enter True/False, 0/1 or yes/no
- To enable or disable a module, enter true/false, 0/1 or yes/no

0 comments on commit dc58316

Please sign in to comment.