NameRetriever extends the /realname command from Essentials to work for offline players and allows players to get nicknames based off actual names. It also applies the realname command to the first (or first and second) parameter of any command listed in the config
When accessing log files from Essentials, this plugin uses a separate thread to prevent lag in the main thread (if useAsync is set to true in the config)
/realname - Shows the realname of a player based on their displayname. If no one is found with a matching displayname, it shows the realname and nickname of a player based on their realname
Aliases: /rname, /name
/realnick - shows the displayname of a player based on their realname
Alias: /rnick
/nameretriever reload - reloads the config file
/nameretriever version - shows the current version
/nameretriever help - shows help for the plugin
Note: /nr is an alias for /nameretriever
nameretriever.realname
Allows use of the /realname command
nameretriever.realnick
Allows use of the /realnick command
nameretriever.reload
Allows use of the /nameretriever reload command
nameretriever.version
Allows use of the /nameretriever version command
nameretriever.help
Allows use of the /nameretriever help command
showStatus:
When true, the online or offline status of a player is displayed along with their real- and nick-names
getOfflineAlways:
When true, the plugin searches through offline players even when it finds online players that match the parameter in the /realname and /realnick commands
nickIndicatorChar:
The character to display before someone's nickname. This only effects results returned via the realname and realnick commands. By default it is set to ~ to match Essentials' default
useAsync:
Set whether the plugin should make asynchronous calls when accessing nicknames stored on disk. It is recommended this be turned on especially on large servers to prevent server lag. The more players who have played on a server, the more time accessing the disk will take
cmdRegex1:
the regular expression for matching all commands that should have their first argument replaced by the "realname" of that argument
cmdRegex2:
the regular expression for matching all commands that should have their frist two arguments replaced by the "realnames" of theose arguments
NRAPI is the name of the API class. Use the static method NRAPI.getAPI() to get the singleton instance of the API. (It returns an object of type com.andoutay.nameretriever.NRAPI) All following methods are ment to be called on the singleton instance.
String getNick(String)
Returns the nickname associated with whatever Minecraft username is passed in. If an incomplete Minecraft username is passed in and more than one Minecraft username matches (based on players who have played on the current server), an empty string is returned. If no Minecraft username matches, null is returned.
HashMap\ getNicks(String)
Given a search string, getNicks returns a HashMap containing all matching Minecraft usernames and their associated nicknames including Minecraft usernames that do not have associated nicknames.
The HashMap is organized with username mapping to nickname (e.g. i_am_alive => ~Bob). For those who do not have a nickname, it maps username to username (e.g. i_am_alive => i_am_alive)
In the event that no Minecraft usernames match the search string, an empty HashMap is returned
HashMap\ getNames(String)
Given a search string, getNames returns a HashMap containing all matching nicknames and their associated Minecraft usernames. A player's display name does not count as a nickname if it is the same as their Minecraft username. Thus, if "alive" is passed as the search string and i_am_alive is a player who has played on the server who does not have a nickname, they will not be returned in the HashMap. However, if im_cooking has a nickname of WhosAliveNow, im_cooking => ~WhosAliveNow will be returned as a member of the HashMap.
Note that the tilde character will be whatever is specified for the nickIndicatorChar and is not guaranteed to be a single character. It is possible for the server administrator to put whatever they like for this config value.
In the event that no nicknames match the serach string, an empty HashMap is returned