WoWInterface SVN LibRealmInfo

LibRealmInfo
===============

Library to provide information about realms.

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 the player is currently on, you can use [GetCurrentRegion](http://wowpedia.org/API_GetCurrentRegion), but you should be aware that this function is not always reliable.

* **Download:** [Curse](http://wow.curseforge.com/addons/librealminfo) or [WoWInterface](http://www.wowinterface.com/downloads/info22987-LibRealmInfo.html)
* **Source, Issues, and Documentation:** [GitHub](https://github.com/Phanx/LibRealmInfo)


Embedding
------------

If you are the CurseForge/WowAce packager, you should use the following URL in your .pkgmeta file:

    svn://svn.wowinterface.com/LibRealmInfo-1100/trunk/LibRealmInfo-1.0

If you use a GitHub URL instead, you will get a number of irrelevant documentation and metadata files, and an extra layer of folders, since Git does not support checking out only part of the repository, and the Curse packager does not support checking out from GitHub over SVN. You're welcome to add `librealminfo` to the `tools-used` section of your .pkgmeta file so I get Curse points for the library usage, but it's not required.


Usage
--------

Available API methods:

* `:GetCurrentRegion()` - Get the two-letter abbrevation for the region the player is currently connected to; one of US, EU, KR, TW, or CN. Returns nil on PTR and Beta realms.
* `:GetRealmInfo(name[, region])` - Get information about a realm by name; if no region is provided, the player's current region will be assumed.
* `:GetRealmInfoByID(id)` - Get information about a realm by ID.
* `:GetRealmInfoByGUID(guid)` - Get information about the realm the given player GUID belongs to.
* `:GetRealmInfoByUnit(unit)` - Get information about the realm the given player unit belongs to.

All of the above methods return the following values:

1. `id` - the numeric unique ID of the realm
2. `name` - the name of the realm
3. `api_name` - the name of the realm without spaces, as seen in chat etc.
4. `rules` - one of "PVP", "PVE", "RP" or "RPPVP"
5. `locale` - the official language of the realm
6. `battlegroup` - the name of the realm's battlegroup
7. `region` - one of "US", "EU", "KR", "CN" or "TW"
8. `timezone` - for realms in the US region, a string describing the realm's time zone, eg. "PST" or "AEST"
9. `connections` - for connected realms, a table listing the IDs of connected realms
10. `latin_name` - for Russian-language realms, the English name of the realm
10. `latin_api_name` - for Russian-language realms, the English name of the realm without spaces

Note that the realm IDs contained in the GUIDs of player characters on connected realms indicate the realm hosting the connected realm group, which may not be the realm that character actually belongs to. Use [GetPlayerInfoByGUID](http://wowpedia.org/API_GetPlayerInfoByGUID) to get the real realm name, or use the :GetRealmInfoByGUID or :GetRealmInfoByUnit methods provided by LibRealmInfo.


To Do
--------

#### Data for Korean realms

If you have an active Korean account, please log into the Battle.net website, go to the Paid Character Transfer page, select a character, save the HTML source of the page (right-click, view source, save) and attach it to a ticket.

#### Connection data for Chinese and Taiwanese realms

If you can read Chinese, please locate the blog or forum post where Blizzard lists the connected realms for one or both of these regions and link to it in a ticket.