You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

105 lines
3.5 KiB

  1. ---
  2. uid: articles.command_line
  3. ---
  4. # The Command Line
  5. BSIPA has 2 command lines: the installer, and the game.
  6. Their documentation is below.
  7. ## [The Installer (`IPA.exe`)](#tab/installer)
  8. The installer has quite a few options, which are documented inline with the `-h` or `--help` flag.
  9. This is what it currently looks like:
  10. [!code[IPA command line](_ipa_command_line.txt "the result of IPA.exe -h")]
  11. ## [The Game](#tab/game)
  12. The game *also* gets quite a few command line options, though there isn't anything as convenient as a help page for them.
  13. Here's a quick list of what they are and what they do.
  14. - `--verbose`
  15. > Makes a console appear with log information at startup.
  16. >
  17. > Optionally, to start Beat Saber with an external console, an explicit `-pid` can be specified. This allows the game to be launched without being interrupted by Steam's "Allow game launch?" popup when directly launching `Beat Saber.exe` with arguments.
  18. > - Using PowerShell:
  19. > ```powershell
  20. > .\steam -applaunch 620980 --verbose -pid $PID
  21. > ```
  22. > - Using Command Prompt:
  23. > ```powershell
  24. > powershell -c ".\steam -applaunch 620980 --verbose -pid (Get-CimInstance Win32_Process -Filter ProcessId=$PID).ParentProcessId"
  25. > ```
  26. >
  27. - `--debug`
  28. > Enables the loading of debug information in Mono. The debugging information must be in the portable PDB format,
  29. > in the same location as the DLL that it's for.
  30. >
  31. > This option also forces BSIPA to show all debug messages in the console, as well as where they were called.
  32. >
  33. > This overrides the config settings `Debug.ShowDebug` and `Debug.ShowCallSource`.
  34. >
  35. - `--trace`
  36. > Enables trace level messages. By default, they do not ever enter the message queue, and thus cost almost nothing.
  37. > When this or the config option is used, they are added and logged with the same rules as Debug messages.
  38. >
  39. > This overrides the config setting `Debug.ShowTrace`.
  40. >
  41. - `--mono-debug`
  42. > Enables the built-in Mono soft debugger engine.
  43. >
  44. > By default, it acts as a client, and requires that there be a soft
  45. > debugger server running on port 10000 on `localhost`.
  46. >
  47. > Implies `--debug`.
  48. >
  49. - `--server`
  50. > Does nothing on its own.
  51. >
  52. > When paired with `--mono-debug`, this option makes the Mono soft debugger act in server mode. It begins listening on
  53. > port 10000 on any address, and will pause startup (with no window) until a debugger is connected. I recommend using
  54. > SDB, but that is a command line debugger and a lot of people don't care for those.
  55. >
  56. - `--no-yeet`
  57. > Disables mod yeeting.
  58. >
  59. > By default, whenever BSIPA detects that the game is now running a newer version than previous runs, it will move all
  60. > mods to another folder and not load them. (They still get checked for updates though.) When this is enabled, that
  61. > behaviour is disabled.
  62. >
  63. > Overrides the config setting `YeetMods`.
  64. >
  65. - `--condense-logs`
  66. > Reduces the number of log files BSIPA will output for a given session.
  67. >
  68. > By default, BSIPA will create a subfolder in the `Logs` folder for each mod sublog, as well as each mod. This disables
  69. > that behaviour, and restricts it to only create a global log and mod logs.
  70. >
  71. > Overrides the config setting `Debug.CondenseModLogs`.
  72. - `--plugin-logs`
  73. > Causes each plugins' log messages to be written to files in their own folder for ease of debugging.
  74. >
  75. > This was the default through 4.1.6, however is now disabled by default.
  76. >
  77. > Overrides the config setting `Debug.CreateModLogs`.
  78. ***