LiquidBounce

https://liquidbounce.net/docs/
Admin
LiquidBounce is a Minecraft client mod that provides customizable features, scripts, and themes with...
Tokens:154,237
Snippets:2,476
Trust Score:9.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install dependencies and start development server

Source: https://liquidbounce.net/docs/theme-system/overview

Prepares your custom theme project by installing necessary Node.js packages and starting a local development server for real-time testing.

```bash
npm install
npm run dev

```

--------------------------------

### Full Script Example with Module and Command

Source: https://liquidbounce.net/docs/script-api/getting-started

A complete script demonstrating registration of a script, a module with an enable event, and a command. This serves as a comprehensive example for script creation.

```javascript
const script = registerScript({
  name: "MyScript",
  version: "1.0.0",
  authors: ["My Name"]
});

script.registerModule({
  name: "MyModule",
  category: "Misc", // Movement, Combat, Render, ...
  description: "An example module created with LiquidBounce's script API."
}, (mod) => {
  mod.on("enable", () => {
    Client.displayChatMessage("§aAxolotls are great!");
  });
});

script.registerCommand({
  name: "addition",
  aliases: ["add"],
  parameters: [{
      name: "a",
      required: true,
      validate: ParameterValidator.integer
    },
    {
      name: "b",
      required: true,
      validate: ParameterValidator.integer
    }
  ],
  onExecute(arg1, arg2) {
    Client.displayChatMessage(`Result of ${arg1} + ${arg2} is ${arg1 + arg2}`);
  }
});

```

--------------------------------

### Complex Command Registration Example

Source: https://liquidbounce.net/docs/script-api/creating-commands

A comprehensive example demonstrating nested subcommands, aliases, parameter validation using predefined validators, and variable arguments.

```javascript
const acceptedAnimals = ["Axolotl", "Capybara", "Snek"];
script.registerCommand({
  name: "myCommand",
  aliases: ["exampleCommand", "sampleCMD"], // .exampleCommand and .sampleCommand will both work to execute this command.
  hub: true, // .myCommand is not executable directly. It only serves a hub holding subcommands.
  subcommands: [{
      name: "math",
      hub: true,
      subcommands: [{
          name: "div",
          aliases: ["divide"],
          parameters: [{
              name: "x",
              required: true,
              validate: ParameterValidator.integer
            },
            {
              name: "y",
              required: true,
              validate: ParameterValidator.integer
            }
          ],
          onExecute(x, y) {
            Client.displayChatMessage(`${x} divided by ${y} is ${x / y}`);
          }
        },
        {
          name: "sqrt",
          parameters: [{
            name: "x",
            required: true,
            validate: ParameterValidator.positiveInteger
          }],
          onExecute(x) {
            Client.displayChatMessage(`Square root of ${x} is ${Math.sqrt(x)}`);
          }
        },
        {
          name: "sum",
          parameters: [{
            name: "numbers",
            required: true,
            vararg: true,
            validate: ParameterValidator.integer
          }],
          onExecute(args) {
            Client.displayChatMessage(`Sum ${args.join(" + ")} is ${args.reduce((s, a) => s + a, 0)}`);
          }
        }
      ]
    },
    {
      name: "animal",
      parameters: [{
        name: "value",
        required: true,
        validate(arg) {
          if (acceptedAnimals.includes(arg)) {
            return {
              accept: true,
              value: arg,
            };
          } else {
            return {
              accept: false,
              error: `Only the following animals are acceptable: ${acceptedAnimals.join(", ")}`,
            };
          }
        },
        getCompletions(begin, args) {
          return acceptedAnimals.filter(a => a.startsWith(begin));
        }
      }],
      onExecute(animal) {
        Client.displayChatMessage(`Petting the ${animal}`);
      }
    }
  ]
});

```

--------------------------------

### Command Usage Examples

Source: https://liquidbounce.net/docs/global-settings/commands

Examples of how to use commands in LiquidBounce. Commands must start with the configured prefix. The client suggests similar commands if an unrecognized command is typed, based on the HintCount setting.

