This project is mean to describe how to build a third party library to egret game engine, which base on npm package

I will use webpack to build the target.min.js

I will use third-party root as base path, if I hadn't mentioned it.

I suppose you guys acknowledge this :)

I want to code on Linux Env, but their tools not support, so I had to develop on Windows.

If you guys want to develop on Linux anyway, you may install egret to the project to use the egret command

# install egret if you are (Li|U)nix
git clone https://github.com/egret-labs/egret-core.git
# add to ${PATH}
export PATH="/path/to/egret-core/tools/bin:$PATH"

# you can install in your project
npm i -g webpack webpack-cli

mkdir egret-ngraph
cd egret-ngraph
npm init
# index.js is your project entry
touch index.js

Just to define which egret version to compile this project

vim egretProperties.json

{"compilerVersion": "5.2.13"}

These npm packages are what you want to bind to the egret engine

npm i ngraph.path ngraph.graph

mkdir -p libsrc/src libsrc/typings

vim libsrc/package.json

{
	"name": "ngraph",
	"typings": "typings/ngraph.d.ts"
}

vim libsrc/tsconfig.json

{
	"compilerOptions": {
		"target": "es5",
		"noImplicitAny": false,
		"sourceMap": false,
		"outFile": "bin/ngraph/ngraph.js",
		"allowJs": true
	},
	"include": [
		"src/ngraph.js"
	]
}

touch libsrc/typings/ngraph.d.ts

vim webpack.config.js

module.exports = {
    entry:  __dirname + "/index.js",//your project entry
    output: {//webpack output
        path: __dirname + "/libsrc/src",
        filename: "ngraph.js"
    }
}

In this project is index.js.

You must make your object expose in global ( that means you must not use var, let and do not use window as global var, because just browser supports that )

ngraph = {
    graph: require('./node_modules/ngraph.graph/index.js'),
    path: require('./node_modules/ngraph.path/index.js'),
};

In this project is libsrc/typings/ngraph.d.ts

Just define what you want to expose to egret

webpack
# the workplace
egret build libsrc

This project (third-party) must not in egret project (I means directory). Because egret would copy the typescript declaration file and cause duplicate declaration.

Find egret project egretProperties.json and add below config to modules json array

{
    "name": "ngraph",
    "path": "path/to/libsrc"
}

The path key is where your third-party libsrc is location relate to your egret project.

After you build the egret project. You will find that your libsrc/bin/ngraph was just copy to egret project lib/modules/ngraph and add add the bin path to manifest.json

The official usage would be change:

• official:

    let createGraph = require('ngraph.graph');
    let graph = createGraph();
    graph.addNode('NYC', {x: 0, y: 0});
    graph.addNode('Boston', {x: 1, y: 1});
    graph.addNode('Philadelphia', {x: -1, y: -1});
    graph.addNode('Washington', {x: -2, y: -2});
    graph.addLink('NYC', 'Boston');
    graph.addLink('NYC', 'Philadelphia');
    graph.addLink('Philadelphia', 'Washington');
    let path = require('ngraph.path');
    let pathFinder = path.aStar(graph);
    let foundPath = pathFinder.find('NYC', 'Washington');

• third-party package:

    let graph = new ngraph.graph();
    graph.addNode('NYC', {x: 0, y: 0});
    graph.addNode('Boston', {x: 1, y: 1});
    graph.addNode('Philadelphia', {x: -1, y: -1});
    graph.addNode('Washington', {x: -2, y: -2});
    graph.addLink('NYC', 'Boston');
    graph.addLink('NYC', 'Philadelphia');
    graph.addLink('Philadelphia', 'Washington');
    let pathFinder = new ngraph.path.aStar(graph);
    let path = pathFinder.find('NYC', 'Washington');

anvaka's ngraph.path github