53 lines
1.0 KiB
Markdown
53 lines
1.0 KiB
Markdown
|
# iwmlib
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
Install the following dependencies globally
|
||
|
|
|
||
|
|
`npm i rollup gulp-cli -g`
|
||
|
|
|
||
|
|
and some dependencies locally
|
||
|
|
|
||
|
|
`npm i`
|
||
|
|
|
||
|
|
## Build
|
||
|
|
|
||
|
|
To build the iwmlib files type
|
||
|
|
|
||
|
|
`npm run build`
|
||
|
|
|
||
|
|
The files
|
||
|
|
|
||
|
|
- imwlib.js
|
||
|
|
- iwmlib.pixi.js
|
||
|
|
|
||
|
|
will be generated in the dist folder. If you want to build the files continuously type
|
||
|
|
|
||
|
|
`npm run watch`
|
||
|
|
|
||
|
|
To build the 3rd party library type
|
||
|
|
|
||
|
|
`npm run 3rdparty`
|
||
|
|
|
||
|
|
## Docs
|
||
|
|
|
||
|
|
To create the documentation in the folder ./doc/out type `npm run jsdoc`
|
||
|
|
|
||
|
|
Afterwards you can view the documentation here:
|
||
|
|
|
||
|
|
- The iwmlib [DocTests](./lib/index.html)
|
||
|
|
- The iwmlib [PixiJS DocTests](./lib/pixi/index.html)
|
||
|
|
|
||
|
|
## Useful PixiJS Resources
|
||
|
|
|
||
|
|
Currently using PixiJS version 5
|
||
|
|
|
||
|
|
- The PixiJS [JavaScript API Docs](http://pixijs.download/dev/docs/index.html)
|
||
|
|
- The PixiJS [Examples](http://pixijs.github.io/examples/#/basics/basic.js)
|
||
|
|
- The PixiJS [GitHub Repository](https://github.com/pixijs/pixi.js)
|
||
|
|
|
||
|
|
## List of 3<sup>rd</sup> party libraries included
|
||
|
|
|
||
|
|
- [PixiJS](http://www.pixijs.com)
|
||
|
|
- [Greensock](https://greensock.com) with TweenMax and TimelineMax
|