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.

76 lines
2.7 KiB

  1. # The Command Line
  2. BSIPA has 2 command lines: the installer, and the game.
  3. Their documentation is below.
  4. # [The Installer (`IPA.exe`)](#tab/installer)
  5. The installer has quite a few options, which are documented inline with the `-h` or `--help` flag.
  6. This is what it currently looks like:
  7. >
  8. > [!code[IPA command line](_ipa_command_line.txt "the result of IPA.exe -h")]
  9. >
  10. # [The Game](#tab/game)
  11. The game *also* gets quite a few command line options, though there isn't anything as convenient as a help page for them.
  12. Here's a quick list of what they are and what they do.
  13. - `--debug`
  14. >
  15. > Enables the loading of debug information in Mono. The debugging information must be in the portable PDB format,
  16. > in the same location as the DLL that it's for.
  17. >
  18. > This option also forces BSIPA to show all debug messages in the console, as well as where they were called.
  19. >
  20. > This overrides the config settings `Debug.ShowDebug` and `Debug.ShowCallSource`.
  21. >
  22. - `--mono-debug`
  23. >
  24. > Enables the built-in Mono soft debugger engine.
  25. >
  26. > By default, it acts as a client, and requires that there be a soft
  27. > debugger server running on port 10000 on `localhost`.
  28. >
  29. > Implies `--debug`.
  30. >
  31. - `--server`
  32. >
  33. > Does nothing on its own.
  34. >
  35. > When paired with `--mono-debug`, this option makes the Mono soft debugger act in server mode. It begins listening on
  36. > port 10000 on any address, and will pause startup (with no window) until a debugger is connected. I reccommend using
  37. > SDB, but that is a command line debugger and a lot of people don't care for those.
  38. >
  39. - `--no-yeet`
  40. >
  41. > Disables mod yeeting.
  42. >
  43. > By default, whenever BSIPA detects that the game is now running a newer version than previous runs, it will move all
  44. > mods to another folder and not load them. (They still get checked for updates though.) When this is enabled, that
  45. > behaviour is disabled.
  46. >
  47. > Overrides the config setting `YeetMods`.
  48. >
  49. - `--condense-logs`
  50. >
  51. > Reduces the number of log files BSIPA will output for a given session.
  52. >
  53. > By default, BSIPA will create a subfolder in the `Logs` folder for each mod sublog, as well as each mod. This disables
  54. > that behaviour, and restricts it to only create a global log and mod logs.
  55. >
  56. > Overrides the config setting `Debug.CondenseModLogs`.
  57. >
  58. - `--no-updates`
  59. >
  60. > Disables automatic updating.
  61. >
  62. > By default, BSIPA will check [BeatMods](http://beatmods.com) for all of the loaded mods to see if there is a new version
  63. > avaliable. If there is, it will be downloaded and installed on the next run. This flag disables that behaviour.
  64. >
  65. > Overrides the config settings `Updates.AutoCheckUpdates` and `Updates.AutoUpdate`.
  66. >