An open API service indexing awesome lists of open source software.

https://github.com/raincamp/hybar

卄乇ㄥㄥ ㄚ乇卂卄
https://github.com/raincamp/hybar

action-bar addon classic-era curseforge lua world-of-warcraft world-of-warcraft-addon wow-classic wow-classic-addon

Last synced: 5 months ago
JSON representation

卄乇ㄥㄥ ㄚ乇卂卄

Awesome Lists containing this project

README

          

# hybar

![Version](https://img.shields.io/badge/version-1.2.0--alpha-blue)
![License](https://img.shields.io/badge/license-MIT-green)
![WoW](https://img.shields.io/badge/wow-TBC%20Classic%20Anniversary%202.5.5-orange)
![Interface](https://img.shields.io/badge/interface-20505-yellow)
[![CurseForge](https://img.shields.io/badge/CurseForge-980904-orange)](https://www.curseforge.com/wow/addons/hybar)
![Issues](https://img.shields.io/github/issues/raincamp/hybar)
![Pull Requests](https://img.shields.io/github/issues-pr/raincamp/hybar)
![Last Commit](https://img.shields.io/github/last-commit/raincamp/hybar)

![hybar banner](assets/hybanner.webp)

action-oriented high bar communication

---

## Features

### Core
- **2-Button Action Bar**: Quick access to guild chat and yell macros
- **Draggable Interface**: Position the bar anywhere on your screen
- **TBC Classic Anniversary**: Built specifically for Burning Crusade Classic Anniversary Edition (Interface 20505)

### Appearance & Customization
- **Transparency Control**: Adjust bar opacity from 0-100%
- **Scale Slider**: Resize the bar from 50% to 200%
- **High-Contrast Mode**: Enhanced visibility option for accessibility
- **Visual Feedback**: Fade animations, hover effects, unlock indicator

### Configuration
- **Expanded Settings Panel**: Organized sections for Behavior, Appearance, and Position
- **Position Management**: Reset button and live position preview
- **Sound Feedback**: Optional audio confirmation on button clicks
- **Keyboard Navigation**: Full Tab/Arrow key support with focus indicators

### Accessibility
- **Combat Protection**: Safe handling during combat lockdown
- **Tooltips**: Helpful descriptions for all controls
- **Color-Coded Controls**: Visual priority indicators

![hybar in action](assets/hyshot.webp)

---

## Installation

### Via CurseForge (Recommended)

1. Visit the [hybar CurseForge page](https://www.curseforge.com/wow/addons/hybar)
2. Download using the CurseForge client or manually download the latest version
3. The addon will be automatically installed to your WoW addons folder

### Manual Installation

1. Download the latest release from the [Releases page](https://github.com/raincamp/hybar/releases)
2. Extract the `hybar` folder to your WoW addons directory:
- **Windows**: `C:\Program Files (x86)\World of Warcraft\_anniversary_\Interface\AddOns\`
- **macOS**: `/Applications/World of Warcraft/_anniversary_/Interface/AddOns/`
3. Restart WoW or type `/reload` if already in-game

---

## Usage

### Slash Commands

| Command | Description |
|---------|-------------|
| `/hybar` | Open configuration panel |
| `/hellyeahbar` | Open configuration panel (alias) |
| `/hyb` | Open configuration panel (alias) |
| `/hybar reset` | Reset all settings to defaults |
| `/hybar status` | Display current settings |
| `/hybar help` | Show available commands |

### Action Bar Buttons

- **Button 1** (Rally Cry icon): Sends "hell yeah brother" to `/y` (yell chat)
- **Button 2** (Green Dragon icon): Sends "hell yeah brother" to `/g` (guild chat)

### Moving the Bar

1. Open the config panel with `/hybar`
2. Uncheck "Lock Position"
3. Drag the action bar to your desired location
4. Check "Lock Position" to prevent accidental movement

---

## Configuration

The configuration panel (350x420px) is organized into sections:

### Behavior
- **Enable**: Show/hide the action bar
- **Lock Position**: Prevent the bar from being moved
- **Welcome Message**: Display a welcome message when logging in
- **Sound Feedback**: Play sound on button clicks

### Appearance
- **Transparency**: Adjust bar opacity (0-100%)
- **Scale**: Resize the bar (50-200%)
- **High-Contrast Mode**: Enhanced visibility borders

### Position
- **Reset Position**: Return bar to default center location
- **Position Preview**: Shows current anchor point and coordinates

All settings are saved per character and persist across sessions.

---

## Development

Interested in contributing? Check out our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on:

- Reporting bugs
- Suggesting features
- Submitting code changes
- Development setup and testing procedures
- Code style guidelines

### Project Structure

```
hybar/
├── locales/ # Localization strings
├── util/ # Utility functions
├── conf/ # Configuration logic and UI
├── bar/ # Action bar implementation
├── core/ # Event handlers and initialization
├── functions/ # Slash commands
└── hybar.toc # Addon metadata and file loading order
```

---

## Support & Community

- **Issues**: [Report bugs or request features](https://github.com/raincamp/hybar/issues)
- **CurseForge**: [hybar on CurseForge](https://www.curseforge.com/wow/addons/hybar)
- **Email**: cam@raincamp.ai

---

## License

This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.

---

## Acknowledgments

- special thanks to [ExtraThiccText](https://lingojam.com/ExtraThiccText) for the inspiration