docs: Updated tags and commands info.
This commit is contained in:
Sekwah
parent
49175c03e6
commit
418ed703b7
|
|
@ -4,3 +4,99 @@ sidebar_position: 2
|
|||
|
||||
# Commands
|
||||
|
||||
All commands included in Advanced Portals are listed below along with their permissions.
|
||||
|
||||
**Note:** all `/portal` commands can also be used with `/advancedportals` or `/aportals` instead.
|
||||
|
||||
Same goes for all /destination commands can be used with /desti
|
||||
|
||||
Also if you want blocks such as nether portals not to break when being placed you will need to define the portal before placing them. This is so the physics updates know not to mess with vanilla portals being broken or other plugins :)
|
||||
|
||||
|
||||
## Portal Command
|
||||
Usable Alias: `/portal` `/ap` `/portals` `/aportal` `/advancedportals`
|
||||
|
||||
### `/portal create (tags...)`
|
||||
|
||||
**Permission:** `advancedportals.portal`
|
||||
|
||||
This command is used to create a portal. The behaviour of the portal can be determined by the tags given (see list below), but a name must tag must always be given `name:some_name_here`
|
||||
|
||||
|
||||
As a side note, make sure to check the `triggerblock:` has been set if you are not using nether portal blocks. These are blocks that **you need to be INSIDE** so blocks such as water and even cobwebs will work, but cobblestone will not be a suitable triggerblock.
|
||||
|
||||
For a list of tags and info, check out the [tags page](./portal-tags.md).
|
||||
|
||||
### `/portal selector` or `/portal wand`
|
||||
|
||||
**Permission:** `advancedportals.createportal`
|
||||
|
||||
This gives you the mighty portal axe, if UseOnlyServerMadeAxe is true then this one will still work, but the normal iron axe will still be available to be used in survival for admins. (instead of always trying to make portals)
|
||||
|
||||
### `/portal portalblock`
|
||||
|
||||
**Permission:** `advancedportals.portal`
|
||||
|
||||
Gives you a portal block that you can build with. (If the rotation is in the wrong place one next to it and then replace it to get the right rotation)
|
||||
|
||||
### `/portal endportalblock`
|
||||
|
||||
**Permission:** `advancedportals.portal`
|
||||
|
||||
Gives you an end portal block that you can build with.
|
||||
|
||||
### `/portal gatewayblock`
|
||||
|
||||
**Permission:** `advancedportals.portal`
|
||||
|
||||
Gives you an end gateway block that you can build with.
|
||||
|
||||
### `/portal disablebeacon (portalname)`
|
||||
|
||||
**Permission:** `advancedportals.build`
|
||||
|
||||
Needs DisableGatewayBeam to be set to true in the config. Though also triggers on create or chunk load. This is just a backup method.
|
||||
|
||||
### `/portal select`
|
||||
|
||||
**Permission:** `advancedportals.createportal`
|
||||
|
||||
After the command is entered, punch inside a portal region, and it will select that portal.
|
||||
|
||||
### `/portal unselect`
|
||||
|
||||
**Permission:** `advancedportals.createportal`
|
||||
|
||||
Use to remove the current portal selection. (as it can mess with certain commands)
|
||||
|
||||
### `/portal remove`
|
||||
|
||||
**Permission:** `advancedportals.removeportal`
|
||||
|
||||
Enter this command to destroy a portal with a set name. If the argument is left blank, it will destroy the currently selected portal.
|
||||
|
||||
### `/portal help`
|
||||
|
||||
Displays the help message.
|
||||
|
||||
## Destination Command
|
||||
|
||||
Usable Alias: `/desti` `/destination`
|
||||
|
||||
Permission (applies to all): `advancedportals.desti`
|
||||
|
||||
### `/desti create`
|
||||
|
||||
This the command creates a new destination with the location data from your player (your player position and direction your facing).
|
||||
|
||||
### `/desti remove`
|
||||
|
||||
Remove a destination with a specific name. (portals will still attempt to warp to this name but say no destination exists)
|
||||
|
||||
### `/desti list`
|
||||
|
||||
A list of created destinations.
|
||||
|
||||
### `/desti warp (desti name)`
|
||||
|
||||
Teleport to the named destination.
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@ sidebar_position: 1
|
|||
|
||||
# Tutorial Intro
|
||||
|
||||
I will be writing a more in depth tutorial soon.
|
||||
I still need to create a written tutorial about how to use this.
|
||||
|
||||
For now, here is a YouTube video explaining the basics.
|
||||
For now, here is a YouTube video made by [LtJim007](https://www.youtube.com/channel/UCZvGH5UFnZGHL7t11RLhg2w) explaining the basics.
|
||||
|
||||
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/nkOeMUkYz3Y" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
|
|
|
|||
|
|
@ -3,3 +3,68 @@ sidebar_position: 3
|
|||
---
|
||||
|
||||
# Portal Tags
|
||||
|
||||
Below is a list of currently accepted tags for portals. Only the name: tag is necessary though other tags may be needed to give the portal's functionality.
|
||||
|
||||
Example use: `/portal create name:testportal desti:somedesti triggerblock:WATER`
|
||||
|
||||
## Necessary Tags
|
||||
|
||||
### `name:(name for portal)`
|
||||
|
||||
Sets the name for the portal. These have to be unique across the whole server.
|
||||
|
||||
## Available Tags
|
||||
|
||||
These add or alter specific functionality for the portals.
|
||||
|
||||
### `destination:(destination name)` or `desti:(destination name)`
|
||||
|
||||
Sets the desired destination for the portal. If this is defined if the portal is triggered, the player will be teleported to the desired location.
|
||||
|
||||
### `delayed:true`
|
||||
|
||||
The portal uses the portal event rather than movement events. Will trigger with a delay on portal events. While this does the normal delayed behaviour for nether portals (instant if you are in creative), the end portals will trigger instantly anyway as that is normal behaviour for them.
|
||||
|
||||
### `triggerblock:(material)`
|
||||
|
||||
Sets the material of the trigger block of the portal. This is the material that you need to be inside to trigger the portal. Suggestions/Tab complete will work for the names though they are in block caps and use the spigot names
|
||||
|
||||
|
||||
[A full list of materials for 1.13+ can be found here](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html)
|
||||
|
||||
[And a 1.12 and below list here](https://helpch.at/docs/1.12.2/org/bukkit/Material.html)
|
||||
|
||||
The most common types generally used are `NETHER_PORTAL`, `END_PORTAL`, `END_GATEWAY` and `WATER`
|
||||
|
||||
### `bungee:(server_name)`
|
||||
|
||||
Specifies which server to send the player too if connected through bungee. It needs to be the same as whatever you would use for `/server (server_name)` to swap manually.
|
||||
|
||||
### `message:(word)` or `message:"(some sentence you want)"`
|
||||
|
||||
Sets the warp message for the portal. Colour codes can be used e.g. &c is red. [See here for color codes](https://minecraft.gamepedia.com/Formatting_codes).
|
||||
|
||||
### `permission:(some.custom.test.perms)`
|
||||
|
||||
Sets what permission you need to use the portal(can be customised to anything)
|
||||
|
||||
### `command:(command) or command:"(multi-word command)"`
|
||||
|
||||
Whatever is typed in here the player will execute as a command, there are several flags you can use listed below to alter the execution, however only one can be used at once.
|
||||
|
||||
You can also use `@player` to place the teleporting user's name into the command.
|
||||
|
||||
Example: `command:"#say @player has triggered a console command portal"`
|
||||
|
||||
### Command Tag Flags
|
||||
|
||||
You can only use one of these at the start of a command tag.
|
||||
|
||||
`!` Execute command as op
|
||||
|
||||
`^` Execute command with * permission
|
||||
|
||||
`#` Execute command as console
|
||||
|
||||
`%` Send command to bungee
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ const config = {
|
|||
docs: {
|
||||
sidebarPath: require.resolve('./sidebars.js'),
|
||||
// Please change this to your repo.
|
||||
editUrl: 'https://github.com/sekwah41/advanced-portals-docs/edit/main/website/',
|
||||
editUrl: 'https://github.com/sekwah41/Advanced-Portals/edit/website/',
|
||||
},
|
||||
blog: false,
|
||||
theme: {
|
||||
|
|
@ -65,14 +65,14 @@ const config = {
|
|||
{
|
||||
title: 'Downloads',
|
||||
items: [
|
||||
/*{
|
||||
label: 'Tutorial',
|
||||
to: '/docs/intro',
|
||||
},*/
|
||||
{
|
||||
label: 'Bukkit.org',
|
||||
href: 'https://dev.bukkit.org/projects/advanced-portals',
|
||||
},
|
||||
{
|
||||
label: 'GitHub',
|
||||
href: 'https://github.com/sekwah41/Advanced-Portals/releases',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
@ -96,13 +96,13 @@ const config = {
|
|||
href: 'https://github.com/sekwah41/Advanced-Portals/blob/spigot-1.13-1.16/CHANGELOG.md',
|
||||
},
|
||||
{
|
||||
label: 'GitHub',
|
||||
label: 'Source Code',
|
||||
href: 'https://github.com/sekwah41/Advanced-Portals',
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
copyright: `Copyright © ${new Date().getFullYear()} Sekwah, Inc. Built with Docusaurus.`,
|
||||
copyright: `Copyright © ${new Date().getFullYear()} Sekwah.`,
|
||||
},
|
||||
prism: {
|
||||
theme: lightCodeTheme,
|
||||
|
|
|
|||
|
|
@ -34,4 +34,4 @@
|
|||
"last 1 safari version"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue