You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
33 lines
2.1 KiB
33 lines
2.1 KiB
5 years ago
|
LibRealmInfo
|
||
|
|
===============
|
||
|
|
|
||
|
|
Library to provide information about realms.
|
||
|
|
|
||
|
|
* [Download on CurseForge](https://wow.curseforge.com/projects/librealminfo)
|
||
|
|
* [Download on WoWInterface](https://www.wowinterface.com/downloads/info22987-LibRealmInfo.html)
|
||
|
|
* [Source Code on GitHub](https://github.com/phanx-wow/LibRealmInfo)
|
||
|
|
* [Issue Tracker on GitHub](https://github.com/phanx-wow/LibRealmInfo/issues)
|
||
|
|
|
||
|
|
|
||
|
|
Documentation
|
||
|
|
----------------
|
||
|
|
|
||
|
|
* [API functions](https://github.com/phanx-wow/LibRealmInfo/wiki/API)
|
||
|
|
* [Adding LibRealmInfo to your addon](https://github.com/Phanx/LibRealmInfo/wiki/Embedding)
|
||
|
|
|
||
|
|
|
||
|
|
Caveats
|
||
|
|
----------
|
||
|
|
|
||
|
|
If you only need to know the names of realms connected to the player's current realm, you should just use [GetAutoCompleteRealms](http://wowpedia.org/API_GetAutoCompleteRealms) instead of this library.
|
||
|
|
|
||
|
|
If you only need to know which region (US, Europe, etc.) the player is currently in, you can try [GetCurrentRegion](http://wowpedia.org/API_GetCurrentRegion), but you should be aware that this function may return incorrect values for players whose game clients have connected to multiple regions.
|
||
|
|
|
||
|
|
### Realm IDs in player GUIDs are not reliable
|
||
|
|
|
||
|
|
The realm IDs encoded in the GUIDs of player characters on connected realms identify the server currently hosting the connected realm group, which may not be the realm that character actually belongs to. Pass the GUID to [GetPlayerInfoByGUID](http://wowpedia.org/API_GetPlayerInfoByGUID) to get the character's real realm name, or use the `GetRealmInfoByGUID` or `GetRealmInfoByUnit` methods provided by LibRealmInfo.
|
||
|
|
|
||
|
|
### Chinese realm info out of date
|
||
|
|
|
||
|
|
Realm info is obtained from the Blizzard Developer API for accuracy, but getting info about Chinese realms would require a separate Chinese Battle.net account, which I do not have. The info for Chinese realms in LibRealmInfo is therefore the old manually compiled data, which may be inaccurate or outdated, and info about connected realms is missing entirely. If you have a Chinese Battle.net account and are willing to help, please [open a ticket](https://github.com/phanx-wow/LibRealmInfo/issues) or [email me](mailto:addons@phanx.net).
|