Giter Site home page Giter Site logo

pewtro / weakauras-companion Goto Github PK

View Code? Open in Web Editor NEW

This project forked from weakauras/weakauras-companion

0.0 0.0 0.0 52.31 MB

A cross-platform application built to provide the missing link between Wago.io and World of Warcraft

Home Page: https://weakauras.wtf

License: GNU General Public License v2.0

Shell 0.54% JavaScript 9.64% TypeScript 16.79% Vue 68.99% EJS 0.50% SCSS 3.55%

weakauras-companion's Introduction

WeakAuras Companion

Build Status Build Status Build Status Patreon

The WeakAuras Companion is a cross-platform (Windows/macOS/Linux) application built to provide the missing link between Wago 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.

preview

How to Use

WeakAuras

  • Download and install the WeakAuras Companion from our website or GitHub.
  • 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!

preview2

preview3

preview4

Updating Plater Profiles, Mods or Scripts

  • 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.

preview5

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.).

preview6

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.).

preview7

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.

preview8

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.

preview9

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.

Other Addons

  • We recently took a pull request that adds Plater support to the Companion. Since Plater profiles and mods could already be shared on wago.io, it was the logical next step to add them to Companion.
  • Support for additional Addons can be implemented by adding an addon-configuration and SavedVariables parser to the existing framework.

Contributing

Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:9080
npm run dev

# build electron application for production
npm run build

Extract new translation strings to i18n/*.json files

npm run i18n

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.