BindControl

Find the latest release of BindControl on its releases page.

About BindControl

BindControl is a helper app for creating and maintaining keybinds and popmenus for City of Heroes.

It began as a direct port of Konoko and Monorail's CityBinder 0.76, using Python and the WxWidgets UI toolkit. It has since come into its own, adding many original features, UI improvements, and quality-of-life upgrades.

During City of Heroes' original run, CityBinder was the go-to app for keybinds. It's written in lua, using the IUP toolkit, and the required versions of those can be difficult to set up for development on modern OSes. I wanted to add features and clean up the UI, so in a stunningly unwise act of hubris, I instead started work on BindControl.

I worked on it on-and-off for the remainder of the original run of City of Heroes, then shelved it, ostensibly forever, when NCSoft shut down the game. Then, of course, everything changed, the game lives again, and BindControl has a reason to exist.

BindControl is and has been developed on Homecoming, and best supports that. Recently, beta support for Rebirth has been added, supporting the Guardian archetype, new powersets, the Genesis Incarnate slot, and more. This support is solid but is a work in progress -- Rebirth players, check it out and file issues as you find bugs!

Features

• Runs on Windows, MacOS, and Linux

• Separate profiles for different characters, archetypes, or situations

• Supports Homecoming and Rebirth servers

• Controller support

• Basic Gameplay Binds

  • Chat binds with optional 'typing' notifier
  • One-key next-teammate / previous-teammate selection, with support for setting team size and optionally skipping the player in the next/previous rotation
  • Rebind the keys for the in-game power tray buttons
  • Many helpful binds directly supported - "Quit to Desktop," "Assist Target," "Show Coordinates," "Toggle Roleplaying Status," many many more

• Custom Binds

  • Simple Binds, multiple slash commands bound to a single keypress
  • Complex Binds, essentially series of Simple Binds that execute in rotation with repeated presses of a single key
  • Buffer Binds, quick one-key selection and buffing for each teammate and/or pet
  • "Bind Wizards" - simple processes guiding you through creating elaborate or complicated bind schemes that would be difficult and/or fiddly to create and maintain by hand
  • PowerBinder is a flexible tool offering an easy way to assemble and maintain possibly-complicated configurations of slash commands, and is used in Simple, Complex, and Buffer Binds

• Movement / Speed-on-Demand

  • Speed-on-Demand keybinds based on CityBinder and the original Gnarly's SoD keybinds, with many clarifications and improvements
  • Updates to Speed-on-Demand to accommodate the various travel power changes introduced by Homecoming
  • Simple Power Toggle keybinds that can activate individual travel powers or toggle between related powers like Fly and Hover
  • Support for all formal travel powers: Fly, Mystic Flight, Group Fly, Super Jump, Mighty Leap, Super Speed, Speed of Sound, Teleport, and Team Teleport
  • Secondary / server tray travel powers like Super Jump's "Double Jump" and Mystic Flight's "Translocation" integrated
  • With Homecoming profiles, powexec_location cursor used for Teleport binds, with "teleport immediately" and "teleport on key release" options available
  • Kheldian form toggles with power tray changing; Kheldian movement powers incorporated into Speed-on-Demand and Power Toggle
  • Simple Temporary Travel Power toggle keybind
  • One-key reset in case SoD binds get tangled up

• Inspiration Popper

  • By-type; dual and team inspirations supported
  • Option to use or skip "super" inspirations
  • Largest-first or smallest-first
  • Optional /say feedback with per-inspiration-type custom colors

