Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stackotter/delta-plugin-template
The template for Delta Client plugins.
https://github.com/stackotter/delta-plugin-template
Last synced: 10 days ago
JSON representation
The template for Delta Client plugins.
- Host: GitHub
- URL: https://github.com/stackotter/delta-plugin-template
- Owner: stackotter
- License: gpl-3.0
- Created: 2021-10-29T23:56:47.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-18T08:02:53.000Z (over 2 years ago)
- Last Synced: 2024-10-25T09:48:09.476Z (about 2 months ago)
- Language: Shell
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Delta Plugin Template
This repository is a template for [Delta Client](https://github.com/stackotter/delta-client) plugins.
To create a plugin, create a repo from this template repo and then replace all occurences of `HelloWorldPlugin` with the name of your plugin (should be a valid Swift type name). You can set a custom display name in `manifest.json` (the `name` field). The `target` field in `manifest`.json is the name of your plugin's SwiftPM target (in this template it's `HelloWorldPlugin`. Make sure to change the identifier in `manifest.json` to something unique as well.
## Building
### Prerequisites
- Xcode 13 (or later)
- [swift-bundler](https://github.com/stackotter/swift-bundler)
- [jq](https://stedolan.github.io/jq/) (install with [homebrew](https://brew.sh): `brew install jq`)
### Setup
```sh
# Clones delta-client into the current directory
# You can also edit this script to clone a specific version of delta-client that you want to develop your plugin for
sh setup.sh
```
### Build
```sh
# Build the plugin and output it into ./build
sh build.sh
```
### Build and run
```sh
# 1. Builds the plugin into ./build
# 2. Builds the version of Delta Client in ./delta-client
# 3. Runs Delta Client with `--plugins-dir ./build`
sh build-and-run.sh
```