Browse Source

Generated Docs --

gh-pages
nike4613 3 years ago
parent
commit
8ecd33add0
12 changed files with 26 additions and 44 deletions
  1. +1
    -1
      api/index.html
  2. +3
    -24
      articles/command-line.html
  3. +1
    -1
      articles/contributing.html
  4. +1
    -1
      articles/dev-resources/description.html
  5. +1
    -1
      articles/index.html
  6. +1
    -1
      articles/start-dev.html
  7. +1
    -1
      articles/start-user.html
  8. +1
    -1
      index.html
  9. +1
    -1
      index.json
  10. +13
    -10
      manifest.json
  11. +1
    -1
      other_api/config/schema.html
  12. +1
    -1
      other_api/index.html

+ 1
- 1
api/index.html View File

@ -83,7 +83,7 @@ Select a namespace and a class on the left to get started.</p>
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/e16d96b3f7b22beeb0d4e0876e6e24c2f51d0d4d/docs/api/index.md/#L1" class="contribution-link">Improve this Doc</a>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/eaab81db0b2c96e5a4a92cc9e64693d4256d0141/docs/api/index.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>


+ 3
- 24
articles/command-line.html View File

@ -94,29 +94,8 @@
<section id="tabpanel_lvD3mivo-k_installer" role="tabpanel" data-tab="installer">
<p>The installer has quite a few options, which are documented inline with the <code>-h</code> or <code>--help</code> flag.</p>
<p>This is what it currently looks like:</p>
<pre><code name="IPA command line" title="the result of IPA.exe -h">usage:
IPA.exe [FLAGS] [ARGUMENTS]
flags:
-h, --help
prints this message
-v, --version
prints the version that will be installed and is currently installed
-w, --waitfor=PID
waits for the specified PID to exit
-f, --force
forces the operation to go through
-r, --revert
reverts the IPA installation
-n, --nowait
doesn&#39;t wait for user input after the operation
-s, --start=ARGUMENTS
uses the specified arguments to start the game after the patch/unpatch
-l, --launch
uses positional parameters as arguments to start the game after patch/unpatch
-R, --no-revert
prevents a normal installation from first reverting
</code></pre></section>
<!-- Can not find reference _ipa_command_line.txt -->
</section>
<section id="tabpanel_lvD3mivo-k_game" role="tabpanel" data-tab="game" aria-hidden="true" hidden="hidden">
<p>The game <em>also</em> gets quite a few command line options, though there isn&#39;t anything as convenient as a help page for them.</p>
<p>Here&#39;s a quick list of what they are and what they do.</p>
@ -184,7 +163,7 @@ that behaviour, and restricts it to only create a global log and mod logs.</p>
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/e16d96b3f7b22beeb0d4e0876e6e24c2f51d0d4d/docs/articles/command-line.md/#L1" class="contribution-link">Improve this Doc</a>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/eaab81db0b2c96e5a4a92cc9e64693d4256d0141/docs/articles/command-line.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>


+ 1
- 1
articles/contributing.html View File

@ -117,7 +117,7 @@ should reference the copy in there. When building for Release, it just uses the
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/e16d96b3f7b22beeb0d4e0876e6e24c2f51d0d4d/docs/articles/contributing.md/#L1" class="contribution-link">Improve this Doc</a>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/eaab81db0b2c96e5a4a92cc9e64693d4256d0141/docs/articles/contributing.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>


+ 1
- 1
articles/dev-resources/description.html View File

@ -91,7 +91,7 @@
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/e16d96b3f7b22beeb0d4e0876e6e24c2f51d0d4d/docs/articles/dev-resources/description.md/#L1" class="contribution-link">Improve this Doc</a>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/eaab81db0b2c96e5a4a92cc9e64693d4256d0141/docs/articles/dev-resources/description.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>


+ 1
- 1
articles/index.html View File

@ -94,7 +94,7 @@
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/e16d96b3f7b22beeb0d4e0876e6e24c2f51d0d4d/docs/articles/index.md/#L1" class="contribution-link">Improve this Doc</a>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/eaab81db0b2c96e5a4a92cc9e64693d4256d0141/docs/articles/index.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>


+ 1
- 1
articles/start-dev.html View File

@ -514,7 +514,7 @@ namespace Demo
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/e16d96b3f7b22beeb0d4e0876e6e24c2f51d0d4d/docs/articles/start-dev.md/#L1" class="contribution-link">Improve this Doc</a>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/eaab81db0b2c96e5a4a92cc9e64693d4256d0141/docs/articles/start-dev.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>


+ 1
- 1
articles/start-user.html View File

@ -161,7 +161,7 @@ the game directory, though your plugins will be moved to a different folder when
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/e16d96b3f7b22beeb0d4e0876e6e24c2f51d0d4d/docs/articles/start-user.md/#L1" class="contribution-link">Improve this Doc</a>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/eaab81db0b2c96e5a4a92cc9e64693d4256d0141/docs/articles/start-user.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>


+ 1
- 1
index.html View File

