Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bezborodow/celtic-knot
Celtic knot grid pattern generator for SVG.
https://github.com/bezborodow/celtic-knot
algorithmic-art celtic-knots svg
Last synced: 9 days ago
JSON representation
Celtic knot grid pattern generator for SVG.
- Host: GitHub
- URL: https://github.com/bezborodow/celtic-knot
- Owner: bezborodow
- License: bsd-3-clause
- Created: 2023-01-04T17:12:12.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-25T22:11:23.000Z (10 months ago)
- Last Synced: 2024-10-26T21:36:30.719Z (about 2 months ago)
- Topics: algorithmic-art, celtic-knots, svg
- Language: Ruby
- Homepage: https://www.rubydoc.info/github/bezborodow/celtic-knot/
- Size: 937 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Celtic Knot Generator for SVG
**`celtic-knot`** is a [Ruby](https://www.ruby-lang.org/en/) programme that creates simple rectangular
celtic knot drawings based upon a given set of parameters. The images are in a vector format.
## Synopsis
The drawing is in [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) (Scaleable Vector Graphics) format, which is sent to standard output.
## Usage
```
Usage: ./knot [options]
-h, --help Prints this help
-V, --vertical=VERTICAL Number of cells vertically.
-H, --horizontal=HORIZONTAL Number of cells horizontally.
-G, --cell-size=CELL_SIZE Dimensions of each cell in the grid.
-b, --background-color=BG_COLOR Background colour.
-k, --knot-color=KNOT_COLOR Knot colour.
-K, --knot-width=KNOT_WIDTH Knot width.
-s, --stroke-color=STROKE_COLOR Stroke colour.
-S, --stroke-width=STROKE_WIDTH Stroke width.
```
### Examples
#### Basic
```console
./knot \
--vertical=2 \
--horizontal=2 \
--cell-size=96 \
--knot-color='white' \
--knot-width=24 \
--stroke-color=black \
--stroke-width=8 \
> basic.svg
```
#### Ingƿine
```console
./knot \
--vertical=3 \
--horizontal=4 \
--cell-size=96 \
--background-color='#012169' \
--knot-color='#C8102E' \
--knot-width=32 \
--stroke-color=white \
--stroke-width=16 \
> ingwine.svg
```
#### Bratach (Banner)
```console
./knot \
--vertical=5 \
--horizontal=6 \
--cell-size=64 \
--background-color='#169B62' \
--knot-color='#FF883E' \
--knot-width=32 \
--stroke-color=white \
--stroke-width=4 \
> bratach.svg
```
### Converting SVG to Other Formats
The SVG file can be viewed locally in your Web browser or converted into other formats such as [PNG](http://www.libpng.org/pub/png/) using utilities such as ImageMagick's [`convert`](https://imagemagick.org/script/convert.php). For example:
```console
convert -background none examples/basic.svg examples/basic.png
```
## Installation
### Fedora
```console
sudo dnf install ruby rubygem-nokogiri
mkdir ~/src
cd ~/src/
git clone [email protected]:bezborodow/celtic-knot.git
cd celtic-knot
bundle install --local
```
## Internals
[API Documentation](https://www.rubydoc.info/github/bezborodow/celtic-knot/)
## Author
2023 Damien Bezborodov