```text
.toggle KillAura
```

```text
.help
```

```text
.friend add Steve
```

--------------------------------

### Example Module Registration with Event Handling

Source: https://liquidbounce.net/docs/script-api/creating-modules/overview

This example demonstrates registering a module with a boolean setting and handling 'enable' and 'key' events. The module displays chat messages based on its setting and key presses.

```javascript
script.registerModule({
    name: "MyModule",
    category: "Misc",
    description: "Just a demonstration.",
    settings: {
        myBooleanSetting: Setting.boolean({
            name: "MySetting",
            default: true
        })
    }
}, mod => {
    mod.on("enable", () => {
        if (mod.settings.myBooleanSetting.value) {
            Client.displayChatMessage("MySetting is true!");
        }
    });

    mod.on("key", event => {
        Client.displayChatMessage(`${event.getKey().getName()} has been pressed.`);
    });
});

```

--------------------------------

### List available themes in Marketplace

Source: https://liquidbounce.net/docs/theme-system/overview

Use this command to see all themes available for installation from the marketplace.

```bash
.marketplace list theme
```

--------------------------------

### Subscribe to BeautifyV2 Theme

Source: https://liquidbounce.net/docs/theme-system/overview

Installs the BeautifyV2 theme from the marketplace.

```bash
.marketplace subscribe 581
```

--------------------------------

### Subscribe to Wurst Theme

Source: https://liquidbounce.net/docs/theme-system/overview

Installs the Wurst theme from the marketplace.

```bash
.marketplace subscribe 561
```

--------------------------------

### Example Script with All Setting Types

Source: https://liquidbounce.net/docs/script-api/global-classes/setting

This script demonstrates the registration and usage of all available setting types within a LiquidBounce module. It shows how to initialize settings and modify their values.

```javascript
const script = registerScript({
  name: "MyScript",
  version: "1.0.0",
  authors: ["My Name"]
});

script.registerModule({
  name: "MyModule",
  category: "Misc",
  description: "An example module created with LiquidBounce's script API.",
  settings: {
    fastSwing: Setting.boolean({
      name: "FastSwing",
      default: true
    }),
    range: Setting.float({
      name: "Range",
      default: 3.0,
      range: [0.5, 8.0],
      suffix: "blocks"
    }),
    randomness: Setting.floatRange({
      name: "Randomness",
      default: [2.3, 7.8],
      range: [0.0, 10.0],
      suffix: "jitter"
    }),
    expand: Setting.int({
      name: "Expand",
      default: 4,
      range: [0, 10],
      suffix: "blocks"
    }),
    cps: Setting.intRange({
      name: "CPS",
      default: [4, 10],
      range: [0, 20],
      suffix: "cps"
    }),
    key: Setting.key({
      name: "Key",
      default: 260
    }),
    message: Setting.text({
      name: "Message",
      default: "This is a default message."
    }),
    messages: Setting.textArray({
      name: "Messages",
      default: ["This is a message", "This is another message"]
    }),
    animal: Setting.choose({
      name: "Animal",
      default: "Capybara",
      choices: ["Axolotl", "Capybara", "Snek"]
    })
  }
}, (mod) => {
  mod.on("enable", () => {
    Client.displayChatMessage(`FastSwing: ${mod.settings.fastSwing.value}`);
    Client.displayChatMessage(`Range: ${mod.settings.range.value}`);
    Client.displayChatMessage(`Randomness: ${mod.settings.randomness.value}`);
    Client.displayChatMessage(`Expand: ${mod.settings.expand.value}`);
    Client.displayChatMessage(`CPS: ${mod.settings.cps.value}`);
    Client.displayChatMessage(`Key: ${mod.settings.key.value}`);
    Client.displayChatMessage(`Message: ${mod.settings.message.value}`);
    Client.displayChatMessage(`Messages: ${mod.settings.messages.value}`);
    Client.displayChatMessage(`Animal: ${mod.settings.animal.value}`);

    mod.settings.fastSwing.value = false;
    mod.settings.range.value = 2.3;
    mod.settings.randomness.value = [2, 4.34];
    mod.settings.expand.value = 2;
    mod.settings.cps.value = [5, 12];
    mod.settings.key.value = 265;
    mod.settings.message.value = "Axolotls are cool";
    mod.settings.messages.value = ["New message 1", "New message 2"];
    mod.settings.animal.value = "Axolotl";
  });
});
```

