diff --git a/docs/commands/events.mdx b/docs/commands/events.mdx index c286710a..90ddd2dd 100644 --- a/docs/commands/events.mdx +++ b/docs/commands/events.mdx @@ -7,16 +7,19 @@ hide_table_of_contents: true This page describes a list of commands, aliases, and permissions for the [Events](https://github.com/PGMDev/Events) plugin.
- | Commands | Description | Usage | Permissions | - |---|---|---|---| - | `/create` | Create a tournament. || `events.staff` | - | `/info` | View information about a team. | [team] | `events.staff` | - | `/list` | List all loaded teams. || `events.staff` | - | `/register` | Register a team. | [team] | `events.staff` | - | `/rounds` | Shows the rounds from this event. | - | `/score` | Shows the current score in the tournament. | - | `/unregisterall` | Clear all registered teams. || `events.staff` | - | `/veto` | Veto a map. | [number] | + | Commands | Aliases | Description | Usage | Permissions | + |---|---|---|---|---| + | `/ready` || Mark a team as ready. | + | `/unready` || Mark a team as no longer being ready. | + | `/veto` || Vetoes a map if a veto round is running. It can only be executed by players on a team. | [map] | + | `/tourney` | tm
tournament
events | + | `/tourney create` || Creates a match based on a format. | [format] | `events.staff` | + | `/tourney info` || View information about a team. | [team] | `events.staff` | + | `/tourney list` || List all loaded teams. || `events.staff` | + | `/tourney register` || Registers a team for a match. | [team] | `events.staff` | + | `/tourney rounds` || Shows past and future to-be-played rounds for an event. | + | `/tourney score` || Shows the current score in an event. | + | `/tourney unregisterall` || Clears all registered teams. || `events.staff` |
Spreadsheet can be found [here](https://docs.google.com/spreadsheets/d/1QlS4DW6aLcryf4BRw3WXylydm07HqKNTf_QYI2PtLzU/edit?usp=sharing). diff --git a/docs/events/commands.mdx b/docs/events/commands.mdx deleted file mode 100644 index 53f65eb9..00000000 --- a/docs/events/commands.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: commands -title: Commands ---- - -The plugin's commands are divided in two sections: User commands and Admin commands. -Keep in mind that in order to run Admin commands, you must have the `events.staff` permission. - -### User Commands - -
- | Command | Parameters | Description | - |---|---|---| - | `/veto` | \ | Vetoes a map if a veto round is running. It can only be executed by players on a team. | - | `/score` | | Shows the current score in the event. | - | `/rounds` | | Shows past and future to-be-played rounds. | -
- -### Admin Commands - -
- | Command | Parameters | Description | - |---|---|---| - | `/tm create` | \ | Creates a match based on a format. | - | `/tm register` | \ | Registers a team for a match. | - | `/tm list` | | Lists all loaded teams. | - | `/tm info` | \ | Shows information about a team. | - | `/tm unregisterall` | | Clears all registered teams. | -
diff --git a/docs/modules/mechanics/variables.mdx b/docs/modules/mechanics/variables.mdx index 838f48da..2b8d435f 100644 --- a/docs/modules/mechanics/variables.mdx +++ b/docs/modules/mechanics/variables.mdx @@ -32,7 +32,7 @@ You can define as many variables as you want and all variables must have a scope | Attribute | Description | Value | |---|---|---| | `id` | Unique identifier used to reference this variable from other places in the XML. | String | - | `exclusive` | Limits how many different values there can be in a variable.
*Values between 1 and 50 are supported, higher values may lead to performance issues.* | Number | + | `exclusive` | Limits how many different instances there can be for a variable.
*Values between 1 and 50 are supported, higher values may lead to performance issues.* | Number | | `scope` | Defines what the variable will be applied to.
*Variables scoped to a player will give each player a unique value that will be preserved, even if they switch teams.* | `player`, `team`, or `match` | | `default` | Sets the initial value of the variable. | Number | diff --git a/docusaurus.config.js b/docusaurus.config.js index b4009ac0..0a96367e 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -32,6 +32,35 @@ const config = { ], ], + plugins: [ + [ + '@docusaurus/plugin-client-redirects', + { + redirects: [ + { + // Redirect from old Events command page + to: '/docs/commands/events', + from: '/docs/events/commands', + }, + { + // Redirect from old Packaging and Releasing page name + to: '/docs/guides/preparing/packaging-and-releasing', + from: '/docs/guides/packaging/compiling-and-releasing' + }, + ], + createRedirects(existingPath) { + if (existingPath.includes('/docs/guides/preparing')) { + // Redirect from old guides link to current guides link + return [ + existingPath.replace('/docs/guides/preparing', '/docs/guides/packaging'), + ]; + } + return undefined; + }, + }, + ], + ], + themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ diff --git a/package-lock.json b/package-lock.json index e3073592..04f9c96b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,6 +10,7 @@ "license": "Apache-2.0", "dependencies": { "@docusaurus/core": "^3.4.0", + "@docusaurus/plugin-client-redirects": "^3.4.0", "@docusaurus/preset-classic": "^3.4.0", "@fortawesome/fontawesome-svg-core": "^6.6.0", "@fortawesome/free-solid-svg-icons": "^6.6.0", @@ -23,8 +24,7 @@ "react-dom": "^18.3.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "^3.4.0", - "husky": "^9.0.11" + "@docusaurus/module-type-aliases": "^3.4.0" }, "engines": { "node": ">=18.0" @@ -2366,6 +2366,30 @@ "react-dom": "*" } }, + "node_modules/@docusaurus/plugin-client-redirects": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-client-redirects/-/plugin-client-redirects-3.4.0.tgz", + "integrity": "sha512-Pr8kyh/+OsmYCvdZhc60jy/FnrY6flD2TEAhl4rJxeVFxnvvRgEhoaIVX8q9MuJmaQoh6frPk94pjs7/6YgBDQ==", + "license": "MIT", + "dependencies": { + "@docusaurus/core": "3.4.0", + "@docusaurus/logger": "3.4.0", + "@docusaurus/utils": "3.4.0", + "@docusaurus/utils-common": "3.4.0", + "@docusaurus/utils-validation": "3.4.0", + "eta": "^2.2.0", + "fs-extra": "^11.1.1", + "lodash": "^4.17.21", + "tslib": "^2.6.0" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "react": "^18.0.0", + "react-dom": "^18.0.0" + } + }, "node_modules/@docusaurus/plugin-content-blog": { "version": "3.4.0", "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.4.0.tgz", @@ -7572,21 +7596,6 @@ "node": ">=10.17.0" } }, - "node_modules/husky": { - "version": "9.0.11", - "resolved": "https://registry.npmjs.org/husky/-/husky-9.0.11.tgz", - "integrity": "sha512-AB6lFlbwwyIqMdHYhwPe+kjOC3Oc5P3nThEoW/AaO2BX3vJDjWPFxYLxokUZOo6RNX20He3AaT8sESs9NJcmEw==", - "dev": true, - "bin": { - "husky": "bin.mjs" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/typicode" - } - }, "node_modules/iconv-lite": { "version": "0.4.24", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", diff --git a/package.json b/package.json index 06438e3a..bec88899 100644 --- a/package.json +++ b/package.json @@ -22,6 +22,7 @@ "dependencies": { "@docusaurus/core": "^3.4.0", "@docusaurus/preset-classic": "^3.4.0", + "@docusaurus/plugin-client-redirects": "^3.4.0", "@fortawesome/fontawesome-svg-core": "^6.6.0", "@fortawesome/free-solid-svg-icons": "^6.6.0", "@fortawesome/react-fontawesome": "^0.2.2", @@ -34,8 +35,7 @@ "react-dom": "^18.3.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "^3.4.0", - "husky": "^9.0.11" + "@docusaurus/module-type-aliases": "^3.4.0" }, "browserslist": { "production": [ diff --git a/sidebars.js b/sidebars.js index 12175f6e..ada232b8 100644 --- a/sidebars.js +++ b/sidebars.js @@ -124,7 +124,6 @@ const sidebars = { Format: ["events/xml", "events/examples"], }, "events/teams", - "events/commands", ], Examples: [ "examples/airship-battle",