• Mastermind / Pet Binds

  • Features to help name pets uniquely, required for most of BindControl's Mastermind bind styles
    • BindControl will detect and warn if names are inadequately different / unique for by-name use
    • BindControl can create a keybind to rename your pets to match BindControl's config instead of doing it manually in-game
  • By-name pet selection - requires uniquely-named pets
  • Support for multiple alternate Mastermind binds styles:
    • Classic "Sandolphan" binds:
      • Select pets by power level: all, minions, lieutenants, and boss
      • Select next-pet / previous-pet binds for quick buffing etc
      • Orders for aggressive / defensive / passive stances; attack, follow, go to, and stay, for all or selected pets
      • Pets can give feedback on each order; chattiness can be toggled via keybind
      • "Bodyguard mode" shortcut -- you can define which pets should be treated as bodyguards, and turn Bodyguard Mode on for them with a single keypress - requires uniquely-named pets
    • qwy's Numpad Controls:
      • Simple but comprehensive scheme using the number pad and modifier keys to select, control, heal, and buff pets
      • Mod keys select Defensive, Aggressive, Passive versions of the same commands
      • Select individual pets or by power level
      • Follow, Go To, Attack, Stay commands
      • One-key upgrade bind, applying both possible upgrades on key press and release
      • Heal targeted pet
      • Cycle target through all pets or per power level
    • qwy's PetMouse Controls:
      • Mouse-centric keybind scheme that uses mod keys with the mouse to give orders to pets individually or by power level
      • Alt+Click (by default) will command current pet to "go to" the click location and will target the next pet for orders, making it trivial to send each of your pets to a precise location with a minimum of interaction
      • Most key commands available from the WASD "home" position by default
      • Optional popmenu allowing more detailed commands using just a few home position keystrokes
      • Numpad commands to select all pets or by-power
      • Mouse controls can cover 90% of moment-to-moment interactions with henchmen, while the popmenu covers all other needed functionality

• Popmenu Editor (beta)

  • Create, install, edit, and delete popmenus in the game folder
    • Requires telling BindControl where the game is installed
    • BindControl can create the necessary folders in the game install folder for popmenus
  • Easy GUI editing and testing of popmenus
  • Generate macros to make popmenu buttons in-game

TODO

• It's gotten a lot better, but there are still some Homecoming-specific notions hard-coded into BindControl. I'm working on finding and fixing these, but any bug reports and other feedback from Rebirth players would be very welcomed.
• The hope is to make every reasonable slash command in the game available in some way, typically via PowerBinder. What qualifies as a "reasonable slash command" is yet to be determined. Check the SlashCommands.md file for the current status.
• Access to MacOS for testing is via a MacOS VM several OS versions old. I don't want to buy an actual Mac just for this wee vanity project, so mileage may vary on how it acts in an actual recent Mac environment.
• The popmenu editor, on Windows, simply can't load pathologically large popmenus (tens of thousands of entries). This is a hard limit on the wx toolkit imposed by Windows itself, and can't be worked around in any way I can see. As there exist at least two menus this large "in the wild," further investigation is merited.
• It might be nice to find a way to add icons to the popmenu editor macro creator, but it would involve either shipping every icon in the game with BindControl or creating a browsable view of some external site like City of Data to pick from the icons.
• More error detection and handling.
• More and better help text and documentation. (WIP - check the wiki)
• More internal work on initialization order of objects to speed up start time and avoid bootstrapping problems. (WIP)
• Fix bugs as found.

Using Binary Releases

Binary releases of Python applications are a bit finicky and fragile, but are provided on the latest release page. Feel free to try them, but if you have any trouble, skip down to Running From Source below for an alternative, very deterministic, way of running BindControl. Any feedback on your experience with the binary releases is welcome and encouraged.

Windows users: Try the ZIP file. If that works for you, it's the quickest path to victory. If you receive malware warnings when downloading, please read my comments on that issue.

MacOS users: Experimental binary releases for Intel and Arm64 have been made available. They are not signed and/or notarized, and might or might not work at all. Any feedback from MacOS users is welcome and appreciated.

Linux users: An experimental binary release is now available. You should be able to unzip the zipfile anywhere, and run the "BindControl" binary from within it. It's built using Github's "ubuntu-22.04" environment, which may or may not be completely compatible with other distributions and versions.¹

Running From Source

Step 1 - Dependencies

1. Python version 3.13 or later
2. wxPython version 4.2.2 or later

Windows users: follow the instructions on the above sites' download pages to install Python and wxPython.

MacOS users:

• Pre-Catalina: I recommend following the instructions in this article at opensource.com to get Python 3 installed and working as the default Python. Once Python 3 is working, you will want to run pip3 install wxPython.
• Catalina and later: follow the instructions on the above sites' download pages to install Python and wxPython.

Linux users: install your distribution's packages for Python 3 and wxPython.

Step 2 - Getting and running the code

• Clone this repo, or download the source as a ZIP file and unzip it somewhere².

• Double-click BindControl.py in the top-level folder in your explorer / file manager / Finder / etc. This should work if you have Python correctly installed.

