Giter VIP home page Giter VIP logo

contextual-shortcuts's Introduction

Contextual Shortcuts

A simple tool that provides contextual shortcuts for any application that has defined a keyset.

Extremely easy to implement!

Why to use?

  • Provides an easy way to learn shortcuts, should be relevant to any application that works with multiple contexts e.g. Blender, Unreal Engine, Godot.
  • Spare the cognitive load of searching (interruption, open web browser, think of query, parse findings).
  • Allows people to start using shortcuts right away, instead of when they bother to look them up.

How to use?

Define a keyset

What is a keyset?

It is a file that contains all of your application's contexts, related actions & keybinds defined for each action.

What is a context?

Contexts are like spaces that are meant to contain only the relevant shortcuts, e.g. the user clicks some window that has it's own special shortcuts.

<Keyset>
   <!-- Keys in a keybind are separated by whitespaces. Refer to key-examples.txt for appropriate key names. -->
    <Shortcut context="someContext" shortcut="someCoolShortcutInYourProgram" keybind="CTRL ALT D"/> 
    <Shortcut context="anotherContext" shortcut="anotherCoolShortcut" keybind="CTRL F"/>
</Keyset>

Change the context

Write to 'cs.txt' from any point in your code in the following format:

YourKeySetName ContextYouWishToUse

So if you had a keyset for Blender & wanted to see shortcuts relevant to a context named 'Sculpting' you would write like so:

BlenderKeyset.xml Sculpting

Done!

Now your users don't need to waste time navigating sheets of keyboard shortcuts, it's all contextual!

Have a feature request? Open an issue!

contextual-shortcuts's People

Contributors

viljami-j avatar

Watchers

 avatar

contextual-shortcuts's Issues

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.