Skip to content

Starscript

arlomcwalter edited this page Jun 13, 2022 · 10 revisions

Starscript

Starscript is the formatting language currently used in Discord Presence and .say command.
Full syntax can be found here.

Variables

A list of standard variables can be found here.

General

  • version: Meteor version.
  • mc_version: Minecraft version.
  • fps: Current FPS.

Meteor

  • modules: Total number of modules.
  • active_modules: Number of active modules.
  • is_module_active(name): Returns true when the specified module is active.

Baritone

  • is_pathing: Returns true when Baritone is currently pathing.
  • distance_to_goal: Estimated distance to the goal.

Player

  • player: Username.
  • player.health: Player's health.
  • player.hunger: Player's hunger.
  • player.speed: Speed in blocks per second.
  • player.pos: Player's position formatted as X: 0 Y: 0 Z: 0.
  • player.pos.x: Player's X position.
  • player.pos.y: Player's Y position.
  • player.pos.z: Player's Z position.
  • player.yaw: Player's yaw rotation.
  • player.pitch: Player's pitch rotation.
  • player.hand: Player’s main held item. See Item.
  • player.offhand: Player’s offhand held item. See Item.
  • player.get_item(slot): Item in the specified slot. See Item.
  • player.count_items(id): Number of items in the entire inventory.

Crosshair target

  • crosshair_target.type: Either miss, block or entity string.
  • crosshair_target.value: Either empty string, Block or Entity.

Server

  • server: Server name.
  • server.tps: Server's TPS.
  • server.time: Server's time formatted as 16:00.
  • server.difficulty: Server's difficulty.
  • server.player_count: Server's player count.

Objects

Various variables and functions can return more complex objects which fields can be accessed using .. An empty means the object iself and not accessing any field.

Item

  • : Item's name formatted as Stone 32x or just Stone if count is 1.
  • name: Item's name.
  • count: Number of items.

Block

  • : Block's name.
  • pos: Block's position formatted as X: 0 Y: 0 Z: 0.
  • pos.x: Block's X position.
  • pos.y: Block's Y position.
  • pos.z: Block's Z position.

Entity

  • : Entity's name.
  • health: Entity's health or 0 if the entity doesn't have health.
  • pos: Entity's position formatted as X: 0 Y: 0 Z: 0.
  • pos.x: Entity's X position.
  • pos.y: Entity's Y position.
  • pos.z: Entity's Z position.
Clone this wiki locally