https://github.com/meltingscales/potemkeys
Overlay utility to help people playing fighting games with keyboards memorize keymaps.
https://github.com/meltingscales/potemkeys
fighting-game guilty-gear guilty-gear-strive pygame tekken tekken-7 tekken7
Last synced: 16 days ago
JSON representation
Overlay utility to help people playing fighting games with keyboards memorize keymaps.
- Host: GitHub
- URL: https://github.com/meltingscales/potemkeys
- Owner: meltingscales
- License: other
- Created: 2021-12-04T16:02:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T03:23:43.000Z (about 4 years ago)
- Last Synced: 2025-03-09T16:37:35.096Z (about 1 year ago)
- Topics: fighting-game, guilty-gear, guilty-gear-strive, pygame, tekken, tekken-7, tekken7
- Language: Python
- Homepage:
- Size: 16.8 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Potemkeys: Previously "FGfGwK: Fighting Games for Goldfish with Keyboards"
## TL;DR Download!
### [Windows, click here.](https://github.com/HenryFBP/potemkeys/releases/download/latest-windows/potemkeys.exe)
### [Linux, click here.](https://github.com/HenryFBP/potemkeys/releases/download/latest-ubuntu/potemkeys) (must run `sudo apt-get install -y wmctrl`!)
### Old name was FGfGwK
This used to be called "FGfGwK", "Fighting games for Goldfish with Keyboards" (Can't remember button maps).
Name is inspired by Potemkin from Guilty Gear Strive - "potemkeys" (Potemkin from Guilty Gear + "keys")
### PyPI
-
### Using pip
pip install --upgrade potemkeys
python -m potemkeys
[](https://forthebadge.com)
[](https://forthebadge.com)
[](https://forthebadge.com)
[](https://forthebadge.com)
## What is this?
For those who can't remember {keyboard input => controller} mappings, and want to see them in-game.
Created because TEKKEN doesn't show input conversions in multiplayer matches, and neither does Guilty Gear: Strive,
and I wanted to see my inputs, so I wasted 6 hours writing this tool.
Works on Windows 11, and tested on Ubuntu.
## This tool sucks, it doesn't do X!
See [./TODO.md](./TODO.md). Or fork this repo and add it yourself, and make a Pull Request, I'll probably accept your changes.
## How do I use it?
See and download the provided exe/binary file.
If you put `potemkeysoptions.jsonc` in the same folder as the EXE file, it will prefer that over its temporary directory.
If you want to know where the temp file is, look at the console output when the .exe first starts up.
## Development
1. Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
2. Clone this repo
3. In the repo's folder, run:
```
./scripts/setup[.cmd|.sh]
./scripts/start[.cmd|.sh]
```
4. The window should stay on top.
***Play your game in borderless/windowed mode*** and see the inputs get transformed and shown to you.
### Build WHL
uv build
#### Test built WHL
pip install .\dist\potemkeys-whatever-version-1.2.3.4.5-py3-none-any.whl --force-reinstall
### Deploy to PyPI
uv publish
### Testing exe generation
./scripts/generate_exe[.cmd|.sh]
./dist/potemkeys[.exe|.app]
## Config
Edit [`potemkeysoptions.jsonc`](/potemkeys/potemkeysoptions.jsonc).
You can make keymaps for literally any game that uses keyboard, by cloning the items under `keymaps`.
If you make one and want to see it included in the "official" branch of this tool, just fork this repo and make a PR.
## License
No license, DWYW, I'm not your dad.
Just make sure to link/PR, or just fork it if I die or something :P
## VIRUSES????
https://www.reddit.com/r/learnpython/comments/e99bhe/why_does_pyinstaller_trigger_windows_defender
### REEEEEEEEEEEEEEE
https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/platform-apis/ms537361(v=vs.85)?redirectedfrom=MSDN