load-bmfont

Loads an AngelCode BMFont file in browser (with XHR) and node (with fs and phin), returning a JSON representation.

1var load = require("load-bmfont");
2
3load("fonts/Arial-32.fnt", function (err, font) {
4  if (err) throw err;
5
6  //The BMFont spec in JSON form
7  console.log(font.common.lineHeight);
8  console.log(font.info);
9  console.log(font.chars);
10  console.log(font.kernings);
11});

Currently supported BMFont formats:

• ASCII (text)
• JSON
• XML
• binary

See Also

See text-modules for related modules.

Usage

load(opt, cb)

Loads a BMFont file with the opt settings and fires the callback with (err, font) params once finished. If opt is a string, it is used as the URI. Otherwise the options can be:

• uri or url the path (in Node) or URI
• binary boolean, whether the data should be read as binary, default false
• (in node) options for fs.readFile or phin
• (in browser) options for xhr

To support binary files in the browser and Node, you should use binary: true. Otherwise the XHR request might come in the form of a UTF8 string, which will not work with binary files. This also sets up the XHR object to override mime type in older browsers.

1load(
2  {
3    uri: "fonts/Arial.bin",
4    binary: true,
5  },
6  function (err, font) {
7    console.log(font);
8  }
9);

License

MIT, see LICENSE.md for details.