Skip to content

Commit

Permalink
Automatic CI Documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Shynixn CI Actions committed Jun 16, 2024
1 parent 883abd6 commit b1c4c37
Show file tree
Hide file tree
Showing 15 changed files with 405 additions and 73 deletions.
6 changes: 3 additions & 3 deletions docs/wiki/site/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@


<link rel="icon" href="/assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">



Expand Down Expand Up @@ -126,7 +126,7 @@

</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
Expand Down Expand Up @@ -548,7 +548,7 @@ <h1>404 - Not found</h1>
<script id="__config" type="application/json">{"base": "/", "features": ["navigation.instant", "navigation.tabs", "content.tabs.link", "content.code.copy", "navigation.footer"], "search": "/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="/assets/javascripts/bundle.081f42fc.min.js"></script>
<script src="/assets/javascripts/bundle.ad660dcc.min.js"></script>


</body>
Expand Down
6 changes: 3 additions & 3 deletions docs/wiki/site/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">



Expand Down Expand Up @@ -135,7 +135,7 @@

</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
Expand Down Expand Up @@ -725,7 +725,7 @@ <h2 id="usage">Usage</h2>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.tabs", "content.tabs.link", "content.code.copy", "navigation.footer"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.081f42fc.min.js"></script>
<script src="../assets/javascripts/bundle.ad660dcc.min.js"></script>


</body>
Expand Down
6 changes: 3 additions & 3 deletions ...assets/javascripts/bundle.081f42fc.min.js → ...assets/javascripts/bundle.ad660dcc.min.js
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions ...ts/javascripts/bundle.081f42fc.min.js.map → ...ts/javascripts/bundle.ad660dcc.min.js.map
View file

Large diffs are not rendered by default.

221 changes: 216 additions & 5 deletions docs/wiki/site/commands/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">



Expand Down Expand Up @@ -135,7 +135,7 @@

</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
Expand Down Expand Up @@ -376,6 +376,30 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#command-petblock" class="md-nav__link">
<span class="md-ellipsis">
Command /petblock
</span>
</a>

<nav class="md-nav" aria-label="Command /petblock">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#petblock" class="md-nav__link">
<span class="md-ellipsis">
/petblock
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#command-petblocks" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -704,6 +728,57 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#command-petblocksgui" class="md-nav__link">
<span class="md-ellipsis">
Command /petblocksgui
</span>
</a>

<nav class="md-nav" aria-label="Command /petblocksgui">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#petblocksgui-open" class="md-nav__link">
<span class="md-ellipsis">
/petblocksgui open
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#petblocksgui-next" class="md-nav__link">
<span class="md-ellipsis">
/petblocksgui next
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#petblocksgui-back" class="md-nav__link">
<span class="md-ellipsis">
/petblocksgui back
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#petblocksgui-close" class="md-nav__link">
<span class="md-ellipsis">
/petblocksgui close
</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -895,6 +970,30 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#command-petblock" class="md-nav__link">
<span class="md-ellipsis">
Command /petblock
</span>
</a>

<nav class="md-nav" aria-label="Command /petblock">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#petblock" class="md-nav__link">
<span class="md-ellipsis">
/petblock
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#command-petblocks" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -1223,6 +1322,57 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#command-petblocksgui" class="md-nav__link">
<span class="md-ellipsis">
Command /petblocksgui
</span>
</a>

<nav class="md-nav" aria-label="Command /petblocksgui">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#petblocksgui-open" class="md-nav__link">
<span class="md-ellipsis">
/petblocksgui open
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#petblocksgui-next" class="md-nav__link">
<span class="md-ellipsis">
/petblocksgui next
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#petblocksgui-back" class="md-nav__link">
<span class="md-ellipsis">
/petblocksgui back
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#petblocksgui-close" class="md-nav__link">
<span class="md-ellipsis">
/petblocksgui close
</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -1254,8 +1404,12 @@ <h1 id="commands">Commands</h1>
<p class="admonition-title">Removing the pet under certain conditions</p>
<p>You can always take a way the <code>petblocks.pet.spawn</code> permission to remove the pet from players, if they enter certain areas (e.g. joining minigames, entering regions, etc.)</p>
</div>
<h2 id="command-petblock">Command /petblock</h2>
<p><strong>Required Permission:</strong>
<code>petblocks.command</code></p>
<h3 id="petblock">/petblock</h3>
<p>Opens the main GUI of petblocks. You can configure this command in the <code>gui/petblocks_main_menu.yml</code> file.</p>
<h2 id="command-petblocks">Command /petblocks</h2>
<p>PetBlocks does only have 1 command, which is restricted using permissions.</p>
<p><strong>Required Permission:</strong>
<code>petblocks.command</code></p>
<h3 id="petblocks-create">/petblocks create</h3>
Expand Down Expand Up @@ -1381,12 +1535,13 @@ <h3 id="petblocks-velocity">/petblocks velocity</h3>
<li>Player: Optional player_name/player_UUID parameter targeting a player from the console or command block.</li>
</ul>
<h3 id="petblocks-skintype">/petblocks skintype</h3>
<div class="highlight"><pre><span></span><code>/petblocks skintype &lt;name&gt; &lt;material&gt; [player]&quot;
<div class="highlight"><pre><span></span><code>/petblocks skintype &lt;name&gt; &lt;material&gt; [durability] [player]&quot;
</code></pre></div>
<p>Changes the material used as a head. </p>
<ul>
<li>Name: Identifier of a pet</li>
<li>Material: Minecraft material name e.g. STONE</li>
<li>Durability of the type. Only used in old minecraft versions &lt; 1.16.5. Set it to 0 in modern minecraft versions.</li>
<li>Player: Optional player_name/player_UUID parameter targeting a player from the console or command block.</li>
</ul>
<h3 id="petblocks-skinnbt">/petblocks skinnbt</h3>
Expand Down Expand Up @@ -1584,6 +1739,62 @@ <h3 id="petblocks-groundoffset">/petblocks groundoffset</h3>
<li>Offset: A numeric comma value. e.g. 0.3, -0.3, 1.0</li>
<li>Player: Optional player_name/player_UUID parameter targeting a player from the console or command block.</li>
</ul>
<h2 id="command-petblocksgui">Command /petblocksgui</h2>
<p><strong>Required Permission:</strong>
<code>petblocks.command</code></p>
<h3 id="petblocksgui-open">/petblocksgui open</h3>
<div class="highlight"><pre><span></span><code>/petblocksgui open &lt;name&gt; [arguments.../player]
</code></pre></div>
<p>Starts a new GUI session and opens the GUI with the given name for the executing player. If any other GUIs were open when executing this command, they get discarded from the navigation history.</p>
<ul>
<li>Name: Identifier of a GUI menu</li>
<li>Argument/Player: Optional arguments to provide the GUI with additional arguments and optionally a player to open the GUI for.</li>
</ul>
<p>Samples:</p>
<ul>
<li>Opens the inventory for the executing player.</li>
</ul>
<div class="highlight"><pre><span></span><code>/petblocksgui open simple_sample_menu
</code></pre></div>
<ul>
<li>Opens the inventory for the player named "Pikachu".</li>
<li>The slash separates arguments with the player name (in this case there are 0 arguments)</li>
</ul>
<div class="highlight"><pre><span></span><code>/petblocksgui open simple_sample_menu / Pikachu
</code></pre></div>
<ul>
<li>Opens the inventory with additional arguments which can be accessed via the placeholders. <code>%petblocks_gui_param1%</code> is now <code>123456</code>.</li>
</ul>
<div class="highlight"><pre><span></span><code>/petblocksgui open simple_sample_menu 123456
</code></pre></div>
<ul>
<li>Opens the inventory with additional arguments which can be accessed via the placeholders for the player named "Pikachu". <code>%petblocks_gui_param1%</code> is now <code>123456</code> <code>%petblocks_gui_param2%</code> is now <code>abcde</code>.</li>
<li>The slash separates arguments with the player name</li>
</ul>
<div class="highlight"><pre><span></span><code>/petblocksgui open simple_sample_menu 123456 abcde / Pikachu
</code></pre></div>
<h3 id="petblocksgui-next">/petblocksgui next</h3>
<div class="highlight"><pre><span></span><code>/petblocksgui next &lt;name&gt; [arguments.../player]
</code></pre></div>
<p>Reuses the existing GUI session (or starts a new one if it is not available) and opens the GUI with the given name for the executing player. If any other GUIs were open when executing this command, they get put into the navigation history. Executing <code>/petblocksgui back</code> reopens the previous GUI.</p>
<ul>
<li>Name: Identifier of a GUI menu</li>
<li>Argument/Player: Optional arguments to provide the GUI with additional arguments. See the open command for samples.</li>
</ul>
<h3 id="petblocksgui-back">/petblocksgui back</h3>
<div class="highlight"><pre><span></span><code>/petblocksgui back [player]
</code></pre></div>
<p>Checks if the current GUI session contains a previously opened GUI. If that is the case, the previous GUI is opened and the current GUI is discarded. If not GUI is found, the current GUI is simply closed.</p>
<ul>
<li>Player: Optional player argument to execute the action for another player.</li>
</ul>
<h3 id="petblocksgui-close">/petblocksgui close</h3>
<div class="highlight"><pre><span></span><code>/petblocksgui close [player]
</code></pre></div>
<p>Closes the current GUI and clears the GUI session and navigation history.</p>
<ul>
<li>Player: Optional player argument to execute the action for another player.</li>
</ul>



Expand Down Expand Up @@ -1670,7 +1881,7 @@ <h3 id="petblocks-groundoffset">/petblocks groundoffset</h3>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.tabs", "content.tabs.link", "content.code.copy", "navigation.footer"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.081f42fc.min.js"></script>
<script src="../assets/javascripts/bundle.ad660dcc.min.js"></script>


</body>
Expand Down
6 changes: 3 additions & 3 deletions docs/wiki/site/custommodels/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">



Expand Down Expand Up @@ -135,7 +135,7 @@

</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
Expand Down Expand Up @@ -704,7 +704,7 @@ <h2 id="tutorial">Tutorial</h2>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.tabs", "content.tabs.link", "content.code.copy", "navigation.footer"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.081f42fc.min.js"></script>
<script src="../assets/javascripts/bundle.ad660dcc.min.js"></script>


</body>
Expand Down
Loading

0 comments on commit b1c4c37

Please sign in to comment.