autoclip-core

Crates.ioautoclip-core
lib.rsautoclip-core
version0.1.0
sourcesrc
created_at2021-01-06 13:55:24.576412
updated_at2021-01-06 13:55:24.576412
descriptionThe core crate to develop plugins for autoclip.
homepagehttps://github.com/siketyan/autoclip
repositoryhttps://github.com/siketyan/autoclip.git
max_upload_size
id333103
size3,615
Natsuki Ikeguchi (siketyan)

documentation

README

📎 autoclip

Rust

Do something on your clipboard, automatically.

✨ Features

  • Automatic
  • Customisable with Plugins

📦 Installation

$ cargo build --release

🔌 Installing Plugins

Automatically (recommended)

If the plugin is published to autoclip-plugins repository, you can install it automatically:

$ ./autoclip-app install [name]

Manually

  1. Open the local data directory.
    • Windows: C:\Users\[Your Name]\AppData\Local
    • macOS: /Users/[Your Name]/Library/Application Support
    • Linux: /home/[your_name]/.local/share
  2. Now go into autoclip directory, then plugins .
    • If the directories not exists, create them.
  3. Put the .dll, .dylib or .so files of plugins into the plugins directory.

🔧 Developing Plugins

  1. Setup your Rust environment.
  2. Create a new lib crate.
    $ cargo new --lib plugin-name-of-your-plugin
    
  3. Configure Cargo.toml, changing the crate type to cdylib.
    [lib]
    crate-type = ["cdylib"]
    
  4. Add autoclip-core as a dependency.
    [dependencies]
    autoclip-core = "0.1.0"
    
  5. Implement AutoclipPlugin trait as you like.
  6. Export the plugin with a macro:
    autoclip_core::export_plugin!("name-of-your-plugin", AutoclipPluginImpl);
    
  7. Build & distribute .dll, .dylib and .so files!

☑ ToDo

  • OS Support
    • Windows Support
    • macOS Support
    • Linux Support
  • Customisation
    • Polling Interval
  • Installer
  • Plugin Installer
Commit count: 105

cargo fmt