Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/breakbb/disenchantbuddy

Disenchant Buddy is a lightweight World of Warcraft addon that displays disenchant results on item tooltips.
https://github.com/breakbb/disenchantbuddy

addon lua world-of-warcraft world-of-warcraft-addon world-of-warcraft-classic wow wow-addon

Last synced: 16 days ago
JSON representation

Disenchant Buddy is a lightweight World of Warcraft addon that displays disenchant results on item tooltips.

Host: GitHub
URL: https://github.com/breakbb/disenchantbuddy
Owner: BreakBB
License: gpl-3.0
Created: 2024-11-26T16:13:37.000Z (26 days ago)
Default Branch: main
Last Pushed: 2024-12-06T06:46:34.000Z (16 days ago)
Last Synced: 2024-12-06T07:07:24.251Z (16 days ago)
Topics: addon, lua, world-of-warcraft, world-of-warcraft-addon, world-of-warcraft-classic, wow, wow-addon
Language: Lua
Homepage:
Size: 3.25 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: changelog.py
- License: LICENSE.md

Awesome Lists containing this project

README

# Disenchant Buddy

[![Downloads](https://img.shields.io/github/downloads/BreakBB/DisenchantBuddy/total.svg)](https://github.com/BreakBB/DisenchantBuddy/releases/)
[![Downloads Latest](https://img.shields.io/github/downloads/BreakBB/DisenchantBuddy/v1.2.3/total.svg)](https://github.com/BreakBB/DisenchantBuddy/releases/latest)

Disenchant Buddy is a lightweight World of Warcraft addon that displays disenchant results on item tooltips.
It helps players to quickly see what materials they can expect to receive from disenchanting an item.

When [Auctionator](https://github.com/Auctionator/Auctionator) is installed, then Disenchant Buddy will also show the auction prices for the materials.

## Compatibility

Disenchant Buddy is compatible with and available for the following World of Warcraft versions:

- Classic Era/HC/Anniversary :white_check_mark:
- Season of Discovery :white_check_mark:
- Wrath of the Lich King :hourglass_flowing_sand: (will be added soon)
- Cataclysm :hourglass_flowing_sand: (will be added soon)
- Retail :x: (not planned)

## Installation

I suggest you use an addon manager like the [CurseForge Client](https://curseforge.overwolf.com/) to ease the installation and update process. You will find
DisenchantBuddy [here on CurseForge](https://www.curseforge.com/wow/addons/disenchantbuddy).

Alternatively you can always use [the latest GitHub release](https://github.com/BreakBB/DisenchantBuddy/releases/latest) and manually install it:

1. Extract the contents of the zip file to your World of Warcraft Interface\AddOns directory:
- Era/HC/Anniversary/SoD: `World of Warcraft\_classic_era_\Interface\AddOns\DisenchantBuddy`
2. Restart World of Warcraft or reload your UI

## Development

### luacheck

This project uses [luacheck](https://github.com/lunarmodules/luacheck/) for linting. To run the linter, execute the following command:

```sh
luacheck -q .
```

### Unit Tests

This project uses [busted](https://github.com/lunarmodules/busted) for unit testing. To run the tests, execute the following command:

```sh
busted -p ".test.lua" .
```