Skip to content
CrequencyPublic

KitX — an open, shared, connected tools platform

KitX Logo


Docs website: English | 简体中文 🌐


Build Universal Build Loaders Build Plugins

License Release Downloads GitHub Repo Size Code Size Commit Activity

Forks Stars Watches Discussions

About

KitX Project is going to build a world that everything is connected.

KitX is an open, shared, connected and free tools platform.

After plugins developed by developers with their prefered languages and frameworks uploading to plugins market, users can download and combine plugins they like.

Every plugin contains atomized and platform independent functions, which will be connected with other functions by KitX.

For example:

  1. KitX is running on user's all devices
  2. User pressed Ctrl + Alt + A which has been assigned to 'Cast remote screenshot' function from plugin 'Screenshot'
  3. This function asked KitX for a remote device and suspended to wait KitX's response
  4. User selected device 'DESKTOP-Bedroom' and KitX returned user's selection to function above
  5. Function then asked KitX to call 'Cast screenshot' function from plugin 'Screenshot' on device 'DESKTOP-Bedroom'
  6. Remote returned a screenshot and displayed on user's current device by local plugin

Architecture

KitX uses a three-layer design

Plugin <-> Loader \
                   \
Plugin <-> Loader <-> Dashboard <-> User
                   /
Plugin <-> Loader /

The third party is responsible for referring to the documentation to implement the interface that the Plugin should implement.

How to implement the different frameworks of each language and the Loaders chosen to implement are different.

Each language or framework will have a corresponding Loader to achieve interoperability with Plugin, and Loader communicates with Dashboard through Socket, reporting the situation and passing commands.

Each of these three-layer designs can be replaced, and any layer can be customized or a third-party solution can be used.

In this way, plug-ins on other devices in the LAN can also be connected to the current device, so LAN interconnection can be achieved.

Requirements

platforms versions x86 arm risc-v mips loongarch
Windows 10, 11 x32 , x64 arm , arm64 ❌ ❌ ❌
Linux - x64 arm , arm64 ❌ ❌ loongarch32 (ToDo) , loongarch64 (ToDo)
MacOS - x64 arm64 ❌ ❌ ❌
Android Android 5.0 + (min: 21, compiled: 33, target: 33) x64 armeabi-v7a , arm64-v8a ❌ ❌ ❌
iOS iOS 12.0 + ❌ arm64 ❌ ❌ ❌
Raspberry Pi - ❌ ❌ ❌ ❌ ❌
Browser - ❌ ❌ ❌ ❌ ❌

Development

We strongly suggest you to configure your ssh environment, in order to use git link format like “git@github.com:Crequency/KitX.git” instead of "https://github.com/Crequency/KitX.git"

  1. Get source code
git clone git@github.com:Crequency/KitX.git
cd KitX
  1. Init submodules
git submodule update --init --recursive
  1. Setup
cheese setup --reference

Versions Roadmap

The version currently under development:

Version Info Code Support Term Require Runs on
v3.25.04.x Release - developing 2024.10 -> 2025.04 Desktop: .Net 8 (Also Self-Contained)
Mobile: Native
Windows, Linux, macOS, Android, iOS, Raspberry Pi

For the full version history — deprecated and unfinished versions — see docs/VERSIONS.md. Release notes are in ChangeLog.

Contributors

Contributors

Star History

Star History Chart

Thanks to

JetBrains Logo (Main) logo

Thanks to the great tools from JetBrains, we can turn our ideas into reality.

Releases

Sponsor this project

Used by

Contributors

Languages