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.

97 lines
3.1 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. - `--debug`
  18. > Enables the loading of debug information in Mono. The debugging information must be in the portable PDB format,
  19. > in the same location as the DLL that it's for.
  20. >
  21. > This option also forces BSIPA to show all debug messages in the console, as well as where they were called.
  22. >
  23. > This overrides the config settings `Debug.ShowDebug` and `Debug.ShowCallSource`.
  24. >
  25. - `--trace`
  26. > Enables trace level messages. By default, they do not ever enter the message queue, and thus cost almost nothing.
  27. > When this or the config option is used, they are added and logged with the same rules as Debug messages.
  28. >
  29. > This overrides the config setting `Debug.ShowTrace`.
  30. >
  31. - `--mono-debug`
  32. > Enables the built-in Mono soft debugger engine.
  33. >
  34. > By default, it acts as a client, and requires that there be a soft
  35. > debugger server running on port 10000 on `localhost`.
  36. >
  37. > Implies `--debug`.
  38. >
  39. - `--server`
  40. > Does nothing on its own.
  41. >
  42. > When paired with `--mono-debug`, this option makes the Mono soft debugger act in server mode. It begins listening on
  43. > port 10000 on any address, and will pause startup (with no window) until a debugger is connected. I recommend using
  44. > SDB, but that is a command line debugger and a lot of people don't care for those.
  45. >
  46. - `--no-yeet`
  47. > Disables mod yeeting.
  48. >
  49. > By default, whenever BSIPA detects that the game is now running a newer version than previous runs, it will move all
  50. > mods to another folder and not load them. (They still get checked for updates though.) When this is enabled, that
  51. > behaviour is disabled.
  52. >
  53. > Overrides the config setting `YeetMods`.
  54. >
  55. - `--condense-logs`
  56. > Reduces the number of log files BSIPA will output for a given session.
  57. >
  58. > By default, BSIPA will create a subfolder in the `Logs` folder for each mod sublog, as well as each mod. This disables
  59. > that behaviour, and restricts it to only create a global log and mod logs.
  60. >
  61. > Overrides the config setting `Debug.CondenseModLogs`.
  62. >
  63. - `--no-updates`
  64. > Disables automatic updating.
  65. >
  66. > By default, BSIPA will check [BeatMods](http://beatmods.com) for all of the loaded mods to see if there is a new version
  67. > avaliable. If there is, it will be downloaded and installed on the next run. This flag disables that behaviour.
  68. >
  69. > Overrides the config settings `Updates.AutoCheckUpdates` and `Updates.AutoUpdate`.
  70. >
  71. ***