Skip to content

Commit f3b1b82

Browse files
Pixi v7 support and migrated to Extension Scripts (#137)
* migrated to v7 and extension scripts * bringing typedoc back because webdoc blows up * we fixed the tests! 💪 * explaining the noImplicitAny exception * made webdocs work * updated a bit of the readme * deleted example.api.json* * added example.api.json* to gitignore * removed redundant devdeps
1 parent 66dc0ee commit f3b1b82

File tree

391 files changed

+11240
-25253
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

391 files changed

+11240
-25253
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@
77
.DS_Store
88
/*.d.ts
99
.nyc_output
10+
example.api.json*

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ A plugin for PixiJS which provides a runtime for content export using PixiAnimat
66

77
## Running Content
88

9+
### Re-Export your `.fla`
10+
Use this Animate CC plugin https://github.com/pixijs/animate-extension and follow this steps:
11+
1. Install the plugin
12+
1. Open your old `.fla` file
13+
1. Convert to PixiJS Animate (from the File menu), creating a new `.fla` file
14+
1. **From that new `.fla` file** go to publishing settings (from the File menu)
15+
1. Select the V2 format on the first dropdown
16+
1. Export your project, you should have a `.js` file and some folders with it.
17+
18+
**Only things added to the stage will be exported!**
19+
920
### Installing Library
1021

1122
To run content exported with Pixi Animate, you must load the JavaScript library within your project. You can install using [NPM](http://www.npmjs.org) or your package manager of choice:
@@ -17,12 +28,21 @@ npm install @pixi/animate
1728

1829
### Dependencies
1930

20-
* [PixiJS v6](http://pixijs.com) is required
31+
| PixiJS | @pixi/animate |
32+
|---|---|
33+
| v5.x - v6.x | v2.x |
34+
| v7.x | v3.x |
2135

2236
## Documentation
2337

2438
https://pixijs.io/animate/
2539

40+
## Breaking changes from v2.x to v3.x
41+
* Compatibility with PixiJS v7
42+
* This means the library now uses `Assets` to download anything needed.
43+
* Removed V1 export compatibility. Only V2 exports are now compatible.
44+
* Removed tests for V1 assets
45+
2646
## Breaking Changes from v1.3
2747
* DisplayObject, Container, Graphics, Sprite, and Text from PIXI are no longer modified. Instead, subclasses are provided from the library with the same names (or on the PIXI.animate namespace).
2848
* static `extend()` and `e()` methods no longer exist on the display object classes.

0 commit comments

Comments
 (0)