Skip to content

A template for building cider plugins using Typescript

Notifications You must be signed in to change notification settings

ChaseIngebritson/Cider-Plugin-Template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cider Plugin Template

This is a Cider Music plugin template designed to streamline the plugin creation process while using Typescript. The template attempts to adhere to the Cider Music v2 plugin schema.

Building

This template utilizes rollup.js to compile the Typescript and package all required files.

Installation

yarn

Development

Running in development mode will allow hot reloading on the build.

yarn start

Production

yarn build

Deployment

IMPORTANT NOTE BEFORE USING THE DEPLOY FUNCTION:

The Cider plugin system requires the plugin deployment files to be contained the in the main branch. As such, the deploy function will create a commit on the main branch with the production files.

I would highly recommend using a seperately named branch, such as dev-main or something similar, to do development on.

yarn deploy

Resources

About

A template for building cider plugins using Typescript

Resources

Stars

Watchers

Forks