KitX

Docs website: English | 简体中文

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:

0. KitX is running on user\’s all devices
1. User pressed Ctrl + Alt + A which has been assigned to \’Cast remote screenshot\’ function from plugin \’Screenshot\’
2. This function asked KitX for a remote device and suspended to wait KitX\’s response
3. User selected device \’DESKTOP-Bedroom\’ and KitX returned user\’s selection to function above
4. Function then asked KitX to call \’Cast screenshot\’ function from plugin \’Screenshot\’ on device \’DESKTOP-Bedroom\’
5. 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

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://g*ithub.c*om*/Crequency/KitX.git\”

1. Get source code

git clone git@github.com:Crequency/KitX.git
cd KitX

2. Init submodules

git submodule update --init --recursive

3. Setup

cheese setup --reference

Versions Roadmap

See details in ChangeLog

Contributors

Star History

Thanks to

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