flagRSP documentation

Welcome to flagRSP documentation. Here you can find documentation, the flagRSP FAQ and some important links. Most up to date information about flagRSP can always be found at the official homepage (http://flokru.org/flagrsp/) of flagRSP.

Please report bugs (even spelling or language mistakes) or send suggestions for flagRSP to the following address AFTER READING THE FAQ:

What is flagRSP?

flagRSP is an addon (also known as UI customization) for the popular MMORPG World of Warcraft. It's dedicated for roleplayers (please note that roleplaying means more than actually playing a roleplaying game). flagRSP adds several features to enhance and improve the roleplaying experience in WoW.

flagRSP is based on xTooltip by Peer 'Doxxan' Lönn Wege. This addon was changed by me to work on the German WoW client (see xTooltip2). At the same time Zmrzlina began developing "flagRSP & Friendlist". xTooltip2 and "flagRSP & Friendlist" were merged together into "flagRSP & Friendlist". After Zmrzlina has left WoW I am the current developer of this addon which is only called flagRSP to simplify matters.

flagRSP features

Set one of four roleplaying flags to show other players your preffered roleplaying style. These flags will be visible to other flagRSP users.
Set one of four character states to show other players how much in character you currently are, if you are searching for contact or if you are trying to tell a story.
Choose a surname and title for your character that other users can see.
Enter a description of the outward appearance of your character that other users will be able to see.
An enhanced Friendlist with the possibility to add players (of both factions), NPCs and even guilds.
- Choose several categories (currently "Friend", "Foe", "Known"; more will follow) for all entries.
- Add detailed notes containing of multiple lines for each entry.
Hide names of unknown players and replace exact level information of all units by relative ones (from "extremely puny" to "hopelessly superior"). Both options are optional!
Character settings (surname, title, description, RP flag, character state) can be configured via GUI. More graphic dialogs will follow.
Completely localized in English and German. Also fully compatible with the French WoW client (flagRSP itself will be English on French client).
Load on demand capability. flagRSP contains a small helper addon flagRSPLoader that manages loading of flagRSP in general, for specific realms and characters. Can be configured to use flagRSP only for certain characters/realms.
Every feature is optional.

Installation instructions

Installation of flagRSP is simple. Just extract the ZIP file into your World of Warcraft directory (be sure to extract the folder structure as well and not only the plain files) or select your World of Warcraft directory for the installer. After this the addons should work.

There should be a message that flagRSP is initializing in game in your chat window. After approximately one minute there should be another message that flagRSP has been initialized. Furthermore there should be a button for Friendlist near the minimap.

If anything goes wrong be sure to check the FAQ first. Most install problems can be solved easily.

IMPORTANT: Normally the following step should be unnecessary. Unfortunately this does not work occasionally for unknown reasons.

After installation you have to check if flagRSP could properly join the chat channel "xTensionXTooltip2". Normally this should happen automatically after one or two minutes (after flagRSP says it is initialized). However, under unknown circumstances (mostly in context with Cosmos) this occasionally failes.

Therefore, move your mouse pointer into you main chat frame so that the tab "General" becomes visible. Right click on this to open the menu. Under the point "Channels" should be a list of all active chat channels.

In this list there should be "xTensionXTooltip2" (perhaps in lower case). If this is not the case you have to manually join this channel. To do so enter this command:

After this the channel should appear in the list even after restarting the game.

Some notes about preview releases

Some versions of flagRSP are preview releases or release candidates. Please pay attention to the following notes if using such a release:

If you just want to use flagRSP without having problems please do not use these versions. Use the more stable normal releases instead.
Preview releases can be EXTREMELY EXPERIMENTAL. There will definitely be bugs in these releases. Perhaps these bugs will not affect you, perhaps they will. I release these preview releases to give brave users the possibility to test the newest bleeding edge features.
There will (perhaps) be features that do not work yet (i.e. buttons that do nothing etc.). If you think you have discovered a bug please check the changelog first. Perhaps the feature has just not been implemented and thus certainly won't work.
If you use a preview release and discover a bug, please report it! The intention of these releases is to find bugs. Some bugs do never appear for me. Only by receiving bug reports I can develop more stable versions.

Safety

This point is very important! flagRSP has no ability to write down its own data into a separate file. Therefore, flagRSP CANNOT make backups of any settings you made and more important backups of your Friendlist entries and your personal description!

flagRSP can tell WoW which data it should save for flagRSP. However, WoW might instantly delete this data if anything goes wrong (WoW crashes, bugs etc.).

However, losing your Friendlist entries or your description because WoW or flagRSP got something wrong can be very painful. Therefore you should backup these settings as often as possible!

How to backup your settings: Look into your WoW directory. There should be a subdirectory called WTF. Follow the path "WTF\Account\<your accountname>\SavedVariables\". In this directory there should be several .lua and .lua.bak files. For flagRSP you will need flagRSP.lua, flagRSPLoader.lua and Friendlist.lua. Take these files and copy them to a location where they are safe.

In case of anything going wrong (e.g. WoW deleting your settings) you can simply copy the backup files back into this directory.

Usage

My goal is to make flagRSP as easy to use as possible. Most features are self-explanatory. However, there is still no configuration GUI available. Therefore you need command line options to configure some parts of flagRSP.

The command line options of flagRSP can be accessed by entering "/rsp" respectively "/fl" on your chat prompt. Here is an overview of the available command line options.

Download locations

Discussion forums

Feel free to contact me (the developer) via e-mail if you have questions, bug reports, criticism, suggestions or anything else concerning flagRSP. You can find my address above.

/rsp ?	Display help.
/rsp toggle	(De)Activates roleplayer flag.
/rsp names	Toggle hiding of unknown names.
/rsp level	Toggle alternative level display.
/rsp guilds	Toggle display of guild names.
/rsp ranks	Toggle display of PvP ranks.
/rspon	Activate normal roleplayer flag and alternative name and level display.
/rspoff	Deactivate roleplayer flag, alternative name and level display and deletes surname and title.
/rsp collect	Stop flagRSP from detecting AFK to be able to collect flags and descriptions (e.g. of the other faction).
/rsp purgeinterval	Set the duration how long flagRSP saves cached flags and descriptions (in days, default is 14 days).
/rsp standby	Make flagRSP leave the data channel (e.g. for performance reasons).
/fl import	Import WoW's friend list to your Friendlist.
/fl export	Export your Friendlist to WoW's friend list.
/rsp status	Show overview of options for current player.
/rsp owntooltip	Toggle display of tooltip for yourself.
/rsp toggletooltip	Toggle flagRSP's tooltip modifications. With this option you can stop flagRSP from manipulating the tooltip or activate the light mode.
/rsp stat	Show some usage statistics.
/rsp afk	Sets you to afk-mode and stops sending of own flags (which would interrupt normal afk).
/fl help	Show help.
/fl show	Show Friendlist frame.
/fl hide	Hide Friendlist frame.
/fl mm [an/aus]	Displays the button at the minimap (an) or not (aus).
/fl buttonpos [ANGLE]	Sets position of minimap buttons to [ANGLE] with 0<= [ANGLE] <=360.
/fl add [NAME] [SURNAME]	Add player/object [NAME] with surname [SURNAME] to Friendlist.
/fl addguild [NAME]	Add guild [NAME] to Friendlist.
/fl del [NAME]	Delete player/object/guild [NAME] from Friendlist.
/fl reset	Delete complete Friendlist WITHOUT ANY FURTHER WARNING.
/add [NAME] [SURNAME] [NOTE]	Add player [NAME] with [SURNAME] and [NOTE] to Friendlist.

flagRSP documenation