Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weakauras/weakauras-companion
A cross-platform application built to provide the missing link between Wago.io and World of Warcraft
https://github.com/weakauras/weakauras-companion
electron electron-app electron-vue vite vue wago warcraft weakauras weakauras-companion world-of-warcraft
Last synced: 4 days ago
JSON representation
A cross-platform application built to provide the missing link between Wago.io and World of Warcraft
- Host: GitHub
- URL: https://github.com/weakauras/weakauras-companion
- Owner: WeakAuras
- License: gpl-2.0
- Created: 2018-11-14T14:20:12.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-14T14:02:11.000Z (26 days ago)
- Last Synced: 2024-12-29T05:05:26.627Z (11 days ago)
- Topics: electron, electron-app, electron-vue, vite, vue, wago, warcraft, weakauras, weakauras-companion, world-of-warcraft
- Language: Vue
- Homepage: https://weakauras.wtf
- Size: 99.1 MB
- Stars: 163
- Watchers: 11
- Forks: 50
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WeakAuras Companion
[](https://github.com/WeakAuras/WeakAuras-Companion/actions?workflow=Windows%20Build/) [](https://github.com/WeakAuras/WeakAuras-Companion/actions?workflow=Linux%20Build/) [](https://github.com/WeakAuras/WeakAuras-Companion/actions?workflow=macOS%20Build/) [](https://www.patreon.com/weakauras)
The WeakAuras Companion is a cross-platform (Windows/macOS/Linux) application built to provide the missing link between [Wago](https://wago.io) and the WeakAuras World of Warcraft addon.
It enables you to fetch updates to the auras you have installed directly from Wago, without having to manually copy-paste import strings all the time. It also makes sure you don't miss any updates, always keeping you up to date with the latest versions.
## How to Use
### Install
#### Manual
Download and install the WeakAuras Companion from [our website](https://weakauras.wtf/) or [GitHub](https://github.com/WeakAuras/WeakAuras-Companion/releases/latest).
#### Homebrew
Install using [Homebrew](https://brew.sh/) by running the following command in your **Terminal**:
```bash
brew install --no-quarantine weakauras-companion
```
### With WeakAuras
- Start the Companion, it will ask you to give it at least your World of Warcraft folder and account name.
- Follow the instructions inside the app
- Click on 'Fetch Updates', this is also done automatically once every hour.
- Restart World of Warcraft or reload your UI. The first time you start WeakAuras Companion, you will have to restart the game for it to be able to load the addon.
- Now open the WeakAuras panel in-game and look for the new 'update-available' icon next to the names in the list.
- After clicking on it, you get the usual choice of being able to upgrade or import as copy. That's it!
### With Plater
- Follow the steps above in 'How to Use' for WeakAuras to install and configure the WeakAuras Companion up to the point after restarting World of Warcraft / reloading your UI.
- Each 'Fetch' for new updates will recognize installed Plater Profiles, Mods and Scripts. Please note, that you need to have them copied and installed from wago.io prior to being able to receive updates this way.
- Now open the Plater options panel in-game and look for the wago icons on the Scripting, Modding or Profiles tab. Those icons indicate available updates in this category, as can be seen on (1.) on the screenshots below.
#### Updating Profiles
To update your profile, go to the Profiles tab and check the wago.io Profile Information (2.), then click on 'Update Profile' (3.) - You will be prompted to update.
#### Updating Mods and Scripts
The update procedure for Mods and Scripts is identical:
First check for available updates indicated by the small wago icon on the respective tab (1.), then find the update indicator on the Mod/Script (2.).
The tooltip will give you additional information about the update (3.).
To update a Mod or Script, either click on the wago icon (2.) or use the right-click menu on the Mod or Script and select 'Update from Wago.io' (3.).
You will be prompted to either overwrite the existing version (Yes) or to create a copy (No).
Cancelling the operation is possible by closing the prompt window by clicking on the 'X' on the top right.
### Backups
The Companion is able to regularly create backups of your WeakAuras so you don't lose them in case of a crash or other accident. This option needs to be enabled manually in the options.
### Known Issues
- If you previously downloaded an aura from Wago that is not a whole group and put it into one of your own custom groups, the Companion will not show any updates for it.
## Contributing
### Build Setup
```bash
# install dependencies
pnpm install
# serve with hot reload at localhost:9080
pnpm run dev
# build electron application for production
pnpm run build
```
### Extract new translation strings to i18n/*.json files
```bash
pnpm run i18n
```