catchup with upstream

.github/workflows/node.js.yml

@@ -0,0 +1,30 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test

.gitignore

@@ -1,11 +1,12 @@
 .DS_Store
 node_modules/
 npm-debug.log
-test/output/*.json
-test/output/*.fnt
-test/output/*.png
-test/output/*.txt
-test/output/*.svg
-test/output/*.cfg
+test/assets/fonts/*.json
+test/assets/fonts/*.fnt
+test/assets/fonts/*.png
+test/assets/fonts/*.txt
+test/assets/fonts/*.svg
+test/assets/fonts/*.cfg
 .vscode/
 .eslintrc*
+.prettierrc

CHANGELOG.md

@@ -0,0 +1,63 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [2.7.0](https://github.com/soimy/msdf-bmfont-xml/compare/v2.6.0...v2.7.0) (2022-07-23)
+
+
+### Features
+
+* add new output type: txt ([34d8976](https://github.com/soimy/msdf-bmfont-xml/commit/34d8976a8672045534c8c379c967cf16bcbb8cbe))
+
+## [2.6.0](https://github.com/soimy/msdf-bmfont-xml/compare/v2.5.4...v2.6.0) (2022-01-31)
+
+
+### Features
+
+* Add version update-notifier ([23aace9](https://github.com/soimy/msdf-bmfont-xml/commit/23aace97c8e4af5174f8191133e42b54baafd0b5))
+
+### [2.5.4](https://github.com/soimy/msdf-bmfont-xml/compare/v2.5.3...v2.5.4) (2020-02-08)
+
+
+### Bug Fixes
+
+* CLI&document for SVG debug generation from `-t svg` to `-v` ([c37cc40](https://github.com/soimy/msdf-bmfont-xml/commit/c37cc40)), closes [#46](https://github.com/soimy/msdf-bmfont-xml/issues/46)
+* omit path in font-face ([ae559fd](https://github.com/soimy/msdf-bmfont-xml/commit/ae559fd)), closes [#49](https://github.com/soimy/msdf-bmfont-xml/issues/49)
+* Re-use cfg settings not applied ([3b57562](https://github.com/soimy/msdf-bmfont-xml/commit/3b57562)), closes [#44](https://github.com/soimy/msdf-bmfont-xml/issues/44)
+
+
+
+### [2.5.3](https://github.com/soimy/msdf-bmfont-xml/compare/v2.5.2...v2.5.3) (2020-01-26)
+
+
+
+### [2.5.2](https://github.com/soimy/msdf-bmfont-xml/compare/v2.5.1...v2.5.2) (2019-07-12)
+
+
+### Bug Fixes
+
+* async texture generation skips fontData stringify ([230d0b3](https://github.com/soimy/msdf-bmfont-xml/commit/230d0b3)), closes [#39](https://github.com/soimy/msdf-bmfont-xml/issues/39)
+
+
+
+### [2.5.1](https://github.com/soimy/msdf-bmfont-xml/compare/v2.5.0...v2.5.1) (2019-07-11)
+
+
+### Bug Fixes
+
+* async jimp.read() should be fulfilled before continue packing ([5d95b32](https://github.com/soimy/msdf-bmfont-xml/commit/5d95b32))
+* package script render changed to yarn ([84732bf](https://github.com/soimy/msdf-bmfont-xml/commit/84732bf))
+
+
+### Tests
+
+* Fix run render by replacing abandoned devtools ([071b016](https://github.com/soimy/msdf-bmfont-xml/commit/071b016)), closes [#38](https://github.com/soimy/msdf-bmfont-xml/issues/38)
+
+
+
+## [2.5.0](https://github.com/soimy/msdf-bmfont-xml/compare/v2.4.3...v2.5.0) (2019-06-19)
+
+
+### Features
+
+* new border option to control packing space to atlas edge ([33598b9](https://github.com/soimy/msdf-bmfont-xml/commit/33598b9))

README.md

@@ -2,54 +2,62 @@
 
 [![Build Status](https://travis-ci.org/soimy/msdf-bmfont-xml.svg?branch=master)](https://travis-ci.org/soimy/msdf-bmfont-xml)
 [![npm version](https://badge.fury.io/js/msdf-bmfont-xml.svg)](https://badge.fury.io/js/msdf-bmfont-xml)
+![npm](https://img.shields.io/npm/dm/msdf-bmfont-xml.svg)
 
-Converts a `.ttf` font file into multichannel signed distance fields, then outputs packed spritesheets and a xml(.fnt} or json representation of an AngelCode BMfont.
+Converts a `.ttf` font file into multichannel signed distance fields, then outputs packed spritesheets and an `xml(.fnt}` / `txt(.fnt)` or `json` representation of an AngelCode BMFont file.
 
 Signed distance fields are a method of reproducing vector shapes from a texture representation, popularized in [this paper by Valve](http://www.valvesoftware.com/publications/2007/SIGGRAPH2007_AlphaTestedMagnification.pdf).
-This tool uses [Chlumsky/msdfgen](https://github.com/Chlumsky/msdfgen) to generate multichannel signed distance fields to preserve corners. The distance fields are created from vector fonts, then rendered into texture pages. A BMFont object is provided for character layout.
-
+This tool uses [Chlumsky/msdfgen](https://github.com/Chlumsky/msdfgen) to generate multichannel signed distance fields to preserve corners. The distance fields are created from vector fonts, then rendered into texture pages. A BMFont object is provided for character layout. (See: [BMFont format](http://www.angelcode.com/products/bmfont/doc/file_format.html))
 ![Preview image](https://raw.githubusercontent.com/soimy/msdf-bmfont-xml/master/assets/msdf-bmfont-xml.png)
 
+## Run script to see MSDF font in browser using pixi.js
+
+```bash
+npm install & npm run render
+```
+
 ## Install as CLI
+
 ```bash
-$ npm install msdf-bmfont-xml -g
+npm install msdf-bmfont-xml -g
 ```
+
 Then you just need to call `msdf-bmfont` from console to generate font file.
 Type in `msdf-bmfont --help` for more detail usage.
 
 ![Console-Demo](https://raw.githubusercontent.com/soimy/msdf-bmfont-xml/master/assets/console-demo.gif)
 
 ### Usage
 
-```
+```bash
 Usage: msdf-bmfont [options] <font-file>
 
-  Creates a BMFont compatible bitmap font of signed distance fields from a font file
-
-  Options:
-
-    -V, --version                 output the version number
-    -f, --output-type <format>    font file format: xml(default) | json
-    -o, --filename <atlas_path>   filename of font textures (defaut: font-face) 
-                                  font filename always set to font-face name
-    -s, --font-size <fontSize>    font size for generated textures (default: 42)
-    -i, --charset-file <charset>  user-specified charactors from text-file
-    -m, --texture-size <w,h>      Width/Height of generated textures (default: 512,512)
-    -p, --texture-padding <n>     padding between glyphs (default: 1)
-    -r, --distance-range <n>      distance range for SDF (default: 4)
-    -t, --field-type <type>       msdf(default) | sdf | psdf | svg
-    -d, --round-decimal <digit>   rounded digits of the output font file. (Defaut: 0)
-    -v, --vector                  generate svg vector file for debuging
-    -u, --reuse [file.cfg]        use old config to append font, ommit file to save new cfg
-        --tolerance <value>       use point tolerance to filter problematic vector shape (Defaut: 0)
-        --smart-size              shrink atlas to the smallest possible square (Default: false)
-        --pot                     atlas size shall be power of 2 (Default: false)
-        --square                  atlas size shall be square (Default: false)
-        --rtl                     use RTL(Arabic/Persian) charators fix (Default: false)
-    -h, --help                    output usage information
+Creates a BMFont compatible bitmap font of signed distance fields from a font file
+
+Options:
+  -V, --version                 output the version number
+  -f, --output-type <format>    font file format: xml(default) | json | txt (default: "xml")
+  -o, --filename <atlas_path>   filename of font textures (defaut: font-face)
+                                font filename always set to font-face name
+  -s, --font-size <fontSize>    font size for generated textures (default: 42)
+  -i, --charset-file <charset>  user-specified charactors from text-file
+  -m, --texture-size <w,h>      ouput texture atlas size (default: [2048,2048])
+  -p, --texture-padding <n>     padding between glyphs (default: 1)
+  -b, --border <n>              space between glyphs textures & edge (default: 0)
+  -r, --distance-range <n>      distance range for SDF (default: 4)
+  -t, --field-type <type>       msdf(default) | sdf | psdf (default: "msdf")
+  -d, --round-decimal <digit>   rounded digits of the output font file. (default: 0)
+  -v, --vector                  generate svg vector file for debuging
+  -u, --reuse [file.cfg]        save/create config file for reusing settings (default: false)
+      --smart-size              shrink atlas to the smallest possible square
+      --pot                     atlas size shall be power of 2
+      --square                  atlas size shall be square
+      --rot                     allow 90-degree rotation while packing
+      --rtl                     use RTL(Arabic/Persian) charactors fix
+  -h, --help                    output usage information
 ```
 
-### Examples
+### CLI Examples
 
 Generate a multi-channel signed distance field font atlas with ASCII charset, font size 42, spread 3, maximum texture size 512x256, padding 1, and save out config file:
 
@@ -79,17 +87,16 @@ How about fire up some graphic editor and add some neat effect and lay on the ou
 
 ![final](https://raw.githubusercontent.com/soimy/msdf-bmfont-xml/master/assets/atlas.2.jpg)
 
-
-
 ## Install as Module
 
 ```bash
-$ npm install msdf-bmfont-xml
+npm install msdf-bmfont-xml
 ```
 
-## Examples
+### Module usage Examples
 
 Writing the distance fields and font data to disk:
+
 ```js
 const generateBMFont = require('msdf-bmfont-xml');
 const fs = require('fs');
@@ -108,6 +115,7 @@ generateBMFont('Some-Font.ttf', (error, textures, font) => {
 ```
 
 Generating a single channel signed distance field with a custom character set:
+
 ```js
 const generateBMFont = require('msdf-bmfont');
 
@@ -116,31 +124,34 @@ const opt = {
   fieldType: 'sdf'
 };
 generateBMFont('Some-Font.ttf', opt, (error, textures, font) => {
-	...
+  ...
 });
 ```
 
-## Usage
+### API
 
-#### `generateBMFont(fontPath, [opt], callback)`
+#### `generateBMFont(fontPath | fontBuffer, [opt], callback)`
 
-Renders a bitmap font from the font at `fontPath` with optional `opt` settings, triggering `callback` on complete.
+Renders a bitmap font from the font specified by `fontPath` or `fontBuffer`, with optional `opt` settings, triggering `callback` on complete.
 
 Options:
+
 - `outputType` (String)
   - type of output font file. Defaults to `xml`
-    - `xml` a BMFont standard .fnt file which is wildly supported. 
+    - `xml` a BMFont standard .fnt file which is wildly supported.
     - `json` a JSON file compatible with [Hiero](https://github.com/libgdx/libgdx/wiki/Hiero)
 - `filename` (String)
-  - filename of both font file and font atlas. If omited, font face name is used.
+  - filename of both font file and font atlas. If omited, font face name is used. **Required** if font is provided as a Buffer.
 - `charset` (String|Array)
-  - the characters to include in the bitmap font. Defaults to all ASCII printable characters. 
+  - the characters to include in the bitmap font. Defaults to all ASCII printable characters.
 - `fontSize` (Number)
   - the font size at which to generate the distance field. Defaults to `42`
-- `textureWidth, textureHeight` (Number)
-  - the dimensions of an output texture sheet, normally power-of-2 for GPU usage. Both dimensions default to `512`
+- `textureSize` (Array[2])
+  - the dimensions of an output texture sheet, normally power-of-2 for GPU usage. Both dimensions default to `[512, 512]`
 - `texturePadding` (Number)
   - pixels between each glyph in the texture. Defaults to `2`
+- `border` (Number)
+  - space between glyphs textures & edge. Defaults to `0`
 - `fieldType` (String)
   - what kind of distance field to generate. Defaults to `msdf`. Must be one of:
     - `msdf` Multi-channel signed distance field
@@ -152,20 +163,22 @@ Options:
   - rounded digits of the output font metics. For `xml` output, `roundDecimal: 0` recommended.
 - `vector` (Boolean)
   - output a SVG Vector file for debugging. Defauts to `false`
-- `smart-size` (Boolean)             
+- `smart-size` (Boolean)
   - shrink atlas to the smallest possible square. Default: `false`
 - `pot` (Boolean)
   - output atlas size shall be power of 2. Default: `false`
 - `square` (Boolean)
   - output atlas size shall be square. Default: `false`
+- `rot` (Boolean)
+  - allow 90-degree rotation while packing. Default: `false`
 - `rtl` (Boolean)
   - use RTL(Arabic/Persian) charators fix. Default: `false`
 
 The `callback` is called with the arguments `(error, textures, font)`
 
 - `error` on success will be null/undefined
 - `textures` an array of js objects of texture spritesheet.
-  - `textures[index].filename` Spritesheet filename 
+  - `textures[index].filename` Spritesheet filename
   - `textures[index].texture` Image Buffers, containing the PNG data of one texture sheet
 - `font` an object containing the BMFont data, to be used to render the font
   - `font.filename` font filename

assets/charset/charset.arabic.txt

@@ -0,0 +1,52 @@
+ببب ب
+تتت ت
+ضضض ض
+صصص ص
+ثثث ث
+ققق ق
+ففف ف
+غغغ غ
+ععع ع
+ههه ه
+ـة ة
+خخخ خ
+ححح ح
+ججج ج
+چچچ چ
+ششش ش
+سسس س
+ئئئ ئ
+ىىـی ى
+ييي ي
+ببب ب
+للل ل
+ء
+ـأأ
+ـإإ
+ـاا
+ـآآ
+لا
+ـلا
+لأ
+ـلأ
+لإ
+ـلإ
+لآ
+ـلآ
+ننن ن
+ممم م
+ككك ك
+ککک ک
+گگگ گ
+ظظظ ظ
+ططط ط
+ـزز
+ـرر
+ـژژ
+ـوو
+ـذذ
+ـدد
+پپپ پ
+َُِّ
+":><؟{}|+_()&*!@#$%×÷÷`|;'[].,/\،-=
+12345567890