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

add commands yml documentation #233

Merged
merged 17 commits into from
Dec 14, 2023
Merged
Show file tree
Hide file tree
Changes from 10 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
1 change: 1 addition & 0 deletions config/sidebar.paper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ const paper: SidebarsConfig = {
"admin/reference/configuration/global-configuration",
"admin/reference/configuration/world-configuration",
"admin/reference/configuration/server-properties",
"admin/reference/configuration/commands-configuration",
],
},
"admin/reference/system-properties",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
slug: /reference/commands-file-configuration
---

# 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 `commands.yml`.

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

:::

<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.'
`}/>