Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/itsdouges/armory-embeds

🛡 Embed Guild Wars 2 widgets on your site!
https://github.com/itsdouges/armory-embeds

embed guildwars2 gw2

Last synced: 2 months ago
JSON representation

🛡 Embed Guild Wars 2 widgets on your site!

Awesome Lists containing this project

README 

        
# [armory-embeds](https://github.com/madou/armory-embeds)



[![NPM version](http://img.shields.io/npm/v/armory-embeds.svg?style=flat-square)](https://www.npmjs.com/package/armory-embeds)

[![NPM downloads](http://img.shields.io/npm/dm/armory-embeds.svg?style=flat-square)](https://www.npmjs.com/package/armory-embeds)

[![Discord](https://img.shields.io/badge/discord-GW2Armory-blue.svg)](https://discord.gg/3BRbV7b)



Guild Wars 2 Armory is arming the GW2 community with powered up embeds for items, 

skills, 

and more. 



Want something more low level? Want to integrate directly with your React app instead of this high level abstraction?

Check out the [`armory-ui-components`](https://github.com/madou/armory-component-ui) library.



## Usage



First add the embeds to your html:



```html



  



```



Then add the embed script after them:



```html



```



When the document has fully loaded the embeds will then be loaded.



Note the semvar range. When breaking changes are introduced, this will be incremented by one every time. For example from `@^0.x.x` to `@^1.x.x`.



## Supplementary Libraries



- [armory-embeds-chat-codes](https://github.com/madou/armory-embeds-chat-code) - parses an ingame chat code to armory embed markup.



## [Options](https://madou.github.io/armory-embeds/?selectedKind=options)



### Global Settings



Entirely optional.



Create an object on the document object named `GW2A_EMBED_OPTIONS`. See below for an example.

Make sure the assign this config _before_ declaring the `gw2a` script.



| prop | type | required | description |

|-|-|-|-|

| lang | string | no | The language the embeds will be loaded in. Supported values are: en, fr, de, es, zh, ru |

| persistToLocalStorage | boolean | no | Turns data persistence on or off. Default to true. |

| forceCacheClearOnNextRun | string | no | Forces data cache to be cleared. Use wisely. Use a unique key every time you want to clear the cache. |



```javascript

document.GW2A_EMBED_OPTIONS = {

  lang: 'en',

  persistToLocalStorage: true,

  forceCacheClearOnNextRun: '1',

};

```



### Styles



Each embed has a class that you can target, each class follows the pattern `.gw2a-{EMBED_NAME}-embed`.



```css

.gw2a-character-embed {}

.gw2a-skills-embed {}

.gw2a-items-embed {}

.gw2a-amulets-embed {}

.gw2a-traits-embed {}

.gw2a-specializations-embed {}

```



## Embeds



### [Skills](https://madou.github.io/armory-embeds/?selectedKind=Skills)






```html










```



| attribute | value | required | description |

|-|-|-|-|

| data-armory-embed | skills | yes | |

| data-armory-ids | numbers delimited by commas | yes | The skill ids you want to load. If you pass `-1` you will load an empty box instead of the skill. |

| data-armory-size | number | no | The size of each skill in the embed. |

| data-armory-blank-text | string | no | When loading an skill of id `-1` you can override the tooltip text to be whatever you want. |

| data-armory-inline-text | string | no | Optional inline text that will be displayed to the right of the icon. You can pass in `wiki` to use a gw2 wiki URL, or pass in any other text that will be used as the link. |



### [Items](https://madou.github.io/armory-embeds/?selectedKind=Items)






```html










```



| attribute | value | required | description |

|-|-|-|-|

| data-armory-embed | items | yes | |

| data-armory-ids | numbers delimited by commas | yes | The item ids you want to load. If you pass `-1` you will load an empty box instead of the item. |

| data-armory-size | number | no | The size of each item in the embed. |

| data-armory-blank-text | string | no | When loading an item of id `-1` you can override the tooltip text to be whatever you want. |

| data-armory-{ITEM_ID}-stat | number | no | Loads the item with the stat of choice. |

| data-armory-{ITEM_ID}-skin | number | no | Loads the item with the skin of choice. |

| data-armory-{ITEM_ID}-upgrades | number | no | Loads the item with the upgrades of choice. |

| data-armory-{ITEM_ID}-infusions | number | no | Loads the item with the infusions of choice. |

| data-armory-{ITEM_ID}-upgrade-count | stringified `{ [number]: number }` | no | Sets the upgrade counts. |

| data-armory-inline-text | string | no | Optional inline text that will be displayed to the right of the icon. You can pass in `wiki` to use a gw2 wiki URL, `gw2spidy` to use a gw2spidy URL, or pass in any other text that will be used as the link. |



### [Specializations](https://madou.github.io/armory-embeds/?selectedKind=Specializations)






```html





```



| attribute | value | required | description |

|-|-|-|-|

| data-armory-embed | specializations | yes | |

| data-armory-ids | numbers delimited by commas | yes | The specialization ids you want to load. |

| data-armory-{SPEC_ID}-traits | numbers delimited by commas | no | Traits you want to select for the specialization. Entirely optional, you can select any combination. |



### [Traits](https://gw2armory.com/embeds#traits)






```html





```



| attribute | value | required | description |

|-|-|-|-|

| data-armory-embed | traits | yes | |

| data-armory-ids | numbers delimited by commas | yes | The trait ids you want to load. If you pass `-1` you will load an empty box instead of the trait. |

| data-armory-size | number | no | The size of each trait in the embed. |

| data-armory-blank-text | string | no | When loading an trait of id `-1` you can override the tooltip text to be whatever you want. |

| data-armory-inline-text | string | no | Optional inline text that will be displayed to the right of the icon. You can pass in `wiki` to use a gw2 wiki URL, or pass in any other text that will be used as the link. |



### [Amulets](https://madou.github.io/armory-embeds/?selectedKind=Amulets)






```html






```



| attribute | value | required | description |

|-|-|-|-|

| data-armory-embed | amulets | yes | |

| data-armory-ids | numbers delimited by commas | yes | The amulet ids you want to load. If you pass `-1` you will load an empty box instead of the amulet. |

| data-armory-size | number | no | The size of each amulet in the embed. |

| data-armory-blank-text | string | no | When loading an amulet of id `-1` you can override the tooltip text to be whatever you want. |

| data-armory-inline-text | string | no | Optional inline text that will be displayed to the right of the icon. You can pass in `wiki` to use a gw2 wiki URL, or pass in any other text that will be used as the link. |



## Finding IDs



Unfortunately you can't pass the embeds the item/skill etc names. You have to pass the specific ids.



### Item IDs



Item IDs are easy enough, go look at https://www.gw2spidy.com.



### Skill/Trait/Specialization IDs



Best bet is to look at the GW2 Wiki, for example: https://wiki.guildwars2.com/wiki/Virtue_of_Justice.



## Who Is Using armory-embeds?



- [MetaBattle](https://metabattle.com) *for builds for all gamemodes in Guild Wars 2*

- ~~[Quantify](https://qtfy.eu)~~ *Currently Offline*

- [Le Bus Magique](http://www.lebusmagique.fr) *event-driven french community guild evolving on Guild Wars 2*

- ~~[mists.co](http://mists.co)~~ *Currently Offline*

- [Lucky Noobs](https://lucky-noobs.com)  *benchmarks, builds, raids in English and German*

- ~~[Discretize](http://discretize.eu)~~ *Now uses [discretize-ui](https://github.com/discretize/discretize-ui)*

- ~~[Abaddons Maul](https://abaddons-maul.de)~~ *Currently Offline*

- [Chains of the Kraken](https://ctk.enjin.com) *Comming Soon since 2019*

- [Snow Crows](http://snowcrows.com) *benchmarks, builds, raids, strikes, and dungeons*

- ~~[SPF Gaming](http://spf-gaming.de/)~~ *Currently Offline*

- [Accessibility Wars Too](https://accessibilitywars.com/) *Low-Intensity Accessible Builds for Guild Wars 2*



[Don't see your site? Add it in a Pull Request!](https://github.com/madou/armory-react/pulls)



## Troubleshooting



Hit [@itsmadou](https://twitter.com/itsmadou) up on twitter, or [post an issue](https://github.com/madou/armory-react/issues) if you think something is a bug.



## Local Development



### Getting started



```sh

git clone [email protected]:madou/armory-embeds.git

cd armory-embeds

yarn install

npm run tdd # Run tests in watch mode

npm start # Run react storybook for local development

```



© 2015-present gw2armory.com