Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 3.28 KB

README.md

File metadata and controls

44 lines (36 loc) · 3.28 KB
Raw

This is a BitBar plugin (supporting both SwiftBar and xbar) that shows who is currently online on Wurstmineberg.

For an equivalent Windows app, see wurstmineberg/systray.

Installation

  1. Install SwiftBar or xbar.
    • If you're unsure which to install, we recommend SwiftBar, as this plugin has been tested with that.
    • If you have Homebrew, you can also install with brew install --cask swiftbar or brew install --cask xbar.
  2. Install Rust.
    • If you have Homebrew, you can also install with brew install rust.
  3. Install the plugin: 
    cargo install --git=https://github.com/wurstmineberg/bitbar-server-status --branch=main
  4. Create a symlink to ~/.cargo/bin/bitbar-wurstmineberg-status into your SwiftBar/xbar plugin folder. Name it something like wurstmineberg.45s.o, where 45s is the rate of update checks.
  5. Refresh SwiftBar/xbar by opening a menu and pressing ⌘R.

Updating

  1. Install the updater: 
    cargo install cargo-update
  2. Update the plugin (and everything else installed via cargo install): 
    cargo install-update --all --git

Configuration

You can optionally configure the behavior of the plugin by creating a JSON file at bitbar/plugins/wurstmineberg.json inside an XDG config directory. All entries are optional:

  • deferSpecs: An array of timespecs, with each timespec stored as an array of strings. Adds menu items that when clicked hide the plugin until the specified time.
  • ignoredPlayers: An array of Wurstmineberg IDs and/or Discord snowflakes of players who should not be listed. To ignore a player who has both a Wurstmineberg ID and a Discord snowflake, list the Discord snowflake.
  • showIfEmpty: If false, the plugin is hidden entirely if the main world is running but no players are online on any world. Defaults to false.
  • showIfOffline: If false, the plugin is hidden entirely if the main world is not running and no players are online on any world. Defaults to false.
  • singleColor: If true and exactly one player is online, the plugin's icon and the “1” player count text are colored in that player's favorite color, as set in their Wurstmineberg preferences. Defaults to true.
  • versionLink: One of the following:
    • true: Clicking on the version info menu item opens the Minecraft Wiki article for that version. This is the default.
    • "alt": Holding ⌥ turns the version info menu item into a link to the Minecraft Wiki article for that version.
    • false: The version info item is still displayed but cannot be clicked.
  • versionMatch: An object mapping Minecraft launcher profile IDs to Wurstmineberg world names. Each launcher profile's selected Minecraft version will be kept in sync with the version running on that world.
  • zoom: A number indicating the logical pixel scale, e.g. 2 on most modern Mac displays. Defaults to 1.