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.

100 lines
3.3 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, an explicit process ID can be specified to start the game with an external console. This allows it to be
  18. > launched via Steam without being interrupted by its "Allow game launch?" if launched directly from the `.exe`.
  19. >
  20. > Example for Beat Saber using PowerShell:
  21. >
  22. > ```
  23. > .\steam.exe -applaunch 620980 --verbose $PID
  24. > ```
  25. >
  26. > Do note that this isn't going to work from an elevated terminal.
  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. - `--trace`
  35. > Enables trace level messages. By default, they do not ever enter the message queue, and thus cost almost nothing.
  36. > When this or the config option is used, they are added and logged with the same rules as Debug messages.
  37. >
  38. > This overrides the config setting `Debug.ShowTrace`.
  39. - `--mono-debug`
  40. > Enables the built-in Mono soft debugger engine.
  41. >
  42. > By default, it acts as a client, and requires that there be a soft
  43. > debugger server running on port 10000 on `localhost`.
  44. >
  45. > Implies `--debug`.
  46. - `--server`
  47. > Does nothing on its own.
  48. >
  49. > When paired with `--mono-debug`, this option makes the Mono soft debugger act in server mode. It begins listening on
  50. > port 10000 on any address, and will pause startup (with no window) until a debugger is connected. I recommend using
  51. > SDB, but that is a command line debugger and a lot of people don't care for those.
  52. - `--no-yeet`
  53. > Disables mod yeeting.
  54. >
  55. > By default, whenever BSIPA detects that the game is now running a newer version than previous runs, it will move all
  56. > mods to another folder and not load them. (They still get checked for updates though.) When this is enabled, that
  57. > behaviour is disabled.
  58. >
  59. > Overrides the config setting `YeetMods`.
  60. - `--condense-logs`
  61. > Reduces the number of log files BSIPA will output for a given session.
  62. >
  63. > By default, BSIPA will create a subfolder in the `Logs` folder for each mod sublog, as well as each mod. This disables
  64. > that behaviour, and restricts it to only create a global log and mod logs.
  65. >
  66. > Overrides the config setting `Debug.CondenseModLogs`.
  67. - `--plugin-logs`
  68. > Causes each plugins' log messages to be written to files in their own folder for ease of debugging.
  69. >
  70. > This was the default through 4.1.6, however is now disabled by default.
  71. >
  72. > Overrides the config setting `Debug.CreateModLogs`.
  73. ***