6.5 KiB
@freesewing/core-plugins
An umbrella package of essential plugins that are bundled with the FreeSewing core library
Plugins
- plugin-cutonfold : Add cut-on-fold indicators to your patterns
- plugin-dimension : Add dimensions to your (paperless) patterns
- plugin-grainline : Add grainline indicators to your patterns
- plugin-logo : Add a scalebox to your patterns
- plugin-scalebox : Add pretty titles to your pattern parts
- plugin-title : Add pretty titles to your pattern parts
- plugin-round : Rounds corners
- plugin-sprinkle : Add multiple snippets to your pattern
Note that these are all build-time plugins. In other words, plugins used by developers/pattern designers, rather than run-time plugins that are used when generating patterns.
Without exception, all freesewing patterns use all these plugins, so it made sense to bundle them.
Usage
To load this plugin, add it to your instantiated pattern.
On node.js:
import freesewing from '@freesewing/core'
import plugins from '@freesewing/plugin-bundle'
let pattern = new freesewing.Pattern().with(plugins);
FreeSewing
Tip
Support FreeSewing: Become a patron, or make a one-time donation 🥰
FreeSewing is an open source project maintained by Joost De Cock and financially supported by the FreeSewing patrons.
If you feel FreeSewing is worthwhile, and you can spend a few coins without hardship, then you should join us and become a patron.
What am I looking at? 🤔
This repository is the FreeSewing monorepo holding all FreeSewing's websites, documentation, designs, plugins, and other NPM packages.
This folder holds: @freesewing/core-plugins
If you're not entirely sure what to do or how to start, type this command:
npm run tips
Note
If you don't want to set up a dev environment, you can run it in your browser:
We recommend that you fork our repository and then put
gitpod.io/#<entire-url-of-your-forkinto a browser to start up a browser-based dev environment of your own.
About FreeSewing 💀
Where the world of makers and developers collide, that's where you'll find FreeSewing.
If you're a maker, checkout freesewing.eu where you can generate sewing patterns adapted to your measurements.
If you're a developer, the FreeSewing documentation lives at freesewing.dev. The FreeSewing core library is a batteries-included toolbox for parametric design of sewing patterns. But FreeSewing also provides a range of plugins that further extend the functionality of the platform.
If you have NodeJS installed, you can try it right now by running:
npx @freesewing/studio
Getting started guides are available for:
The pattern design tutorial will show you how to create your first parametric design.
Getting started ⚡
To get started with FreeSewing, you can spin up our development environment with:
npx @freesewing/studio
To work with FreeSewing's monorepo, you'll need NodeJS v20 on your system.
Once you have that, clone (or fork) this repo and run npm run kickstart:
git clone git@codeberg.org:freesewing/freesewing.git
cd freesewing
npm run kickstart
Links 👩💻
Official channels
- 💻 Makers website: FreeSewing.eu
- 💻 Developers website: FreeSewing.dev
- ✅ Support, Issues & Codeberg
Social media
- 🐘 Mastodon: @freesewing on FreeSewing.social
- 🐘 Mastodon: @joost on FreeSewing.social
Places the FreeSewing community hangs out
License: MIT 🤓
© Joost De Cock.
See the license file for details.