Skip to content

Commit

Permalink
add commands yml documentation (#233)
Browse files Browse the repository at this point in the history
  • Loading branch information
456dev authored Dec 14, 2023
1 parent 1242a38 commit f0cc172
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 0 deletions.
1 change: 1 addition & 0 deletions config/sidebar.paper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ const paper: SidebarsConfig = {
"admin/reference/configuration/server-properties",
"admin/reference/configuration/spigot-configuration",
"admin/reference/configuration/bukkit-configuration",
"admin/reference/configuration/bukkit-commands-configuration",
],
},
"admin/reference/system-properties",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
slug: /reference/bukkit-commands-configuration
---

# Bukkit Commands Configuration

import React from 'react';
import Config from '@site/src/components/Config';

:::info

The below YAML shows you the structure and default values for the legacy `commands.yml`.

Click on a leaf node to view the description for that setting.

:::

:::warning

The aliases defined in this legacy file do not support modern features
- Tab completion
- Permissions

:::

<Config data={`
command-block-overrides:
default: '[<command to override>]'
description: 'Which vanilla commands should be prioritized over those provided by Bukkit or plugins.
Useful for compatibility with adventure maps built for vanilla command blocks.
Use the literal ''*'' to always use the vanilla version in command blocks.
By default, no commands are overridden.'
ignore-vanilla-permissions:
default: 'false'
description: 'Whether to use vanilla permission levels when executing commands.'
aliases:
'<alias name>':
default: '[<commands to run>]'
description: 'A list of strings which are target commands.
Alternatively, a string, which is a single target command.
A target command is a command that is run, when the alias is run.
Replacements:
- ''\`$sender\`'' is replaced with the command sender''s name (Added by Paper).
- \`$<n>\` is replaced by the n''th argument, 1-indexed.
- \`$$<n>\` is replaced by the n''th argument, 1-indexed, failing if the n''th argument is not present.
- \`$<n>-\` is replaced by the n''th argument and everything that follows, 1-indexed.
- \`$$<n>-\` is replaced by the n''th argument and everything that follows, 1-indexed, failing if the n''th argument is not present.
Each alias registered cannot (easily) be overridden by a plugin.'
icanhasbukkit:
default: '[version $1-]'
description: 'A built-in alias. Set aliases to an empty list ([]) to persistently remove.'
`}/>

0 comments on commit f0cc172

Please sign in to comment.