Upstream/Advanced-Portals
1
0
Fork 0
mirror of https://github.com/sekwah41/Advanced-Portals.git synced 2024-12-18 06:58:21 +01:00
Code Issues Projects Releases Wiki Activity

docs: update documentation to add warnings for the recode

Browse Source
This commit is contained in:
Sekwah 2024-12-08 12:39:55 +00:00
parent 01e4f39e8b
commit d6a4243068
5 changed files with 46 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/commands.md
View File

@ -5,6 +5,15 @@ description: Information on all commands included in Advanced Portals, including
# Commands
**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.
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.
:::
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.

11
docs/intro.md
View File

@ -5,6 +5,17 @@ description: Quick introduction to Advanced Portals.
# Tutorial Intro
:::warning
**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.
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.
:::
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>

9
docs/portal-tags.md
View File

@ -5,6 +5,15 @@ description: Information on all portal tags included in Advanced Portals.
# Portal Tags
**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.
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.
:::
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`

11
docs/worldedit.md
View File

@ -5,6 +5,17 @@ description: Information on the optional WorldEdit integration in Advanced Porta
# WorldEdit Integration
**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.
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.
This feature is completely missing from the recode currently, and will be added back in the future.
:::
You can configure AdvancedPortals to use WorldEdit instead of the Selection Tool from AdvancedPortals.
To enable the integration (add and) set the config option `WorldEditIntegration` to "true".

8
docusaurus.config.js
View File

@ -69,6 +69,10 @@ const config = {
label: 'Bukkit.org',
href: 'https://dev.bukkit.org/projects/advanced-portals',
},
{
label: 'Modrinth',
href: 'https://modrinth.com/plugin/advanced-portals',
},
{
label: 'GitHub',
href: 'https://github.com/sekwah41/Advanced-Portals/releases',
@ -83,8 +87,8 @@ const config = {
href: 'https://discord.sekwah.com/',
},
{
label: 'Twitter',
href: 'https://twitter.com/sekwah',
label: 'Bluesky',
href: 'https://bsky.app/profile/sekwah.com',
},
],
},