--------------------------------

### Subscribe to JelloBounce Theme

Source: https://liquidbounce.net/docs/theme-system/overview

Installs the JelloBounce theme from the marketplace.

```bash
.marketplace subscribe 265
```

--------------------------------

### Basic Command Usage

Source: https://liquidbounce.net/docs/commands/overview

Examples of common commands for toggling modules, setting values, and changing the command prefix. Remember to use double quotes for arguments containing spaces.

```plaintext
.toggle KillAura
.bind Speed left.alt
.friend add SenkJu
.friend add SenkJu "Senk Ju"
.value set modules.killaura.range 4.5
.value set settings.commands.prefix !
```

--------------------------------

### Example Command for Target Configuration

Source: https://liquidbounce.net/docs/global-settings/targets

Demonstrates how to use the .targets command to toggle specific entity types for combat targeting. This provides a quick way to adjust target settings via chat.

```plaintext
.targets combat Players
```

--------------------------------

### Launch Asynchronous Task

Source: https://liquidbounce.net/docs/script-api/global-classes/asyncutil

This example demonstrates launching a task asynchronously on a specified ExecutorService using AsyncUtil.launch. The promise resolves with the task's return value after completion.

```javascript
const result = await AsyncUtil.launch(() => {
  java.lang.Thread.sleep(5000);
  return "task result";
});
Chat.displayChatMessage(result);
```

--------------------------------

### Start Debug Protocol for a Script

Source: https://liquidbounce.net/docs/commands/client

Initiates the debug protocol for a specified script, allowing for debugging of script behavior.

```bash
.script debug <name>
```

--------------------------------

### Async Module Handler Example

Source: https://liquidbounce.net/docs/script-api/global-classes/asyncutil

Module and command handlers can be written as async functions. This example shows an async onEnable function that waits for one game tick before displaying a chat message.

```javascript
const onEnable = async () => {
  await AsyncUtil.ticks(1);
  Chat.displayChatMessage("Enabled!");
}
```

--------------------------------

### Start Debugging with Chrome DevTools

Source: https://liquidbounce.net/docs/script-api/debugging

Initiate a debugging session for 'myscript' using the INSPECT protocol, pausing on start and not inspecting internals, on port 9229. LiquidBounce will provide a DevTools URL for connection.

```bash
.script debug myscript INSPECT true false 9229
```

--------------------------------

### Backup Client Configurations

Source: https://liquidbounce.net/docs/commands/client

Creates a backup of all current client configurations. This is recommended before making significant changes.

```bash
.client config backup
```

--------------------------------

### Start Debugging with Debug Adapter Protocol (DAP)

Source: https://liquidbounce.net/docs/script-api/debugging

Initiate a debugging session for 'myscript' using the DAP protocol, pausing on start and not inspecting internals, on port 9229. This is used for IDE integration like VS Code.

```bash
.script debug myscript DAP true false 9229
```

--------------------------------

### Open Configuration Folder

Source: https://liquidbounce.net/docs/commands/client

Opens the directory where client configuration files are stored.

```bash
.client config browse
```

--------------------------------

### Client.scriptManager

Source: https://liquidbounce.net/docs/script-api/global-classes/client

Provides access to the script manager for managing installed scripts.

```APIDOC
## Client.scriptManager

### Description
Manages installed scripts. See GitHub for more information.
```

--------------------------------

### List Available Client Themes

Source: https://liquidbounce.net/docs/commands/client

Shows all available themes that can be applied to the client's appearance.

```bash
.client theme list
```

--------------------------------

### Help Command

Source: https://liquidbounce.net/docs/commands/client

Display a paginated list of all available commands with their aliases and descriptions using the `.help` command.

