VOLUNTEER TRANSLATORS WANTED!
See below for more information.
"This is the best mod ever made."
- Boffyerrocker420, a person that I do not know and is definitely not me in a groucho marx mustache
QuickChat
(and Communication Wheel and Custom Waypoints)
Note: No relation to "PD2QC: Payday 2 Quickchat Mod" by sl0nderman and Fooksie.
This mod adds two main features using a Radial Menu interface:
- A contextual Ping Menu, similar to the one featured in Left 4 Dead, Portal 2, or Apex Legends. Use it to communicate a location or an object to your teammates, or make a visual bookmark for yourself in solo runs!
- A quick-chat menu which can quickly send preformatted chat messages, play voice lines, and/or play arm animations.
These actions can be bound to custom buttons on controllers or mouse and keyboard.
(Yes, you heard that right! Custom button binding for controllers!)
(VR support is not tested.)
Current Features and Planned Features
Waypoints and Pinging
-
QuickChat can be used to create location markers, aka "waypoints" or "pings", visible on the HUD.
-
Only players who have this mod (or Goonmod's Custom Waypoints) will be able to see players' waypoints.
-
Locations, enemies, and civilians can all be pinged.
Voicelines, Gestures, and Chat Messages
-
QuickChat can also trigger player voicelines, gestures (such as the "point" animation when marking an enemy, or the "get up" animation from Inspire Aced), or send either preconfigured chat messages or custom chat messages of your choosing.
-
Preconfigured chat messages, or "message presets", are pre-translated strings in certain supported languages. When these preset messages are sent to other clients who have QuickChat installed, and the message will appear to that player in their chosen language.
-
QuickChat comes with three communication wheels and one ping wheel by default, which can be bound to separate keys in the
QuickChat -> Edit Binds
submenu.
Please see the "Wiki, Repo, and More Information" section below for instructions on how to configure custom radial menus.
Planned Features
- Preview/edit/customization interface for Radial Menus in options menu
- Ping vanilla waypoints to "highlight" them as a reminder to other teammates
- Modifier keys to go through glass or other transparent blockers, add timers, or other such features
- Hold/press/doublepress options for keybinds
- Add spotlight to ping location
- Allow pinging Bot Teammates
- Preview current gamepad layout and available buttons in Edit Binds menu
- Pre-translated chat shortcuts for existing game item names such as weapons, achievements, skills, characters, perk decks, etc.
- Show icons for pre-translated chat messages (so that you can tell the message is auto-translated)
Installation Instructions
Instructions
Please find the installation instructions in the Dependencies & Instructions section of the mod page.
You need SuperBLT to use this mod.
Install this into the mods/
folder.
BeardLib is recommended, but not required.
You do not need to install RadialMouseMenu- it won't affect QuickChat, since QuickChat comes with a special version of RadialMouseMenu.
Supported Languages and Translations
List of supported languages and translator credits
Supported Languages:
- Literally just English right now, sorry.
Translators:
- Nobody :(
If you're interested in volunteering to translate this mod, please contact me!
Sign-up application: (via Google Forms)
Here is the translation sheet, if you want to take a look here: (via Google Sheets)
FAQ, Troubleshooting, and Known Issues
FAQ
How/where do I install this mod? Which mods do I need to use QuickChat?
- Please read the Installation Instructions section above!
Does this mark me as a cheater?
- No.
Can unmodded-players or players without QuickChat see my waypoints?
- No, it's not possible to sync your waypoints to other players unless they have QuickChat or Goonmod's Custom Waypoints.
Can I use Goonmod's Custom Waypoints and QuickChat at the same time?
- Yes!
Can other players see my chat messages and arm gestures, and hear my voice lines?
- Yes!
How does the chat translation work?
- The preset messages are common words and phrases that have already been translated into multiple languages in the mod's files. When you send a preset message to another player using QuickChat, the mod actually sends a localization code that corresponds to the preset message, instead of the chat message itself, and the player on the other end sees the preset message corresponding to their language instead of yours. There is no "live" translation going on; use
How do I bind buttons in this mod? It doesn't show up in the mod keybinds menu!
- Because I wanted to add support for binding controller buttons, I needed to write my own custom button binding and input code- PAYDAY 2 and SuperBLT do not come with support custom binds for controller buttons. For this reason, binds need to be set in the
Mod Options -> QuickChat -> Edit Binds
menu.
There's no Mod Options menu!
- QuickChat isn't causing this problem. You need to go through your mods list to find out which one is causing it. Or, you might have installed QuickChat incorrectly.
I crashed or encountered some other type of issue! What do I do?
- Sorry about that! Please report it to me here or on GitHub with a description of the issue and (if applicable) the crash file (specifically the one at
AppData/Local/PAYDAY 2/
). You can upload it on a site like Pastebin or GitHub Gist. Please don't use Google Drive to share this log unless you're very tech-literate, have no other options, and/or are very, very confident that you are smart enough to configure the permissions correctly for me to see the file.
Known Issues / Troubleshooting
- QuickChat may detect a controller if it is plugged in, even if it is not the main control device being used for PAYDAY 2. If you encounter issues with binding keys, please unplug your controller and relaunch the game.
- Rebinding buttons while in a heist seems to rarely and inconsistently use the wrong button names, causing the binding to fail. Please report this to me if you encounter this issue; include the type of controller or input device you were using (eg. Xbox controller, Steam controller, or Keyboard+Mouse), which button(s) you were attempting to bind, and the game state (eg. whether you were in the main menu, the pregame lobby, the preplanning lobby, or mid-heist).
- It's not currently possible to move while using a Radial Menu, due to how the menu is implemented to capture mouse input. This is planned in a future update.
- When pinging SWAT Turrets, the waypoint will center on the base of the turret rather than the camera lens/gun. A fix is planned in a future update.
- When sending waypoints to Goonmod's Custom Waypoints, some minor desync may occur in waypoint positions- see the "Mod Compatibility" section for a more complete description of this issue.
- When you are pinged by another player, the waypoint on your character may appear in an unexpected area of your screen.
- In extreme cases of general network desynchronization such as extended slow-motion, packet loss, or other connection issues may cause the timers of Timed waypoints to be inaccurate between two players.
Wiki, Repo, and More Information
Click to expand
QuickChat's code repository can be found here:
https://github.com/offyerrocker/PD2-QuickChat
The wiki contains information about creating your own radial menu, such as which waypoint icons and message presets are available.
It is hosted separately, on GitBook:
https://rocketburd.gitbook.io/quickchat-documentation-home
(Note: The documentation/wiki is still under construction- sorry for the inconvenience!)
Mod Compatibility
Click to expand
QuickChat should be compatible with all HUD mods. If you think you've found a compatibility issue with another mod, please contact me.
Networking compatibility with teammates using TdlQ's Goonmod's Custom Waypoints is limited. GCW only supports unit waypoints for interactables, while QuickChat supports pinging both interactable and non-interactable units (such as enemies). Therefore, pinging such a unit will cause a GCW user to see a static position waypoint frozen where you first pinged the unit, instead of the waypoint following the unit (which only QuickChat users would see).
Feedback
Please leave bug reports, feature requests, questions, and/or comments in the comments section below!
Alternatively, if you're comfortable doing so, you can use the Issues tracker on the GitHub repo to make bug reports, feature requests.
