Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Events command table and redirect old links #124

Merged
merged 1 commit into from
Aug 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions docs/commands/events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<div className="table-container">
| 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<br />tournament<br />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` |
</div>

Spreadsheet can be found [here](https://docs.google.com/spreadsheets/d/1QlS4DW6aLcryf4BRw3WXylydm07HqKNTf_QYI2PtLzU/edit?usp=sharing).
29 changes: 0 additions & 29 deletions docs/events/commands.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/modules/mechanics/variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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. | <span className="badge badge--primary">String</span> |
| `exclusive` | Limits how many different values there can be in a variable.<br />*Values between 1 and 50 are supported, higher values may lead to performance issues.* | <span className="badge badge--primary">Number</span> |
| `exclusive` | Limits how many different instances there can be for a variable.<br />*Values between 1 and 50 are supported, higher values may lead to performance issues.* | <span className="badge badge--primary">Number</span> |
| `scope` | Defines what the variable will be applied to.<br />*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. | <span className="badge badge--primary">Number</span> |
</div>
Expand Down
29 changes: 29 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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} */
({
Expand Down
43 changes: 26 additions & 17 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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": [
Expand Down
1 change: 0 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@ const sidebars = {
Format: ["events/xml", "events/examples"],
},
"events/teams",
"events/commands",
],
Examples: [
"examples/airship-battle",
Expand Down
Loading