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 Aug 14, 2024
1 parent de87527 commit 840018d
Show file tree
Hide file tree
Showing 4 changed files with 103 additions and 33 deletions.
133 changes: 101 additions & 32 deletions docs/wiki/site/permission/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,24 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#minimum-required-permissions" class="md-nav__link">
<span class="md-ellipsis">
Minimum Required Permissions
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#all-permissions" class="md-nav__link">
<span class="md-ellipsis">
All Permissions
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -581,6 +599,24 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#minimum-required-permissions" class="md-nav__link">
<span class="md-ellipsis">
Minimum Required Permissions
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#all-permissions" class="md-nav__link">
<span class="md-ellipsis">
All Permissions
</span>
</a>

</li>

</ul>
Expand All @@ -603,13 +639,41 @@

<h1 id="permission">Permission</h1>
<p>The following permissions are available in PetBlocks.</p>
<h4 id="levels">Levels</h4>
<h3 id="levels">Levels</h3>
<ul>
<li>User: A permission all players can have.</li>
<li>Admin: A permission only Admins should have.</li>
<li>Admin/User: Depending on your server, you may give this permission to your players. If you are not sure, try to build
your server around <strong>not giving this permission</strong> to your players.</li>
<li>Admin: A permission only Admins should have.</li>
</ul>
<h3 id="minimum-required-permissions">Minimum Required Permissions</h3>
<table>
<thead>
<tr>
<th>Permission</th>
<th>Level</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>petblocks.command</td>
<td>User</td>
<td>Allows to use the /petblocks command.</td>
</tr>
<tr>
<td>petblocks.pet.spawn</td>
<td>User</td>
<td>Required permission to see the pet. If you remove this permission from a player, the pet automatically despawns.</td>
</tr>
<tr>
<td>petblocks.pet.amount.1</td>
<td>User</td>
<td>The slot where the pet is stored. 1 is the default slot.</td>
</tr>
</tbody>
</table>
<h3 id="all-permissions">All Permissions</h3>
<table>
<thead>
<tr>
Expand All @@ -625,6 +689,21 @@ <h4 id="levels">Levels</h4>
<td>Allows to use the /petblocks command.</td>
</tr>
<tr>
<td>petblocks.pet.spawn</td>
<td>User</td>
<td>Required permission to see the pet. If you remove this permission from a player, the pet automatically despawns.</td>
</tr>
<tr>
<td>petblocks.pet.amount.1</td>
<td>User</td>
<td>The slot where the pet is stored. 1 is the default slot.</td>
</tr>
<tr>
<td>petblocks.pet.amount.[number]</td>
<td>User</td>
<td>The slot where the pet is stored. e.g. petblocks.pet.amount.1 (slot 1) and petblocks.pet.amount.2 (slot 2)</td>
</tr>
<tr>
<td>petblocks.gui.petblocks_main_menu</td>
<td>User</td>
<td>Allows to access the main GUI of PetBlocks.</td>
Expand Down Expand Up @@ -670,26 +749,11 @@ <h4 id="levels">Levels</h4>
<td>Allows to see the help messages.</td>
</tr>
<tr>
<td>petblocks.reload</td>
<td>Admin</td>
<td>Permission to use the /petblocks reload command.</td>
</tr>
<tr>
<td>petblocks.pet.create</td>
<td>Admin/User</td>
<td>Allows to create a new pet. This command should probably be executed by a GUI / Sign / Server Management Plugin. If you set receivePetsOnJoin in the config.yml, you do not need this permission.</td>
</tr>
<tr>
<td>petblocks.pet.call</td>
<td>User</td>
<td>Allows to call the pet to the owner.</td>
</tr>
<tr>
<td>petblocks.pet.spawn</td>
<td>User</td>
<td><strong>Minimum required permission</strong> a player has to have in order to have a pet. If you remove this permission from a player, the pet automatically despawns.</td>
</tr>
<tr>
<td>petblocks.pet.ride</td>
<td>User</td>
<td>Allows to ride a pet.</td>
Expand All @@ -710,11 +774,6 @@ <h4 id="levels">Levels</h4>
<td>Allows to list the pets of a player</td>
</tr>
<tr>
<td>petblocks.pet.delete</td>
<td>Admin/User</td>
<td>Allows to delete a pet. It depends on the type of server if you want to give this permission to your players. This command should be executed by a GUI / Sign / Server Management Plugin.</td>
</tr>
<tr>
<td>petblocks.pet.displayName</td>
<td>User</td>
<td>Allows to rename a pet.</td>
Expand All @@ -730,6 +789,16 @@ <h4 id="levels">Levels</h4>
<td>Allows to despawn at pet.</td>
</tr>
<tr>
<td>petblocks.pet.create</td>
<td>Admin/User</td>
<td>Allows to create a new pet. This command should probably be executed by a GUI / Sign / Server Management Plugin. If you set receivePetsOnJoin in the config.yml, you do not need this permission.</td>
</tr>
<tr>
<td>petblocks.pet.delete</td>
<td>Admin/User</td>
<td>Allows to delete a pet. It depends on the type of server if you want to give this permission to your players. This command should be executed by a GUI / Sign / Server Management Plugin.</td>
</tr>
<tr>
<td>petblocks.pet.skin</td>
<td>Admin/User</td>
<td>Allows to change the skin via command. This command should probably be executed by a GUI / Sign / Server Management Plugin.</td>
Expand Down Expand Up @@ -795,11 +864,6 @@ <h4 id="levels">Levels</h4>
<td>Allows to change the template of a pet.</td>
</tr>
<tr>
<td>petblocks.pet.manipulateOther</td>
<td>Admin</td>
<td>Allows to manipulate the pets of other players. e.g. Changing skins, etc.</td>
</tr>
<tr>
<td>petblocks.pet.select</td>
<td>Admin/User</td>
<td>Allows to mark a pet as selected. This is helpful for placeholders.</td>
Expand All @@ -815,11 +879,6 @@ <h4 id="levels">Levels</h4>
<td>If you give your players access to <code>petblocks.pet.create</code>, each individual template is still locked by this permission.</td>
</tr>
<tr>
<td>petblocks.pet.amount.[number]</td>
<td>Admin/User</td>
<td>If you give your players access to <code>petblocks.pet.create</code>, the access to the slot where the pet is stored. e.g. petblocks.pet.amount.1 (slot 1) and petblocks.pet.amount.2 (slot 2)</td>
</tr>
<tr>
<td>petblocks.pet.breakBlock</td>
<td>Admin/User</td>
<td>Allows to use the /petblocks breakblock command</td>
Expand Down Expand Up @@ -864,6 +923,16 @@ <h4 id="levels">Levels</h4>
<td>Admin</td>
<td>Allows to use the /petblocks variable command</td>
</tr>
<tr>
<td>petblocks.pet.manipulateOther</td>
<td>Admin</td>
<td>Allows to manipulate the pets of other players. e.g. Changing skins, etc.</td>
</tr>
<tr>
<td>petblocks.reload</td>
<td>Admin</td>
<td>Permission to use the /petblocks reload command.</td>
</tr>
</tbody>
</table>

Expand Down
1 change: 1 addition & 0 deletions docs/wiki/site/receivingpets/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,7 @@ <h1 id="giving-pets-to-players">Giving Pets to Players</h1>
with template <code>classic</code> for you and makes it spawn in front of you. If you cannot see the pet, try executing <code>/petblocks call pet</code> or review your permissions again.</p>
<p><strong>Make sure your players have this permission to see their pet:</strong>
<div class="highlight"><pre><span></span><code>petblocks.pet.spawn
petblocks.pet.amount.1
</code></pre></div></p>
<p>The next step is to decide, how you want your players to receive a pet. There are multiple options below.</p>
<h2 id="receiving-a-pet-on-first-join">Receiving a pet on first join</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/site/search/search_index.json

Large diffs are not rendered by default.

Binary file modified docs/wiki/site/sitemap.xml.gz
Binary file not shown.

0 comments on commit 840018d

Please sign in to comment.