chore: updating some info for the recode

This still needs a proper rewrite
This commit is contained in:
Sekwah 2024-12-12 02:30:21 +00:00
parent 4e345296e9
commit 0b2b643c13
No known key found for this signature in database
7 changed files with 10920 additions and 7544 deletions

8
.gitignore vendored
View File

@ -20,3 +20,11 @@ yarn-debug.log*
yarn-error.log*
/.idea/
*.iml
.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/sdks
!.yarn/versions

1
.yarnrc.yml Normal file
View File

@ -0,0 +1 @@
nodeLinker: node-modules

View File

@ -5,14 +5,15 @@ description: Information on all commands included in Advanced Portals, including
# Commands
:::warning
:::info
**V2.0.0+ / recode info**
The current documentation is related to versions below 2.0.0. While most should apply to the latest version, some features may have changed or be missing.
The documentation will be updated soon.
The re-code should detect that you have the old data and create copies in the new format, however you will need to re-do the config.
You can use the `/portals convert` command to port your portals to the latest version. Do not worry. The original data will not be deleted, and you can revert to older versions if you run into problems.
If the portals to not import for any reason, you can manually trigger the import by running `/portals import`.
Do not worry. The original data will not be deleted, and you can revert to older versions if you run into problems.
:::
@ -30,7 +31,7 @@ Usable Alias: `/portal` `/ap` `/portals` `/aportal` `/advancedportals`
### `/portal create (tags...)`
**Permission:** `advancedportals.portal`
**Permission:** `advancedportals.portal.create`
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`
@ -41,49 +42,54 @@ For a list of tags and info, check out the [tags page](./portal-tags.md).
### `/portal selector` or `/portal wand`
**Permission:** `advancedportals.createportal`
**Permission:** `advancedportals.portal.selector`
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`
**Permission:** `advancedportals.portal.create`
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`
**Permission:** `advancedportals.portal.create`
Gives you an end portal block that you can build with.
### `/portal gatewayblock`
**Permission:** `advancedportals.portal`
**Permission:** `advancedportals.portal.create`
Gives you an end gateway block that you can build with.
### `/portal disablebeacon (portalname)`
**Permission:** `advancedportals.build`
**Permission:** `advancedportals.portal.disable_beacon`
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`
[//]: # (Currently not implemented)
[//]: # (### `/portal select`)
**Permission:** `advancedportals.createportal`
[//]: # (**Permission:** `advancedportals.createportal`)
After the command is entered, punch inside a portal region, and it will select that portal.
[//]: # ()
[//]: # (After the command is entered, punch inside a portal region, and it will select that portal.)
### `/portal unselect`
[//]: # ()
[//]: # (### `/portal unselect`)
**Permission:** `advancedportals.createportal`
[//]: # ()
[//]: # (**Permission:** `advancedportals.createportal`)
Use to remove the current portal selection. (as it can mess with certain commands)
[//]: # ()
[//]: # (Use to remove the current portal selection. (as it can mess with certain commands))
### `/portal remove`
**Permission:** `advancedportals.removeportal`
**Permission:** `advancedportals.portal.remove`
Enter this command to destroy a portal with a set name. If the argument is left blank, it will destroy the currently selected portal.
@ -98,17 +104,21 @@ Usable Alias: `/desti` `/destination`
Permission (applies to all): `advancedportals.desti`
### `/desti create`
Permission: `advancedportals.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`
Permission: `advancedportals.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`
Permission: `advancedportals.desti.list`
A list of created destinations.
### `/desti warp (desti name)`
### `/desti tp (desti name)`
Permission: `advancedportals.desti.teleport`
Teleport to the named destination.

View File

@ -5,19 +5,24 @@ description: Quick introduction to Advanced Portals.
# Tutorial Intro
:::warning
:::info
**V2.0.0+ / recode info**
The current documentation is related to versions below 2.0.0. While most should apply to the latest version, some features may have changed or be missing.
The documentation will be updated soon.
The re-code should detect that you have the old data and create copies in the new format, however you will need to re-do the config.
You can use the `/portals convert` command to port your portals to the latest version. Do not worry. The original data will not be deleted, and you can revert to older versions if you run into problems.
If the portals to not import for any reason, you can manually trigger the import by running `/portals import`.
Do not worry. The original data will not be deleted, and you can revert to older versions if you run into problems.
:::
Here is a YouTube video made by [LtJim007](https://www.youtube.com/channel/UCZvGH5UFnZGHL7t11RLhg2w) explaining the basics.
:::info
The video is for older versions so if you are using 2.0.0+ and a command does not work, please refer to the [commands page](./commands.md) for the latest information.
:::
<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>
In summary: you can create destinations for your portals with `/desti`, and create portals to them with `/portal create (tags...)`. You will need to provide a *trigger element* for your portals, for example water / lava / nether swirls, and replace the inside of your portal with it for the portal to function.
@ -32,7 +37,4 @@ Here's a step by step guide.
3. Run `/portal create name:name-of-your-portal desti:name-of-destination triggerblock:name-of-trigger-element`. This is a basic example - more options can be found on the [tags page](./portal-tags.md).
4. Replace the empty air in your portal with your trigger element by running `/fill bottom-right-coords upper-right-coords trigger-element`. The coordinates should have shown up in chat when you left-and-right-clicked with the iron axe.
- If your portal isn't rectangular: try `/fill`ing the area with glass or another block, breaking the glass in the shape of the portal, and then `/fill` the area again with your transportation trigger block. Then break the remaining glass.
If you mess up, you can run `/desti remove name-of-destination` and `/portal remove name-of-portal` to remove a destination and a portal, respectively.

View File

@ -5,14 +5,15 @@ description: Information on all portal tags included in Advanced Portals.
# Portal Tags
:::warning
:::info
**V2.0.0+ / recode info**
The current documentation is related to versions below 2.0.0. While most should apply to the latest version, some features may have changed or be missing.
The documentation will be updated soon.
The re-code should detect that you have the old data and create copies in the new format, however you will need to re-do the config.
You can use the `/portals convert` command to port your portals to the latest version. Do not worry. The original data will not be deleted, and you can revert to older versions if you run into problems.
If the portals to not import for any reason, you can manually trigger the import by running `/portals import`.
Do not worry. The original data will not be deleted, and you can revert to older versions if you run into problems.
:::
@ -34,7 +35,8 @@ These add or alter specific functionality for the portals.
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`
### `portalEvent:true`
Alias: `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.
@ -59,6 +61,10 @@ This should work for both bungee and velocity, however make sure you have bungee
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.
### `proxy:(server_name)`
This uses the proxy plugin to communicate so does not require on the bungee channel. This also allows for the use of desti: along with the proxy tag to teleport to a destination on another server.
### `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).
@ -67,6 +73,10 @@ Sets the warp message for the portal. Colour codes can be used e.g. &c is red. [
Sets what permission you need to use the portal(can be customised to anything)
### `cooldown:(time in seconds)`
Sets the cooldown for that specific portal in seconds. This is per player and stored between logins so can be used set long delays.
### `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.

View File

@ -5,14 +5,19 @@ description: Information on the optional WorldEdit integration in Advanced Porta
# WorldEdit Integration
:::warning
:::info
**V2.0.0+ / recode info**
The current documentation is related to versions below 2.0.0. While most should apply to the latest version, some features may have changed or be missing.
The documentation will be updated soon.
The re-code should detect that you have the old data and create copies in the new format, however you will need to re-do the config.
You can use the `/portals convert` command to port your portals to the latest version. Do not worry. The original data will not be deleted, and you can revert to older versions if you run into problems.
If the portals to not import for any reason, you can manually trigger the import by running `/portals import`.
Do not worry. The original data will not be deleted, and you can revert to older versions if you run into problems.
:::
:::warning
This feature is completely missing from the recode currently, and will be added back in the future.

18360
yarn.lock

File diff suppressed because it is too large Load Diff