@ -101,7 +101,7 @@
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/e16d96b3f7b22beeb0d4e0876e6e24c2f51d0d4d/docs/index.md/#L1" class="contribution-link">Improve this Doc</a>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/eaab81db0b2c96e5a4a92cc9e64693d4256d0141/docs/index.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>


+ 1
- 1
index.json View File

@ -7,7 +7,7 @@
"articles/command-line.html": {
"href": "articles/command-line.html",
"title": "The Command Line",
"keywords": "The Command Line BSIPA has 2 command lines: the installer, and the game. Their documentation is below. The Installer ( IPA.exe ) The Game The installer has quite a few options, which are documented inline with the -h or --help flag. This is what it currently looks like: usage: IPA.exe [FLAGS] [ARGUMENTS] flags: -h, --help prints this message -v, --version prints the version that will be installed and is currently installed -w, --waitfor=PID waits for the specified PID to exit -f, --force forces the operation to go through -r, --revert reverts the IPA installation -n, --nowait doesn't wait for user input after the operation -s, --start=ARGUMENTS uses the specified arguments to start the game after the patch/unpatch -l, --launch uses positional parameters as arguments to start the game after patch/unpatch -R, --no-revert prevents a normal installation from first reverting The game also gets quite a few command line options, though there isn't anything as convenient as a help page for them. Here's a quick list of what they are and what they do. --verbose Makes a console appear with log information at startup. --debug Enables the loading of debug information in Mono. The debugging information must be in the portable PDB format, in the same location as the DLL that it's for. This option also forces BSIPA to show all debug messages in the console, as well as where they were called. This overrides the config settings Debug.ShowDebug and Debug.ShowCallSource . --trace Enables trace level messages. By default, they do not ever enter the message queue, and thus cost almost nothing. When this or the config option is used, they are added and logged with the same rules as Debug messages. This overrides the config setting Debug.ShowTrace . --mono-debug Enables the built-in Mono soft debugger engine. By default, it acts as a client, and requires that there be a soft debugger server running on port 10000 on localhost . Implies --debug . --server Does nothing on its own. When paired with --mono-debug , this option makes the Mono soft debugger act in server mode. It begins listening on port 10000 on any address, and will pause startup (with no window) until a debugger is connected. I recommend using SDB, but that is a command line debugger and a lot of people don't care for those. --no-yeet Disables mod yeeting. By default, whenever BSIPA detects that the game is now running a newer version than previous runs, it will move all mods to another folder and not load them. (They still get checked for updates though.) When this is enabled, that behaviour is disabled. Overrides the config setting YeetMods . --condense-logs Reduces the number of log files BSIPA will output for a given session. By default, BSIPA will create a subfolder in the Logs folder for each mod sublog, as well as each mod. This disables that behaviour, and restricts it to only create a global log and mod logs. Overrides the config setting Debug.CondenseModLogs . --plugin-logs Causes each plugins' log messages to be written to files in their own folder for ease of debugging. This was the default through 4.1.6, however is now disabled by default. Overrides the config setting Debug.CreateModLogs ."
"keywords": "The Command Line BSIPA has 2 command lines: the installer, and the game. Their documentation is below. The Installer ( IPA.exe ) The Game The installer has quite a few options, which are documented inline with the -h or --help flag. This is what it currently looks like: <!-- Can not find reference _ipa_command_line.txt --> The game also gets quite a few command line options, though there isn't anything as convenient as a help page for them. Here's a quick list of what they are and what they do. --verbose Makes a console appear with log information at startup. --debug Enables the loading of debug information in Mono. The debugging information must be in the portable PDB format, in the same location as the DLL that it's for. This option also forces BSIPA to show all debug messages in the console, as well as where they were called. This overrides the config settings Debug.ShowDebug and Debug.ShowCallSource . --trace Enables trace level messages. By default, they do not ever enter the message queue, and thus cost almost nothing. When this or the config option is used, they are added and logged with the same rules as Debug messages. This overrides the config setting Debug.ShowTrace . --mono-debug Enables the built-in Mono soft debugger engine. By default, it acts as a client, and requires that there be a soft debugger server running on port 10000 on localhost . Implies --debug . --server Does nothing on its own. When paired with --mono-debug , this option makes the Mono soft debugger act in server mode. It begins listening on port 10000 on any address, and will pause startup (with no window) until a debugger is connected. I recommend using SDB, but that is a command line debugger and a lot of people don't care for those. --no-yeet Disables mod yeeting. By default, whenever BSIPA detects that the game is now running a newer version than previous runs, it will move all mods to another folder and not load them. (They still get checked for updates though.) When this is enabled, that behaviour is disabled. Overrides the config setting YeetMods . --condense-logs Reduces the number of log files BSIPA will output for a given session. By default, BSIPA will create a subfolder in the Logs folder for each mod sublog, as well as each mod. This disables that behaviour, and restricts it to only create a global log and mod logs. Overrides the config setting Debug.CondenseModLogs . --plugin-logs Causes each plugins' log messages to be written to files in their own folder for ease of debugging. This was the default through 4.1.6, however is now disabled by default. Overrides the config setting Debug.CreateModLogs ."
},
"articles/contributing.html": {
"href": "articles/contributing.html",


+ 13
- 10
manifest.json View File

@ -18,19 +18,22 @@
"output": {
".html": {
"relative_path": "api/index.html",
"hash": "5DxRrnsvGf6ku1GDuO0VHATPoyui/OWiW2Qzs16xG64="
"hash": "zWsV31rjafH1tC0MNJW6p+WuEE5BHfe51Bq5gHtY4Ss="
}
},
"is_incremental": false,
"version": ""
},
{
"log_codes": [
"InvalidCodeSnippet"
],
"type": "Conceptual",
"source_relative_path": "articles/command-line.md",
"output": {
".html": {
"relative_path": "articles/command-line.html",
"hash": "5kIkSUhxpZKYsHs0KhKW+zri4go55VmOOsvxS0ZWUec="
"hash": "6RLTg31JUFi0OpkUCHnlPLyfGF0Btau+Bg1Kg2JoPuA="
}
},
"is_incremental": false,
@ -42,7 +45,7 @@
"output": {
".html": {
"relative_path": "articles/contributing.html",
"hash": "kfVCzjjqPVXciDzMenCSBL/uUZXV50cvr4RL4iXlcNE="
"hash": "UBUyUkIRwkk4UOMT6RLOxo/xnBivphxGeOUSe0Zl0/M="
}
},
"is_incremental": false,
@ -54,7 +57,7 @@
"output": {
".html": {
"relative_path": "articles/dev-resources/description.html",
"hash": "V2trQ4WTzzK3B2Tg/rsJgKHs7S9lHch112A6rcv9AKo="
"hash": "R+iN1l2QsnHJM9Mlc2WUPCKLpY3zH3ki9wQFiUDG3YU="
}
},
"is_incremental": false,
@ -66,7 +69,7 @@
"output": {
".html": {
"relative_path": "articles/index.html",
"hash": "iQhCwhOugG/FNT2bK1ALaFgMHNBkTFjaYOi5LiBfIa8="
"hash": "B77d6M8ErvUz7j0Ta52G0ws6VtaXNlG+a9CEC/QLb04="
}
},
"is_incremental": false,
@ -81,7 +84,7 @@
"output": {
".html": {
"relative_path": "articles/start-dev.html",
"hash": "xW3gxqHynZvS+Wo1g3iqDke4emNsUKJqLWxVTt/VgjY="
"hash": "TJYzh++N+nwZo8QACKjQEFu4RumTmQQZYgx4JkJmTvc="
}
},
"is_incremental": false,
@ -93,7 +96,7 @@
"output": {
".html": {
"relative_path": "articles/start-user.html",
"hash": "RoJIUZPEJcSzQLIygqZwuKr6Y+bUY2Qn2nzFdN3jDbE="
"hash": "mZpwPYSwDT+tVzq534CEh1jYVVoyHyH9fK98lEFPpsQ="
}
},
"is_incremental": false,
@ -183,7 +186,7 @@
"output": {
".html": {
"relative_path": "index.html",
"hash": "Ci2o2Wid2r3UI/QblR25nrpTuzUEB7UmQW9G1ASwU/Y="
"hash": "ySa08ivg/pedSUKGMNxO8GwSMmyomNBqlIo/Ev7m9Uk="
}
},
"is_incremental": false,
@ -198,7 +201,7 @@
"output": {
".html": {
"relative_path": "other_api/config/schema.html",
"hash": "qKYLQH2XVrM0oyn5KZ/SfinUTwXq8pJ5sAwFK/JB3g0="
"hash": "q4cKOCcrE9Ld/008uvSC8AeBAaEL+1IoB/ncy5qApa8="
}
},
"is_incremental": false,
@ -210,7 +213,7 @@
"output": {
".html": {
"relative_path": "other_api/index.html",
"hash": "eKbhxPAUR+Tq8jSBlb1MTRsW4dGh9ROTlIF2zzPBa4w="
"hash": "He1QNkoTNG3Ow9U2TSc/Ue5Q0fVB+lBhEyET5xPyrnE="
}
},
"is_incremental": false,


+ 1
- 1
other_api/config/schema.html View File

@ -89,7 +89,7 @@
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/e16d96b3f7b22beeb0d4e0876e6e24c2f51d0d4d/docs/other_api/config/schema.md/#L1" class="contribution-link">Improve this Doc</a>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/eaab81db0b2c96e5a4a92cc9e64693d4256d0141/docs/other_api/config/schema.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>


+ 1
- 1
other_api/index.html View File

@ -87,7 +87,7 @@
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/e16d96b3f7b22beeb0d4e0876e6e24c2f51d0d4d/docs/other_api/index.md/#L1" class="contribution-link">Improve this Doc</a>
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/eaab81db0b2c96e5a4a92cc9e64693d4256d0141/docs/other_api/index.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>


Loading…
Cancel
Save