Skip to content

felix-sky/EdgeGesture

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

EdgeGesture

EdgeGesture enables edge gesture to your windows computer, enhancing the touchscreen experience. Project is still under development, expect features not working.
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

Important!

Disable edge gesture (at least the left side) in windows settings before using EdgeGesture.

About The Project

Product Name Screen Shot

(back to top)

Built With

  • C++
  • Qt
  • Qt

(back to top)

Getting Started

Download from release page, run SettingsUI.exe. And enjoy!

(back to top)

Usage

Swipe from the left (top edge is under development) edge of the screen to trigger the gesture. Blacklists, plugins, action recordings etc. are all configured in SettingsUI.exe.

(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

Plugin Development

EdgeGesture supports plugin development via QML. Because QML operates within a sandboxed environment, you must use C++ bridges to interact with the system.

Available C++ Bridges:

  • FileBridge: File system operations.
  • SystemBridge: System-level interactions.
  • ConfigBridge: Configuration management.

Note: Dynamic loading of DLLs is currently under development.

Development Guidelines

Plugins are hosted within src_ui/plugin/PluginContainer.qml (a SwipeView component). To develop a plugin, please follow these requirements:

  • Component Type: The plugin must be a QML Item.
  • Directory: Place your files in plugin/components/.
  • Dimensions: Due to a known issue, the width must currently be set to 360.
  • Preview Image: Additionally a snapshot of the plugin (aspect ratio 360:800) can be placed in plugin/preview/.

Workflow: Since EdgeGesture scans and loads plugins at runtime upon startup, you can develop and test plugins without a full Qt Creator environment or the official SDK (though I haven't tested it).

Developing plugins for PluginContainer

Use src_ui/plugin/components/*.qml as a template to develop plugins (place your plugins (for PluginContainer) here as well). The plugin will be loaded at runtime and displayed in the PluginContainer.

Not developing plugins for PluginContainer

Use src_ui/plugin/PluginContainer.qml as a template to develop plugins. In this case, place your plugins (notfor PluginContainer) in src_ui/plugin. The plugin will be loaded at runtime and recognized as a new action.

(back to top)

License

Distributed under the GPL v3. See LICENSE.txt for more information.

(back to top)

Acknowledgments

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published