diff --git a/tools/generate_emu_config/README.md b/tools/generate_emu_config/README.md new file mode 100644 index 00000000..f7823f45 --- /dev/null +++ b/tools/generate_emu_config/README.md @@ -0,0 +1,50 @@ +## What is this ? +This is a command line tool to generate the `steam_settings` folder for the emu, +you need a Steam account to grab most info, but you can use an anonymous account with limited access to Steam data. + +
+ +## Usage +```bash +generate_emu_config [options] [app id 2] [app id 3] ... +``` + +You'll be asked each time to enter your username and password. + +You can also place a file called `my_login.txt` beside this tool with the following data: +* Your **username** on the **first** line +* Your **password** on the **second** line + +**But beware though of accidentally distributing your login data when using this file**. +--- + +
+ +## Available **\[options\]** +To get all available options, run the tool without any arguments. +* `app id 1`: the ID of the first app, this is mandatory +* `app id `: multiple/more app IDs to grab the data for +* `-shots`: download some additional screenshots for the app/game +* `-thumbs`: download some additional thumbnails for the app/game +* `-vid`: attempt to download the trailer/promo video +* `-imgs`: download common Steam imgaes, this includes a poster, Steam generated background, icon(s), and some other assets +* `-name`: output the data in a folder with the name of the app/game, illegal characters are removed +* `-cdx`: generate `.ini` file to be used by CODEX emu, this is quite outdated and needs manual editiong +* `-aw`: generate all schemas for Achievement Watcher by xan105: https://github.com/xan105/Achievement-Watcher +* `-clean`: attempt to cleanup/remove the output folder from previous runs, if it exists, before downloading the data again +* `-anon`: use anonymous account to login to Steam instead of using your own, + note that this account has very limited access to data, and it can't download most info + +### Example + +```bash +generate_emu_config -shots -thumbs -vid -imgs -name -cdx -aw -clean 421050 480 +``` + +--- + +## Attributions and credits + +Windows icon by: [FroyoShark](https://www.iconarchive.com/artist/froyoshark.html) +License: [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) +Source: [icon archive: Steam Icon](https://www.iconarchive.com/show/enkel-icons-by-froyoshark/Steam-icon.html) diff --git a/tools/generate_emu_config/icon/LICENSE.md b/tools/generate_emu_config/icon/LICENSE.md new file mode 100644 index 00000000..4b109060 --- /dev/null +++ b/tools/generate_emu_config/icon/LICENSE.md @@ -0,0 +1,3 @@ +Icon by: [FroyoShark](https://www.iconarchive.com/artist/froyoshark.html) +License: [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) +Source: [icon archive: Steam Icon](https://www.iconarchive.com/show/enkel-icons-by-froyoshark/Steam-icon.html) diff --git a/tools/generate_emu_config/rebuild_linux.sh b/tools/generate_emu_config/rebuild_linux.sh index e195a3de..a5dea899 100644 --- a/tools/generate_emu_config/rebuild_linux.sh +++ b/tools/generate_emu_config/rebuild_linux.sh @@ -21,6 +21,7 @@ pyinstaller "$main_file" --distpath "$out_dir" -y --clean --onedir --name "$tool cp -f "steam_default_icon_locked.jpg" "$out_dir/$tool_name" cp -f "steam_default_icon_unlocked.jpg" "$out_dir/$tool_name" +cp -f "README.md" "$out_dir/$tool_name" echo; echo ============= diff --git a/tools/generate_emu_config/rebuild_win.bat b/tools/generate_emu_config/rebuild_win.bat index 9456112f..c100319a 100644 --- a/tools/generate_emu_config/rebuild_win.bat +++ b/tools/generate_emu_config/rebuild_win.bat @@ -32,6 +32,7 @@ pyinstaller "%main_file%" --distpath "%out_dir%" -y --clean --onedir --name "%to copy /y "steam_default_icon_locked.jpg" "%out_dir%\%tool_name%\" copy /y "steam_default_icon_unlocked.jpg" "%out_dir%\%tool_name%\" +copy /y "README.md" "%out_dir%\%tool_name%\" echo: echo =============