• Alternatively: In a terminal, cd into the bindcontrol directory, then:

  • Windows: py BindControl.py
  • Linux: ./BindControl.py
  • MacOS: python3 BindControl.py

Developing BindControl

BindControl is being developed on Manjaro Linux. It gets feature-tested on a Windows 10 VM. When Windows 10 goes EOL, I'll probably update to a Windows 11 VM, but that's its own headache.

While developing, I make sure the code passes both pyright and ruff with a large subset of the possible rules included.

There is a small but growing pytest test suite. It only runs on Linux (and possibly MacOS) because it uses pytest-forked which is not supported on Windows. To run the test suite, you'll need to install the following plugins and their dependencies:

• pytest-forked
• pytest-xdist
• pytest-ruff
• pytest-cov

I make liberal use of typing in parameters, attributes, and return values, and continue to add this into new and existing code as I go. This has proven to be a bit of a hassle since BindControl was originally a direct port of CityBinder, and inherited many of its original questionable design decisions, as well as having introduced any number of its own over the years. Enforcing more strict typing is an ongoing process, but has resulted in cleaner and better code, as well as having surfaced any number of potential and actual bugs.

Any submitted patches or pull requests should pass the test suite and pyright at the very least. Adding new tests is encouraged.

Credits

BindControl was originally a direct port of CityBinder code, and in many places is still extremely influenced by it. Keybinding code drew from similar code in PADRE.

Various newer functionality was initially added to CityBinder for Homecoming by Tailcoat, who kindly provided his source code and permission to adapt for use with BindControl, as well as offered suggestions and advice for improvements. The Inspiration Popper in particular was incorporated wholesale from a design of Tailcoat's in an unreleased version of CityBinder for Homecoming.

The CoH/CoV Technical Reference Guide from Shenanigunner has been, and continues to be, a crucial resource and is highly recommended for those wishing to dig deeper into keybinds, popmenus, and macros.

The Sandolphan Mastermind bind schemes were originally developed by Sandolphan during the City of Villains beta in 2006 and posted to the official forums at that time. The version in BindControl is an adaptation and expansion of the original binds.

The qwy Mastermind bind schemes are adapted from qwy's posts on the Homecoming forums^{3 4}, and are used with their gracious permission.

The Github Actions for automated building of binary releases were provided by JamzTheMan.

Additional feedback and suggestions have been provided in the Homecoming Forums thread and in Github issues by:
DevoDog68, BlackSpectre, Premmy, kenlon, Lumenia, xizar, autobotpinto, jtoya85

Icons / graphics are from Microsoft's Fluent icons collection, by way of Colton Griffith's Fluent Icons viewer.

CityBinder's original acknowledgements are reproduced below:

    Obviously, without Cryptic and NCSoft to have created/funded/published
    City of Heroes and City of Villains, there would be no point to this
    program.  Thanks to Gnarly and the numerous people who contributed to the
    creation of the Speed on Demand System.  Thanks to Sandolphan/Khaiba and
    the many people who posted Mastermind binds in the CoV Beta forums.
    Again thanks to Sandolphan for the Bodyguard mode binds.  Also thanks
    to the following people, who directly contributed to CityBinder, either
    with bug reports, feature suggestions, or contirbuted binds.
    PerezPersuader, Blue_Daze, Back_Blast, IronVulture, Darkelven,
    Shadowhand, Knight_Marshal, Nilt_, Psygon, DuskA, CyberKnight7, ErieFF,
    Darc_Reign, Beerninja, BarfBag, Oronis, TrystarMojo, Pyrobard,
    Ang_Rui_Shen, Konoko, Draznar, Local_Man, tyrose, Caustic, 80sboi,
    DarknessEternal, reiella, Robotech_Master, Ground_Zeroo, Stylina, and
    ShieldBearer.

License

BindControl is licensed under the GPL version 3 or later.

[email protected]

Footnotes

1. For instance, I run Manjaro, and have to install "libtiff5" from AUR to make the binary release work. ↩

2. If you are familiar at all with git or github, cloning the repo is the recommended action here -- this makes it easier and quicker to get new changes when they arrive, as well as allows access to incremental between-release changes and experimental branches. ↩

3. i26 Expanded Mastermind NumPad Controls+ ↩

4. i26 The Mastermind's PetMouse ↩