WoWAnalyzer is a tool to help you analyze and improve your World of Warcraft raiding performance through various relevant metrics and gameplay suggestions.
NOTE: Join our server on Discord to have a chat and get any assistance needed.
First make sure you have the following:
- git
- Optional: Get a UI such as GitHub Desktop or TortoiseGit
- Node.js. We recommend the current version.
Now you need to pull a copy of the codebase onto your computer. Make a fork of the repo by clicking the Fork button at the top of this page. Next, click the green button Clone or download and copy your Clone with HTTPS URL, and then run the command git clone <paste link>. This will take a minute.
When cloning finishes, open a command window to the source and run the command npm install. This will take a minute or two the first time. While it's running, copy the .env.local.example file in the project root, and name it .env.local. Now you need to fill the WCL API key. To get your key, login to Warcraft Logs and go to your profile. Scroll to the bottom, enter an Application Name (this is required) and copy the public key, then replace INSERT_YOUR_OWN_API_KEY_HERE in .env.local with this key.
Once all that's done you're ready to fire up the development server! Just run the command npm start in the project root. The first start will take another minute.
 |
There's also a Docker container available so you don't have to install any software other than Git (and your IDE). Follow the above steps, skipping all `npm` commands, and then fire up the Docker container with docker-compose up dev (first start might take a few minutes). Just like the regular development environment it will automatically recompile your code and refresh your browser whenever you make changes to the code so long as it is running. The app will be available at http://localhost:3000/. |
If you are currently dealing with some path errors (module not found), instead of running npm start, run NODE_PATH=src/ npm run start.
If you are getting Error: Invalid key specified, ensure your key is correct in .env.local and restart npm start after changing the file so the new value is loaded (.env files are cached).
If you are getting an error about a missing module or library you might have to update your dependencies. Run npm install or docker-compose build dev if you're using the Docker container. Make sure there's no running npm start or npm test when you do as they might lock files.
See the contributing guidelines for further information.
All contributions, big or small, are welcome. You are welcome to contribute to this project with whatever level of contribution you are comfortable with. We have no expectations for the amount or frequency of contributions from anyone.
We want to share ownership and responsibility with the community where possible. To help with this we hand out write access when we deem pull requests consistently of sufficient quality. This isn't always on our mind though so if you think you qualify please contact an admin.
This project aims to give users tools to analyze their performance. The most important part of this is providing automated suggestions towards improving their performance based on recorded fights. This makes it so users can quickly, without any hassle and at any time consult this tool to find out points of improvement for their next pull.
Our focus:
- Focus on one player at a time. A major reason for this is simplicity and giving the user a feeling of importance, but also because the Warcraft Logs API effectively only makes this available.
- The priority is raid fights, other environments aren't really supported. While it would be nice to show things like who killed the most Explosive Orbs, we can't really with the API endpoints available to us.
- Clear and concise suggestions that allow a user to quickly understand what potential issues and changes they need to make to improve. No hassle.
We also provide more advanced statistics such as item performance displays. These can be used to help pick what item to use or to see how effective certain abilities are that you can't find out elsewhere. These are secondary to suggestions and other tools that can be used to improve one's performance.
See the LICENSE file.
Usage of any API keys found in the source is not allowed for other purposes than described in the source code and/or its documentation. You must at all times use your own API keys.