Want to remap your input devices like keyboards, mice, controllers and more?
There's nothing you can't remap withmap2!
- 🖱️Remap keys, mouse events, controllers, pedals, and more!
- 🔧Highly configurable,using Python
- 🚀Blazingly fast,written in Rust
- 📦Tiny install size(around 5Mb), almost no dependencies
- ❤️Open source,made with love
Visit ourofficial documentation for the full feature list and API.
The easiest way is to usepip
:
pip install map2
For more, check out theInstall documentation.
After installing, please read the Getting started documentation.
importmap2
# readers intercept all keyboard inputs and forward them
reader=map2.Reader(patterns=["/dev/input/by-id/my-keyboard"])
# mappers change inputs, you can also chain multiple mappers!
mapper=map2.Mapper()
# writers create new virtual devices we can write into
writer=map2.Writer(clone_from="/dev/input/by-id/my-keyboard")
# finally, link nodes to control the event flow
map2.link([reader,mapper,writer])
# map the "a" key to "B"
mapper.map("a","B")
# map "CTRL + ALT + u" to "META + SHIFT + w"
mapper.map("^!u","#+w")
# key sequences are also supported
mapper.map("s","hello world!")
# use the full power of Python using functions
defcustom_function(key,state):
print("called custom function")
# custom conditions and complex sequences
ifkey=="d":
return"{ctrl down}a{ctrl up}"
returnTrue
mapper.map("d",custom_function)
To build from source, make sure Python and rust are installed.
#create a Python virtual environment
Python -m venv.env
source.env/bin/activate
#build the library
maturin develop
While the virtual environment is activated, all scripts ran from this terminal will use the newly built version of map2.
If you want to report bugs, add suggestions or help out with development please check theDiscord channeland theissues pageand open an issue if it doesn't exist yet.
MIT
- shiro[email protected]