Giter Club home page Giter Club logo

midikeylinker's Introduction

Forks Stargazers Issues MIT License


Logo

MIDI KeyLinker

With MIDI keyLinker, you can easily assign MIDI messages from your MIDI controller or device to specific keyboard shortcuts or mouse commands within your favourite software applications.


View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This software allows you to map midi messages to keyboard commands, connect your midi controller to your computer, play a control and customize a command on your keyboard.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • python
  • pyqt6
  • rtmidi
  • pyqt6-tools

(back to top)

Getting Started

Currently we have not released any releases, which is why it is required to run the desktop application from its source code. Below I show you the necessary steps to run it on your computer, initially you have to download the source code from our github repository:

git clone https://github.com/andresjpulido/MIDIKeyLinker.git

Prerequisites

Below is the list of libraries required to compile this application.

pip install -r requirements.txt

Execution

python midikeylinker/app.py

Development

The user interface has been created using the QT Designer tool, below I show how to customize the UI and translate it to Python code. .

Open the Qt Designer:

pyqt6-tools designer

This command generates a Python module according to the given options:

pyuic6 midikeylinker/views/main.ui -o midikeylinker/views/main.py

(back to top)

conda env export > environment.yml

Usage

We have created a wiki to document the use of this application. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

Please refer to the Documentation

(back to top)

Roadmap

  • Add reading file preferences
  • MIDI Device Recognition
  • Identification of MIDI messages
  • MIDI command mapping
  • Multi-language Support
    • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Andres - @andresjpb - [email protected]

Project Link: https://github.com/andresjpulido/MIDIKeyLinker

(back to top)

Acknowledgments

This list contains some useful resources for working on this project.

(back to top)

midikeylinker's People

Contributors

andresjpulido avatar

Stargazers

 avatar

Watchers

 avatar

midikeylinker's Issues

create mockups

  • Review the graphical interfaces of existing software
  • Create a mockup Edit action
  • Create a mockup Assign action - Start program tab
  • Create a mockup Main screen

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.