Giter VIP home page Giter VIP logo

extension-boilerplate's Introduction

PixiJS Extension Boilerplate

This is a simple boilerplate project powered by PixiJS Extension Scripts. It demonstrates how you can create an extension for PixiJS that works with TypeScript, generates all the necessary build files and supports documentation (with webdoc) and unit-testing (with Jest).

Getting Started

This project assumes you are familiar with npm, node.js and package.json files.

npm install
npm run build

Structure

Path Description
./src Folder containing the source code for your extension
./test Folder containing the Jest-based unit-tests (i.e., *.test.ts)
./examples Folder containing any examples to demonstrate usage
./global.d.ts TypeScript global mixins for PixiJS

Publishing

When you're ready to publish your extension and share with the world, run the following command. This will ask you which type of version bump you'd like to do and then do all the necessary steps to build and package your extension.

npm run release

extension-boilerplate's People

Contributors

andrewstart avatar bigtimebuddy avatar dependabot[bot] avatar ivanpopelyshev avatar maxch-aa avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

extension-boilerplate's Issues

how to deal with optional dependencies?

I've added a conditional import (await import('pixi-lights')) in my plugin, but then when I try to build it it says:

'Error: Invalid value for option "output.file" - when building multiple chunks, the "output.dir" option must be used, not "output.file". To inline dynamic imports, set the "inlineDynamicImports" option.'

Is there a good practice on adding optional imports?

PictureSprites don't seem to render on PIXI v4.0.1

I'm trying to use your PictureSprite plugin in order to learn the plugin structure for PIXI version 4.

I have a scene with several sprites that all work perfectly when they are PIXI.Sprite objects. If I change them to PIXI.PictureSprite objects, then nothing is rendered.

There are no error messages in the console, the sprites simply aren't rendering. I can only assume that something is wrong in the PictureRenderer code. Perhaps in the _renderNormal function.

Any help would be greatly appreciated as PIXI 4 is very unfamiliar to me.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.