README.md

@bricked/fc-template

A template for creating Fancade editor scripts.

ToDo

• Create a new repository from this template
• Find & replace fc-template with the name of the new repository
• Find & replace the description with a proper one
• Add NPM_TOKEN as a new repository secret
• Remove "dryRun": true from the package.json
• Remove this section

Installation

Install as dependency

Install the package from npm to use it in your local editor scripts. Node.js 16.14.0 or newer is required.

npm install @bricked/ts-template
yarn add @bricked/ts-template
pnpm add @bricked/ts-template

Install in Fancade editor

1. Find the latest build or build locally

2. Find the desired script in dist/ and open it

3. Paste the code directly in the Fancade editor

Usage

fc-template can be used as a template for creating Fancade editor scripts.

Building

Building Publicly

Pulls to the repository will automatically be built with semantic-release. The built package can be found on npm or in the latest github release.

Building Locally

The package can also be built locally using the build script.

npm run build
yarn run build
pnpm run build