[v1.1] Extended Compass
Posted: 12 Aug 2011, 03:15Extended Compass Version 1.1
-- Extend the usage of Red Eclipse's Compasses, and much more!
Made FOR the Community, BY the Community!
Special Thanks to my Girlfriend for the logo <3 ^_^
Authors/Contributors:
See "Credits" in README.txt for Credits, Thanks, and Acknowledgements
Download:
Download Latest Version of Extended Compass
Latest Modded Source Files (for compiling SVN)
All Versions
*** Chat Color Hotfix ***
Instructions:
All Set!
What is Extended Compass?
Extended Compass is a mod that aims to extend the usefulness of the Red Eclipse Compass feature by giving you an unlimited amount of these compasses to use at your dispersal, which can give you anything from a set of frequently used Talk Binds or sets of commands, change your name on the fly, and just about anything you can do in the console, really! The possibilities are quite expansive, and are for the most part, only limited by your imagination and creativity.
The major convenience of using these compasses is that for one, they are built right into Red Eclipse. For two, they can allow you to do such things as create navigable menus that lead to aforementioned sets of Talk Binds or command sets, or even lead to another compass! For three, due to the way the Red Eclipse Compasses work, all it takes is some combo memorization, and you could access a certain list of commands from within several different "menus" in seconds! This is because all items on the compass are selectable by keystroke, which you can even assign when you create the compass. I've barely scratched the surface of possibilities, if you can believe that. Be creative!
To open the Extended Compass Menu, either click the newly added "Extended Compass" option in the Main Menu, or press the key you set your
"ECMenuKey" to :)
Screenshots:
http://min.us/mDlYTW5Go
Features
Main Menu Compass:
By default, you use Extended Compass by evoking the "EC Main" compass with a key dubbed the "ECKey", which is a key you will set at first launch. Upon pressing this key, the EC Main compass will show up, currently with 4 options: "Team-Game", "Talk", "Names", and "Admin". Think of this as the root menu of Extended Compass, as those options all show it's respective compass, which will be described momentarily.
For those of you that play or have played Tremulous, you may be familiar with this style of binding and creating pseudo menus ;D The premise of Extended Compass is actually based of this idea, as I used to play Tremulous myself ;)
The Primary Compasses:
Currently, the root of, and original idea and feature of Extended Compass is it's special set of "Team-Game Compasses". What these hold, are color coded talk phrases that you would find useful for quick communication with your team mates in a Team-Game. These include phrases like: "Cover Me!", "Stay in Groups!", "Recover the Flag!", "Defend our Base!", etc. etc.
Now, here's what makes this feature so special. The Team-Game Compass is actually only an option in the EC Main compass. When chosen, a Team-Game compass that matches the current GameMode will appear! For convenience, the key to select this option is set to the ECKey, giving you access to the Team-Game Compass with a quick double-tap. Currently, there are 4 Team-Game compasses: TDM/Survior, Capture the Flag, Defend the Flag, and Bomber-Ball.
Extended Compass comes with pre-made, default phrases for each aforementioned GameMode's talk binds, but you can of course change these by editing ExtendedCompass.cfg to your liking.
The Talk compass is used for very general, commonly used phrases like: Hello and Goodbye, Good Game, Press F3 to Vote, etc. By default, the Talk compass comes with only a few phrases, leaving you free to add some yourself, also by editing ExtendedCompass.cfg.
The Names Compass is used to quickly change your name. What's the reason for this? Well, some players, when they go AFK, like to add "|AFK" as a suffix to their name to denote that they are AFK. Some people just have multiple aliases, and even still, some like to just tack on a random state to their name to denote a current style or mood. Ex: "relaxing damien /FROGTEAM", "drunk master /FROGTEAM", "ZeroKnight|FAILING", etc. etc.
For those that are Server Admins/Owners may enjoy the Admin compass quite a bit. At it's root, it has admin commands that are very useful to have as quick as possible, like banning or kicking players, setting MasterMode, etc. The last two options open two different compasses; one for Weapon Permissions, the other for Bot Commands.
What makes the Admin compass shine is the use of the "inputcommand" command. Selecting a certain admin command in the compass will not execute anything, but instead will open the console with that command already typed out, with a space even! So all you have to do is type the value and hit enter.
Keeps things fluid, speedy, and convenient to use for the busy server admins :)
In-Game Config Editing:
A prominent feature of Extended Compass is the ability to edit all related files IN-GAME! Madness, you say! Well, wrong! Red Eclipse has a built-in Text-Editor, that Extended Compass makes use of. (Did you pick up on the trend of using RE's own stuff yet? ;P) With it, you can edit ExtendedCompass.cfg, and even your autoexec file! Just a little bit of extra convenience~
What this feature is mostly good for, however, is to create CUSTOM COMPASSES! That's right. "ECcComp.cfg" is dedicated to storing all user-made compasses. You can make as many compasses as you want, exactly how you want them! Bind them to whatever, have them do whatever, it's up to you! The separate file also makes for very nice organization ^_^
Player Voice Linked Phrases:
Extended Compass also extends the functionality of the player voice (argh.ogg, thanks.ogg, etc.) on their respective chat messages. By adding entries in ExtendedCompass.cfg, player voice can be linked to your own custom phrases! *see the defaults in ExtendedCompass.cfg* There is a caveat, however. Only players with the same exact entries will hear the voice as well, and any custom voice sounds that another player wont have will also not work.
This is due to how the player voice works in Red Eclipse itself, and is not something I can alter, unfortunately.
Color Chat:
Yet another lovely feature of Extended Compass is the integration and improvement of Kitsune's Color Chat script. There are 20 color presets you can choose from, and even the option to define your own color using Hexadecimal color codes! You can set a separate color for Regular Chat, Team Chat, /ME Messages, and even /ME Team Messages! A limitation in the original script was that manual editing of the CFG was necessary to remember your favorite colors. This is no longer the case! All you have to do is set your color, and it will be remembered, as it is stored in a file called "ecdata.cfg". Awesome!
** As an added bonus, the colors you chose for Regular and Team Chat will also be used for the vanilla Red Eclipse Voice and Team compasses!
Finally, there are other various changes to the Look 'N' Feel of things, such as adding a "Welcome, <playername>!" banner at the top of the Main Menu, and capitalizing the Main Menu options, for better aesthetic appeal. (IMO)
Version History:
Lastly, I hope you enjoy this little mod! If you have any suggestions, please post them! I'd love to hear suggestions and ideas. This is made for the community, after all ;) If you have any troubles or encounter any bugs, by all means post about it here in the thread, or email me. Cheers!
~ZeroKnight
-- Extend the usage of Red Eclipse's Compasses, and much more!
Made FOR the Community, BY the Community!
Special Thanks to my Girlfriend for the logo <3 ^_^
Authors/Contributors:
See "Credits" in README.txt for Credits, Thanks, and Acknowledgements
- Alex "ZeroKnight" George -- Creator and Main Author
- HTN-Kitsune
- fluxord
- Quinton "qreeves" Reeves
Download:
Download Latest Version of Extended Compass
Latest Modded Source Files (for compiling SVN)
All Versions
*** Chat Color Hotfix ***
Extended Compass [v1.1]_COLORHOTFIX.7z- Contains a fixed version of "ExtendedCompass.cfg" and "ChatColors.gui".
Just replace what you have. - (4 KiB) Downloaded 336 times
Instructions:
- Move the "scripts" dir to the Red Eclipse HOME directory. (Extended Compass resides in a "scripts" dir, because this way you can keep your various CFGs and scripts more organized. However, if you don't like it, you can always modify the source (engine/server.cpp -- Line 1471), ExtendedCompass.cfg (the execs), and ExtendedCompass.gui (the end of the file, where the editor parts are) Home Dir Locations:
- Windows: %USERPROFILE%\Documents\My Games\Red Eclipse
- Linux: $HOME/.redeclipse
- Mac: typically /Users/<name>/Application Support/redeclipse
- If already using Kitsune's Color Chat script, remove it. It is included in the download and is modified to work with Extended Compass.
- Inside the Red Eclipse install directory, inside the "data" dir, backup "menus.cfg" and "voices.cfg". (Just add .bak to the end of the filename) Move the modded versions of these files in the "Modded Files" dir in the download package to this directory.
- Add "exec scripts/ExtendedCompass/ExtendedCompass.cfg" to your autoexec file.
- *FOR PRE v1.0 USERS* Remove "alias ECKey <key>" from your autoexec file. The source edit now handles saving of your ECKey.
- To complete the modding process, backup the existing RE client: "bin/reclient.exe", and replace it with the reclient.exe in the download package.
- OR, replace the source files with those included in "Modded Files/Supernova/src", if you wish to compile RE yourself.
- If using SVN, be sure to use ALL files in the SVN folder. Do not mix with Supernova files and be sure to remove the .r* extension, obviously. Please note that the include source files are only current as of the package release! There may be updates to the particular modded files, so be sure to check SVN yourself and apply the changes!
To aide users a bit, I try to stay current with the SVN releases, and if there is any new version of the modded file, I will mod and upload them. * See link in Download Section*
-- Remember, I MAY not have the most current revised files, so ALWAYS be sure to check revision numbers!!
All Set!
What is Extended Compass?
Extended Compass is a mod that aims to extend the usefulness of the Red Eclipse Compass feature by giving you an unlimited amount of these compasses to use at your dispersal, which can give you anything from a set of frequently used Talk Binds or sets of commands, change your name on the fly, and just about anything you can do in the console, really! The possibilities are quite expansive, and are for the most part, only limited by your imagination and creativity.
The major convenience of using these compasses is that for one, they are built right into Red Eclipse. For two, they can allow you to do such things as create navigable menus that lead to aforementioned sets of Talk Binds or command sets, or even lead to another compass! For three, due to the way the Red Eclipse Compasses work, all it takes is some combo memorization, and you could access a certain list of commands from within several different "menus" in seconds! This is because all items on the compass are selectable by keystroke, which you can even assign when you create the compass. I've barely scratched the surface of possibilities, if you can believe that. Be creative!
To open the Extended Compass Menu, either click the newly added "Extended Compass" option in the Main Menu, or press the key you set your
"ECMenuKey" to :)
Screenshots:
http://min.us/mDlYTW5Go
Features
Main Menu Compass:
By default, you use Extended Compass by evoking the "EC Main" compass with a key dubbed the "ECKey", which is a key you will set at first launch. Upon pressing this key, the EC Main compass will show up, currently with 4 options: "Team-Game", "Talk", "Names", and "Admin". Think of this as the root menu of Extended Compass, as those options all show it's respective compass, which will be described momentarily.
For those of you that play or have played Tremulous, you may be familiar with this style of binding and creating pseudo menus ;D The premise of Extended Compass is actually based of this idea, as I used to play Tremulous myself ;)
The Primary Compasses:
Currently, the root of, and original idea and feature of Extended Compass is it's special set of "Team-Game Compasses". What these hold, are color coded talk phrases that you would find useful for quick communication with your team mates in a Team-Game. These include phrases like: "Cover Me!", "Stay in Groups!", "Recover the Flag!", "Defend our Base!", etc. etc.
Now, here's what makes this feature so special. The Team-Game Compass is actually only an option in the EC Main compass. When chosen, a Team-Game compass that matches the current GameMode will appear! For convenience, the key to select this option is set to the ECKey, giving you access to the Team-Game Compass with a quick double-tap. Currently, there are 4 Team-Game compasses: TDM/Survior, Capture the Flag, Defend the Flag, and Bomber-Ball.
Extended Compass comes with pre-made, default phrases for each aforementioned GameMode's talk binds, but you can of course change these by editing ExtendedCompass.cfg to your liking.
The Talk compass is used for very general, commonly used phrases like: Hello and Goodbye, Good Game, Press F3 to Vote, etc. By default, the Talk compass comes with only a few phrases, leaving you free to add some yourself, also by editing ExtendedCompass.cfg.
The Names Compass is used to quickly change your name. What's the reason for this? Well, some players, when they go AFK, like to add "|AFK" as a suffix to their name to denote that they are AFK. Some people just have multiple aliases, and even still, some like to just tack on a random state to their name to denote a current style or mood. Ex: "relaxing damien /FROGTEAM", "drunk master /FROGTEAM", "ZeroKnight|FAILING", etc. etc.
For those that are Server Admins/Owners may enjoy the Admin compass quite a bit. At it's root, it has admin commands that are very useful to have as quick as possible, like banning or kicking players, setting MasterMode, etc. The last two options open two different compasses; one for Weapon Permissions, the other for Bot Commands.
What makes the Admin compass shine is the use of the "inputcommand" command. Selecting a certain admin command in the compass will not execute anything, but instead will open the console with that command already typed out, with a space even! So all you have to do is type the value and hit enter.
Keeps things fluid, speedy, and convenient to use for the busy server admins :)
In-Game Config Editing:
A prominent feature of Extended Compass is the ability to edit all related files IN-GAME! Madness, you say! Well, wrong! Red Eclipse has a built-in Text-Editor, that Extended Compass makes use of. (Did you pick up on the trend of using RE's own stuff yet? ;P) With it, you can edit ExtendedCompass.cfg, and even your autoexec file! Just a little bit of extra convenience~
What this feature is mostly good for, however, is to create CUSTOM COMPASSES! That's right. "ECcComp.cfg" is dedicated to storing all user-made compasses. You can make as many compasses as you want, exactly how you want them! Bind them to whatever, have them do whatever, it's up to you! The separate file also makes for very nice organization ^_^
Player Voice Linked Phrases:
Extended Compass also extends the functionality of the player voice (argh.ogg, thanks.ogg, etc.) on their respective chat messages. By adding entries in ExtendedCompass.cfg, player voice can be linked to your own custom phrases! *see the defaults in ExtendedCompass.cfg* There is a caveat, however. Only players with the same exact entries will hear the voice as well, and any custom voice sounds that another player wont have will also not work.
This is due to how the player voice works in Red Eclipse itself, and is not something I can alter, unfortunately.
Color Chat:
Yet another lovely feature of Extended Compass is the integration and improvement of Kitsune's Color Chat script. There are 20 color presets you can choose from, and even the option to define your own color using Hexadecimal color codes! You can set a separate color for Regular Chat, Team Chat, /ME Messages, and even /ME Team Messages! A limitation in the original script was that manual editing of the CFG was necessary to remember your favorite colors. This is no longer the case! All you have to do is set your color, and it will be remembered, as it is stored in a file called "ecdata.cfg". Awesome!
** As an added bonus, the colors you chose for Regular and Team Chat will also be used for the vanilla Red Eclipse Voice and Team compasses!
Finally, there are other various changes to the Look 'N' Feel of things, such as adding a "Welcome, <playername>!" banner at the top of the Main Menu, and capitalizing the Main Menu options, for better aesthetic appeal. (IMO)
Version History:
- Version 1.1 -- September 26th, 2011
- Changed format of Download Package. *see updated instructions*
- Added "Pass the Bomb!" phrase to the Bomber-Ball compass. (Mainly inspired by Wazu's Basket B-Ball ;D)
- Added TDM/Survivor Compass
- Extended Compass Menu now has the Extended Compass logo
- New icons for most of the Primary Compasses
- Improved the Color Chat script!
- Now has 20 Color Presets
- Now has the option to specify your own Custom Color using Hexadecimal codes!
- Color settings are remembered automatically. No need to manually edit ChatColors.gui anymore!
- Changes to the Main Menu:
- Added "Extended Compass" option in Main Menu. Also capitalized the other options, to be aesthetically pleasing
- Added a nice little "Welcome, <name>!" banner at the top
- Credits added to ReadMe
- Version 1.0.2 -- September 11th, 2011
- Extra Bugfixes
- Re-enabled the editors
- To make this work, the Extended Compass dir have changed. *see updated instructions*. Be sure to delete what's in the Red Eclipse data folder afterward! Not doing so will cause random conflicts!
- Added notice in EC Setup to clear confusion
- Version 1.0.0.1 -- September 11th, 2011
- Embarrassing Bugfixes
- Temporarily disabled Edit CFG and Custom Compasses due to bug with RE's editor. (edit the files outside of RE)
- Version 1.0 -- September 11th, 2011
- Finally 1.0! Many changes and additions.
- Contains a minor source edit. (Now officially a mod!)
- Adds a new command "writeecdata", which writes to a file named "ecdata.cfg". This stores your ECKey, SO YOU NO LONGER NEED IT IN YOUR AUTOEXEC. Stores ECKey stlye setting. Will also store other various data in future updates.
- writeecdata on quit
- Now has a GUI
- Can set your ECKey, and pick from 2 ways to use the EC compasses
- Menu Style:
- Pressing the ECKey will bring up a "Main Menu" compass, where pressing it again will show the Team-Game Compass
- The rest are numerical, which bring up the "Talk", "Names", and "Admin" compasses respectively.
- Individual Style:
- Pressing the ECKey will only bring up the Team-Game compass
- Z, X, and C bring up the "Names", "Talk", and "Admin" compasses respectively.
- Can edit ExtendedCompass.cfg, autoexec.cfg on the fly, inside RE, as well as ECcComp.cfg (see below)
- Button to configure Kitsune's Color Chat Script
- New Compasses!
- "Talk" Compass: Contains a few general phrases like Hello, Goodbye, etc. with room for a few custom ones
- "Names" Compass: Compass for storing different player names for quick changing.
- "Admin" Compass: Contains several useful commands for server admins
- Implementation of Custom Compasses!
- Allows editing of a file called "ECcComp.cfg". Here you can make as many custom compasses as you'd like!
- Vanilla voice compass text is now linked to chat color
- Kitsune's Color Chat script has been integrated
- Instructions updated to cover various things
- Version 0.3a -- August 20th, 2011
- Added player voice support to Compass phrases. (thanks, quin for the update to voices.cfg :D) If you want player voice to play with color text, you will need to play the SVN version ;)
- Recolored a phrase or two. Made some "grouping" related text purple to match the scheme.
- Version 0.2.3a -- August 18th, 2011
- Added "Recover our Flag!" to CTF compass, and "Grab the Bomb!" to BB compass
- Changed the way $ECKey is set. Now needs to be defined in your autoexec file. ** SEE REVISED INSTRUCTIONS **
- Version 0.2.1a -- August 17th, 2011
- Revised the coloring of the phrases. Thanks, fluxord :)
- Version 0.2a -- August 16th, 2011
- Added "$ECKey" alias, the "Extended Compass Key". Your chosen bind can now be easily set by changing the value of this alias, which is at the beginning of the .CFG
- In lieu of this, your "ECKey" will now bring up the compass that corresponds to the current GameMode automatically, instead of having to cycle compasses all the time.
- Misc. Edits
- Added "$ECKey" alias, the "Extended Compass Key". Your chosen bind can now be easily set by changing the value of this alias, which is at the beginning of the .CFG
- Version 0.1a -- August 11th, 2011
Initial Release
Lastly, I hope you enjoy this little mod! If you have any suggestions, please post them! I'd love to hear suggestions and ideas. This is made for the community, after all ;) If you have any troubles or encounter any bugs, by all means post about it here in the thread, or email me. Cheers!
~ZeroKnight
. One minor problem though: it's just a little too 
Keep the 
stuff up!
So you'd even be able to hear voice if you typed in color ;D