AzerothCore Armory

About

AzerothCore-Armory is a website that enables you to view your AzerothCore server's characters and guilds.
At the time I started working on this project (end of 2021), there were virtually no modern and public/open-source armory projects.
I also noticed that such a tool was frequently requested in the AzerothCore Discord server, so I decided to make one. Hope you like it!

Built With

• Node.js
• TypeScript
• Express JS
• Handlebars
• JQuery
• DataTables
• Bulma

(back to top)

Getting Started

Prerequisites

• Node.js
• An AzerothCore-based server database
• (Optional) Docker

Installation

1. Clone the repository:
   • With HTTPS:

     git clone https://github.com/r-o-b-o-t-o/azerothcore-armory.git

     OR

   • With SSH:

     git clone git@github.com:r-o-b-o-t-o/azerothcore-armory.git

2. Install the dependencies:

   cd azerothcore-armory/
   npm install

3. Configure the application: copy config.default.json to config.json or .env.example to .env and edit the resulting file.
   See the Configuration Reference below for a description of all values.
4. Download the model viewer's data from the Releases page and extract it to the data/ directory.

Configuration Reference

(back to top)

Usage

Build the application:

npm run build

Start the application:

npm start

Open a web browser and navigate to http://localhost:48733

Other useful npm scripts:

• npm run clean: cleans the build directory
• npm run watch: watches for changes and rebuilds automatically, useful for development
• npm run cleardata: clears the data downloaded for the 3D model viewer

With Docker

You can also use Docker, simply use docker-compose:

cd azerothcore-armory/
docker-compose up -d

Note: the Docker version supports only the .env file for configuration, not config.json

With an iframe

You might want to integrate the application directly into your existing website using an iframe.

1. Set iframeMode.enabled to true in your configuration.
2. Set iframeMode.url in your configuration to the URL in your website that the armory will be accessible from (the page hosting the iframe).
3. Embed the code snippet below into your page.
   Make sure you replace the URL http://localhost:48733 with your Armory's URL (the same URL as iframeMode.url) at the end of the code snippet.
   Click to expand embed code

<style>
    #armory-iframe {
        /*
        * Using min-width to set the width of the iFrame, works around an issue in iOS that can prevent the iFrame from sizing correctly.
        * See: https://github.com/davidjbradshaw/iframe-resizer
        */
        width: 1px;
        min-width: 100%;

        border: none;
    }
</style>

<iframe id="armory-iframe"></iframe>

<script type="application/javascript" src="https://cdn.jsdelivr.net/npm/iframe-resizer@4.3.2/js/iframeResizer.min.js"></script>
<script type="application/javascript">
    let resizeSetup = false;
    window.addEventListener("message", (ev) => {
        if (ev.data.url !== undefined) {
            const url = ev.data.url.trim().replace(/^\//, "");
            window.history.replaceState(null, null, url === "" ? window.location.pathname : ("?" + url));
        } else if (ev.data === "contentLoaded") {
            if (!resizeSetup) {
                iFrameResize({ checkOrigin: false, autoResize: true }, "#armory-iframe");
                resizeSetup = true;
            } else {
                document.getElementById("armory-iframe").iFrameResizer.resize();
            }
        }
    });

    const iframe = document.getElementById("armory-iframe");
    const url = window.location.search.replace(/^\?/, "");
    iframe.src = "http://localhost:48733/" + url;
</script>

Demo

This repository is used in production over at ChromieCraft, check it out there!

(back to top)

Features

• [X] Characters list / search page
• [X] Character page
  • [X] Online/offline status
  • [X] Equipment with tooltips
  • [X] 3D model, including mounts and transmogrifications
  • [X] Talent trees, including glyphs and dual spec support
  • [X] Achievements
  • [X] PvP statistics, including arena teams
  • [ ] Statistics (from the achievements panel in-game)
  • [ ] Reputations
  • [ ] Stats (from the character sheet, i.e. health, mana, etc)
• [X] Guild page
  • [X] Guild emblem
  • [X] Members list
  • [ ] PvE statistics
• [X] Multiple realms support
• [ ] PvE ladder
• [ ] PvP ladder
• [X] Arena ladder
• [ ] Achievements ladder

See the open issues for a list of suggested features and known issues.

(back to top)

Contributing

Any and all contributions are greatly appreciated.

If you have a suggestion that would make this project better, feel free to fork the repository and create a Pull Request. You can also open a Feature Request.

(back to top)

Show your Support

⭐️ Give the project a star if you like it!

(back to top)

License

Distributed under the MIT License. See the LICENSE file for more information.

(back to top)

Contact

Feel free to get in touch with me on Discord: roboto_

(back to top)