🖨 Custom Commands #

This page serves as an introduction to bridge.'s custom commands which you can use wherever Minecraft accepts regular commands.

Inside of this article, you will learn about the following topics:

☑️ What is a custom command?
☑️ How to install a custom command.
☑️ How to use a custom command.
☑️ How to write custom commands.

Basics #

Custom commands allow users to generate commands programmatically with JavaScript or TypeScript. They integrate seamlessly into bridge. by appearing alongside Minecraft's built-in commands within auto-completions.

bridge. loads custom commands from the commands/ folder within your behavior pack.

Installation #

You can install custom commands from bridge.'s extension store if you do not feel confident in writing your own custom commands.

Usage #

After installing or writing your first custom command, it will naturally appear within bridge.'s command auto-completions within mcfunction or JSON files. You can then use the command as you would use a regular Minecraft command.

Writing Custom Commands #

Start by creating a JavaScript or TypeScript file within the commands/ folder of your behavior pack. You can only write a single command per file which should be exported as the default export.

export default defineCommand(() => {...})

name(commandName: string): void #

Calling this function is required. It sets the name of the command which will be used within auto-completions.

export default defineCommand(({ name }) => {
	name('my_command')
})

schema(schemaDefinition: any): void #

Use this function to declare a command schema to be used within bridge.'s auto-completions. Command schemas use a proprietary format which is described in detail here.

export default defineCommand(({ schema }) => {
	schema([
		{
			description: 'Say hello to a player!',
			arguments: [
				{
					type: 'selector',
				},
			],
		},
	])
})

template((commandArgs: any[]) => void): void #

Use this function to return a list of commands to be executed whenever your custom command is used. The commandArgs parameter is an array of arguments passed to the command.

export default defineCommand(({ template }) => {
	template(([selector]) => {
		return [
			`say Hello ${selector}!`,
			`say I hope you are having a great day!`,
		]
	})
})

And that's it, you have just written your first basic custom command! 🎉