```plaintext
.help [page]
```

--------------------------------

### Get All Module Categories

Source: https://liquidbounce.net/docs/script-api/global-classes/client

Retrieves a list of all available module categories within the module manager.

```javascript
const categories = client.moduleManager.getCategories(); // ["Movement", "Combat", "Render", ...]
```

--------------------------------

### Retrieve Module by Name

Source: https://liquidbounce.net/docs/script-api/global-classes/client

Use this to get a specific module object from the module manager by its name.

```javascript
const killAura = client.moduleManager.getModuleByName("KillAura");
```

--------------------------------

### Client.moduleManager

Source: https://liquidbounce.net/docs/script-api/global-classes/client

Provides access to the module manager for managing modules (cheats). Includes examples for retrieving modules and categories.

```APIDOC
## Client.moduleManager

### Description
Manages modules (cheats). See GitHub for more information.

### Examples
#### Retrieving a module from the module manager.
```javascript
const killAura = client.moduleManager.getModuleByName("KillAura");
```

#### Getting all available module categories.
```javascript
const categories = client.moduleManager.getCategories(); // ["Movement", "Combat", "Render", ...]
```
```

--------------------------------

### Display Client Information

Source: https://liquidbounce.net/docs/commands/client

Shows the client's name, version, and author. This is useful for identifying the specific client build being used.

```bash
.client info
```

--------------------------------

### Set the active theme

Source: https://liquidbounce.net/docs/theme-system/overview

Apply an installed theme by its ID. This command changes the client's visual appearance.

```bash
.client theme set <id>
```

--------------------------------

### Help Command

Source: https://liquidbounce.net/docs/commands/client

Display a paginated list of all available commands with their aliases and descriptions.

```APIDOC
## .help

### Description
Display a paginated list of all available commands with their aliases and descriptions.

### Usage
```
.help [page]
```

### Parameters
* `page` (optional) — The page number to display.
```

--------------------------------

### Command with Built-in Module Validator

Source: https://liquidbounce.net/docs/script-api/creating-commands

This example demonstrates registering a command that uses the built-in `ParameterValidator.module` to validate a command parameter.

```javascript
script.registerCommand({
  name: "description",
  parameters: [{
    name: "module",
    required: true,
    validate: ParameterValidator.module,
  }],
  onExecute(mod) {
    Client.displayChatMessage(`Description of module ${mod.name} is '${mod.description}'`);
  }
});
```

--------------------------------

### Chrome DevTools Connection URL

Source: https://liquidbounce.net/docs/script-api/debugging

This is the URL provided by LiquidBounce after starting a debugging session. Paste this into Chrome to connect to the debugger.

```bash
devtools://devtools/bundled/js_app.html?ws=127.0.0.1:9229/myscript.js
```

--------------------------------

### Clone theme template repository

Source: https://liquidbounce.net/docs/theme-system/overview

Initializes a new custom theme project by cloning the official template repository.

```bash
git clone https://github.com/CCBlueX/LiquidBounce-Theme
cd LiquidBounce-Theme

```

--------------------------------

### Explore Area with Baritone

Source: https://liquidbounce.net/docs/baritone/usage/movement

Use `#explore` with X and Z coordinates to systematically explore the world starting from that origin point.

```plaintext
#explore x z
```

--------------------------------

### Launch LiquidLauncher on Linux with Wayland

Source: https://liquidbounce.net/docs/tutorials/fixing-liquidlauncher

Use this environment variable to fix Wayland display issues on Linux. This is a temporary fix for the current session.

```bash
WEBKIT_DISABLE_DMABUF_RENDERER=1 ./LiquidLauncher
```

--------------------------------

### Show Client Overlay

Source: https://liquidbounce.net/docs/commands/client

Displays the client's graphical overlay on the game screen.

```bash
.client appearance show
```

--------------------------------

### Show Integration URL

Source: https://liquidbounce.net/docs/commands/client

Retrieves and displays the client's integration URL.

```bash
.client integration url
```
Tokens:
Raw