svg2ttf

The svg2ttf function converts an SVG font string into a TTF byte buffer.

Signature: svg2ttf(svgFontString, options) -> buf

Parameters:

• svgFontString: The raw SVG font content as a string.
• options: An object to configure font metadata:
  • copyright: (optional) Copyright string.
  • description: (optional) Description string.
  • ts: (optional) Unix timestamp (in seconds) to override the creation time.
  • url: (optional) Manufacturer URL.
  • version: (optional) Font version string (e.g., Version x.y or x.y).

Return Value: Returns a buf object (an internal byte buffer similar to DataView). To get the actual TTF content, access the buffer property, which is a Uint8Array or Array.

var fs = require('fs');
var svg2ttf = require('svg2ttf');

// Convert SVG to TTF buffer
var ttf = svg2ttf(fs.readFileSync('myfont.svg', 'utf8'), {});

// Write the buffer content to a file
fs.writeFileSync('myfont.ttf', new Buffer(ttf.buffer));

The svg2ttf function converts an SVG font string into a TTF (TrueType Font) buffer. It accepts an SVG font string and an optional configuration object to customize font metadata, metrics, and versioning.

Parameters:

• svgString (String): The input SVG font string.
• options (Object): Configuration for the generated font.

Returns:

• Buffer: A buffer containing the generated TTF content.

Common Options:

• id: Font ID.
• familyname: Font family name.
• subfamilyname: Font subfamily name (defaults to 'Regular').
• fullname: Full font name.
• copyright: Copyright metadata.
• description: Font description.
• url: Font URL.
• version: A string representing the version (must match the pattern ^(\d+[.]\d+)$ or include the prefix Version ).
• ts: A Unix timestamp (seconds) to set createdDate and modifiedDate.

Errors:

• Throws an error if version is not a string.
• Throws an error if version does not match the expected version format.

const svg2ttf = require('svg2ttf');

const svgString = '<svg>...</svg>'; // Your SVG font string
const options = {
  id: 'my-font',
  familyname: 'My Font',
  fullname: 'My Font Regular',
  version: '1.0',
  copyright: '© 2023 My Company'
};

try {
  const ttfBuffer = svg2ttf(svgString, options);
  // Use the buffer (e.g., write to file)
} catch (err) {
  console.error('Failed to generate TTF:', err.message);
}

When using the svg2ttf CLI, you can override the default font metadata using the following flags:

-c, --copyright      Copyright text
-d, --description    Override default description text
--ts                 Override font creation time (Unix time stamp)
-u, --url            Override default manufacturer url
--vs                 Override default font version string (Version 1.0), can be "x.y" or "Version x.y"