diff --git a/404.html b/404.html index fa6408a..e08e090 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ Page Not Found | PixiJS AssetPack - + diff --git a/assets/js/d1b06a5a.659195a5.js b/assets/js/d1b06a5a.3cc6f8be.js similarity index 99% rename from assets/js/d1b06a5a.659195a5.js rename to assets/js/d1b06a5a.3cc6f8be.js index 36b8fe6..a16f5d0 100644 --- a/assets/js/d1b06a5a.659195a5.js +++ b/assets/js/d1b06a5a.3cc6f8be.js @@ -1 +1 @@ -"use strict";(self.webpackChunk_assetpack_docs=self.webpackChunk_assetpack_docs||[]).push([[209],{6815:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>a,frontMatter:()=>d,metadata:()=>l,toc:()=>h});var n=s(1085),i=s(1184);const d={sidebar_position:0},r="API Reference",l={id:"guide/configuration",title:"API Reference",description:"AssetPack uses a config file to define what assets you want to optimise and how you want to optimise them. The config file is a JavaScript file that exports an object with the following properties:",source:"@site/docs/guide/configuration.md",sourceDirName:"guide",slug:"/guide/configuration",permalink:"/assetpack/docs/guide/configuration",draft:!1,unlisted:!1,editUrl:"https://github.com/pixijs/assetpack/tree/main/packages/docs/docs/guide/configuration.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{sidebar_position:0},sidebar:"guide",next:{title:"Installation",permalink:"/assetpack/docs/guide/getting-started/installation"}},c={},h=[{value:"entry",id:"entry",level:3},{value:"output",id:"output",level:3},{value:"ignore",id:"ignore",level:3},{value:"cache",id:"cache",level:3},{value:"cacheLocation",id:"cachelocation",level:3},{value:"logLevel",id:"loglevel",level:3},{value:"pipes",id:"pipes",level:3},{value:"assetSettings",id:"assetsettings",level:3},{value:"Example",id:"example",level:4}];function o(e){const t={a:"a",code:"code",h1:"h1",h3:"h3",h4:"h4",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"api-reference",children:"API Reference"}),"\n",(0,n.jsx)(t.p,{children:"AssetPack uses a config file to define what assets you want to optimise and how you want to optimise them. The config file is a JavaScript file that exports an object with the following properties:"}),"\n",(0,n.jsx)(t.h3,{id:"entry",children:"entry"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"Yes"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"The directory where your raw assets are located."}),"\n",(0,n.jsx)(t.h3,{id:"output",children:"output"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"Yes"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"The directory where you want your optimised assets to be outputted to."}),"\n",(0,n.jsx)(t.h3,{id:"ignore",children:"ignore"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string[]"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"An optional array of ignore patterns. Any file path matching the patterns will not be processed by assetpack."}),"\n",(0,n.jsx)(t.h3,{id:"cache",children:"cache"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"boolean"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"true"})}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"An optional boolean to enable or disable caching."}),"\n",(0,n.jsx)(t.h3,{id:"cachelocation",children:"cacheLocation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"'.assetpack'"})}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"An optional string to set the location of the cache."}),"\n",(0,n.jsx)(t.h3,{id:"loglevel",children:"logLevel"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"'info'"})}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"An optional string to set the log level."}),"\n",(0,n.jsx)(t.h3,{id:"pipes",children:"pipes"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"Plugin[]"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsxs)(t.p,{children:["An array of pipes to use. For examples of pipes, see ",(0,n.jsx)(t.a,{href:"/docs/guide/pipes/overview#plugins",children:"Plugins"}),"."]}),"\n",(0,n.jsx)(t.h3,{id:"assetsettings",children:"assetSettings"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"AssetSetting[]"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Property"}),(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"files"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"settings"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"object"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"No"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"metaData"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"object"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"No"})]})]})]}),"\n",(0,n.jsx)(t.p,{children:"An optional array of asset settings. This allows you to set specific settings for individual assets."}),"\n",(0,n.jsx)(t.h4,{id:"example",children:"Example"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-js",children:"// .assetpack.js\n\nexport default {\n entry: './raw-assets',\n output: './public',\n ignore: ['**/*.html'],\n cache: true,\n cacheLocation: '.assetpack',\n logLevel: 'info',\n pipes: [\n // Pipes go here\n ],\n assetSettings: [\n {\n files: ['**/*.png'],\n settings: {\n compress: {\n jpg: true,\n png: true,\n // all png files will be compressed to avif format but not webp\n webp: false,\n avif: true,\n },\n },\n },\n ],\n};\n"})})]})}function a(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},1184:(e,t,s)=>{s.d(t,{R:()=>r,x:()=>l});var n=s(4041);const i={},d=n.createContext(i);function r(e){const t=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),n.createElement(d.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunk_assetpack_docs=self.webpackChunk_assetpack_docs||[]).push([[209],{6815:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>a,frontMatter:()=>d,metadata:()=>l,toc:()=>h});var n=s(1085),i=s(1184);const d={sidebar_position:0},r="API Reference",l={id:"guide/configuration",title:"API Reference",description:"AssetPack uses a config file to define what assets you want to optimise and how you want to optimise them. The config file is a JavaScript file that exports an object with the following properties:",source:"@site/docs/guide/configuration.md",sourceDirName:"guide",slug:"/guide/configuration",permalink:"/assetpack/docs/guide/configuration",draft:!1,unlisted:!1,editUrl:"https://github.com/pixijs/assetpack/tree/main/packages/docs/docs/guide/configuration.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{sidebar_position:0},sidebar:"guide",next:{title:"Installation",permalink:"/assetpack/docs/guide/getting-started/installation"}},c={},h=[{value:"entry",id:"entry",level:3},{value:"output",id:"output",level:3},{value:"ignore",id:"ignore",level:3},{value:"cache",id:"cache",level:3},{value:"cacheLocation",id:"cachelocation",level:3},{value:"logLevel",id:"loglevel",level:3},{value:"pipes",id:"pipes",level:3},{value:"assetSettings",id:"assetsettings",level:3},{value:"Example",id:"example",level:4}];function o(e){const t={a:"a",code:"code",h1:"h1",h3:"h3",h4:"h4",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"api-reference",children:"API Reference"}),"\n",(0,n.jsx)(t.p,{children:"AssetPack uses a config file to define what assets you want to optimise and how you want to optimise them. The config file is a JavaScript file that exports an object with the following properties:"}),"\n",(0,n.jsx)(t.h3,{id:"entry",children:"entry"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"Yes"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"The directory where your raw assets are located."}),"\n",(0,n.jsx)(t.h3,{id:"output",children:"output"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"Yes"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"The directory where you want your optimised assets to be outputted to."}),"\n",(0,n.jsx)(t.h3,{id:"ignore",children:"ignore"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string[]"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"An optional array of ignore patterns. Any file path matching the patterns will not be processed by AssetPack."}),"\n",(0,n.jsx)(t.h3,{id:"cache",children:"cache"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"boolean"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"true"})}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"An optional boolean to enable or disable caching."}),"\n",(0,n.jsx)(t.h3,{id:"cachelocation",children:"cacheLocation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"'.assetpack'"})}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"An optional string to set the location of the cache."}),"\n",(0,n.jsx)(t.h3,{id:"loglevel",children:"logLevel"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"'info'"})}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsx)(t.p,{children:"An optional string to set the log level."}),"\n",(0,n.jsx)(t.h3,{id:"pipes",children:"pipes"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"Plugin[]"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsxs)(t.p,{children:["An array of pipes to use. For examples of pipes, see ",(0,n.jsx)(t.a,{href:"/docs/guide/pipes/overview#plugins",children:"Plugins"}),"."]}),"\n",(0,n.jsx)(t.h3,{id:"assetsettings",children:"assetSettings"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"AssetSetting[]"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"No"})]})})]}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Property"}),(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"files"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"settings"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"object"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"No"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"metaData"}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"object"})}),(0,n.jsx)(t.td,{}),(0,n.jsx)(t.td,{children:"No"})]})]})]}),"\n",(0,n.jsx)(t.p,{children:"An optional array of asset settings. This allows you to set specific settings for individual assets."}),"\n",(0,n.jsx)(t.h4,{id:"example",children:"Example"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-js",children:"// .assetpack.js\n\nexport default {\n entry: './raw-assets',\n output: './public',\n ignore: ['**/*.html'],\n cache: true,\n cacheLocation: '.assetpack',\n logLevel: 'info',\n pipes: [\n // Pipes go here\n ],\n assetSettings: [\n {\n files: ['**/*.png'],\n settings: {\n compress: {\n jpg: true,\n png: true,\n // all png files will be compressed to avif format but not webp\n webp: false,\n avif: true,\n },\n },\n },\n ],\n};\n"})})]})}function a(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},1184:(e,t,s)=>{s.d(t,{R:()=>r,x:()=>l});var n=s(4041);const i={},d=n.createContext(i);function r(e){const t=n.useContext(d);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),n.createElement(d.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/db621ceb.45c909b2.js b/assets/js/db621ceb.45c909b2.js new file mode 100644 index 0000000..3665549 --- /dev/null +++ b/assets/js/db621ceb.45c909b2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_assetpack_docs=self.webpackChunk_assetpack_docs||[]).push([[656],{8524:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var i=s(1085),n=s(1184);const o={sidebar_position:1,title:"Installation"},a=void 0,r={id:"guide/getting-started/installation",title:"Installation",description:"Overview",source:"@site/docs/guide/getting-started/installation.mdx",sourceDirName:"guide/getting-started",slug:"/guide/getting-started/installation",permalink:"/assetpack/docs/guide/getting-started/installation",draft:!1,unlisted:!1,editUrl:"https://github.com/pixijs/assetpack/tree/main/packages/docs/docs/guide/getting-started/installation.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1,title:"Installation"},sidebar:"guide",previous:{title:"API Reference",permalink:"/assetpack/docs/guide/configuration"},next:{title:"Pixi",permalink:"/assetpack/docs/guide/getting-started/pixi"}},c={},l=[{value:"Overview",id:"overview",level:2},{value:"Installation",id:"installation",level:2},{value:"Setup",id:"setup",level:2},{value:"PixiJS Setup",id:"pixijs-setup",level:3},{value:"Why AssetPack?",id:"why-assetpack",level:2}];function d(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,i.jsx)(t.p,{children:"AssetPack is a tool for optimising assets for the web. It can be used to transform, combine, compress assets.\nAny asset that you want to transform or optimise into something else can be done with AssetPack."}),"\n",(0,i.jsx)(t.p,{children:"AssetPack is framework agnostic, and can be used with any framework you like, such as PixiJS, Threejs, Phaser, etc.\nIt uses a plugin based system to allow you to create your own plugins to do whatever you want with your assets."}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"installation",children:"Installation"}),"\n",(0,i.jsxs)(t.p,{children:["To install AssetPack, you need to install the ",(0,i.jsx)(t.code,{children:"@assetpack/core"})," package."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-bash",children:"npm install --save-dev @assetpack/core\n"})}),"\n",(0,i.jsx)(t.admonition,{title:"COMPATIBILITY NOTE",type:"info",children:(0,i.jsxs)(t.p,{children:["AssetPack requires ",(0,i.jsx)(t.a,{href:"https://nodejs.org/en/",children:"Node.js"})," version 20+, please upgrade if your package manager warns about it."]})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"setup",children:"Setup"}),"\n",(0,i.jsx)(t.p,{children:"To set up AssetPack, you need to create a configuration file that defines what assets you want to optimise and how you want to optimise them."}),"\n",(0,i.jsxs)(t.p,{children:["First create a ",(0,i.jsx)(t.code,{children:".assetpack.js"})," file in the root of your project. This file should export an object with the following properties:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"// .assetpack.js\nimport { compress } from '@assetpack/core';\n\nexport default {\n entry: './raw-assets',\n output: './public/assets',\n pipes: [],\n};\n"})}),"\n",(0,i.jsxs)(t.p,{children:["To see the full list of configuration options, see the ",(0,i.jsx)(t.a,{href:"/docs/guide/configuration",children:"Configuration"})," page."]}),"\n",(0,i.jsx)(t.p,{children:"Then to run AssetPack, you can use the CLI, run programatically, or use a build tool like Vite."}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/docs/guide/getting-started/cli",children:"CLI"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/docs/guide/getting-started/programmatic",children:"Programmatic"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/docs/guide/getting-started/vite",children:"Vite"})}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["AssetPack has a number of built-in pipes for you to use, to see the full list of pipes, see the ",(0,i.jsx)(t.a,{href:"/docs/guide/pipes/overview",children:"Pipes"})," page."]}),"\n",(0,i.jsx)(t.h3,{id:"pixijs-setup",children:"PixiJS Setup"}),"\n",(0,i.jsxs)(t.p,{children:["If you are using AssetPack with PixiJS, you can use the ",(0,i.jsx)(t.code,{children:"pixiPipes"})," function to add a pre-configured set of pipes, with an opinionated set of defaults for PixiJS."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"// .assetpack.js\nimport { compress, pixiPipes } from '@assetpack/core';\n\nexport default {\n entry: './raw-assets',\n output: './public/assets',\n pipes: [\n ...pixiPipes({\n // PixiJS configuration options\n }),\n ],\n};\n"})}),"\n",(0,i.jsxs)(t.p,{children:["To see how to configure the PixiJS pipes, see the ",(0,i.jsx)(t.a,{href:"/docs/guide/getting-started/pixi",children:"PixiJS Configuration"})," page."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"why-assetpack",children:"Why AssetPack?"}),"\n",(0,i.jsxs)(t.p,{children:["AssetPack was designed to solve the problem of having assets come in many different formats, and having to convert them into a format that is suitable for your game.\nFor example, you might have been given an audio file, e.g. ",(0,i.jsx)(t.code,{children:"music.wav"}),", to be put in your game, but to get the best coverage across browsers, you need to convert it\ninto an ",(0,i.jsx)(t.code,{children:"ogg"})," and ",(0,i.jsx)(t.code,{children:"mp3"})," file. AssetPack can do this for you, and you can even compress the audio file to reduce the size of the file."]}),"\n",(0,i.jsx)(t.p,{children:"AssetPack can also be used to combine multiple images into a single sprite sheet, or to generate multiple sizes of an image. This can be useful if you want\nto support different screen sizes, or if you want to reduce the number of HTTP requests your game makes."})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1184:(e,t,s)=>{s.d(t,{R:()=>a,x:()=>r});var i=s(4041);const n={},o=i.createContext(n);function a(e){const t=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/db621ceb.85358d4b.js b/assets/js/db621ceb.85358d4b.js deleted file mode 100644 index fbd4aa5..0000000 --- a/assets/js/db621ceb.85358d4b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunk_assetpack_docs=self.webpackChunk_assetpack_docs||[]).push([[656],{8524:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var i=s(1085),n=s(1184);const o={sidebar_position:1,title:"Installation"},a=void 0,r={id:"guide/getting-started/installation",title:"Installation",description:"Overview",source:"@site/docs/guide/getting-started/installation.mdx",sourceDirName:"guide/getting-started",slug:"/guide/getting-started/installation",permalink:"/assetpack/docs/guide/getting-started/installation",draft:!1,unlisted:!1,editUrl:"https://github.com/pixijs/assetpack/tree/main/packages/docs/docs/guide/getting-started/installation.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1,title:"Installation"},sidebar:"guide",previous:{title:"API Reference",permalink:"/assetpack/docs/guide/configuration"},next:{title:"Pixi",permalink:"/assetpack/docs/guide/getting-started/pixi"}},c={},l=[{value:"Overview",id:"overview",level:2},{value:"Installation",id:"installation",level:2},{value:"Setup",id:"setup",level:2},{value:"PixiJS Setup",id:"pixijs-setup",level:3},{value:"Why AssetPack?",id:"why-assetpack",level:2}];function d(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,n.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,i.jsx)(t.p,{children:"AssetPack is a tool for optimising assets for the web. It can be used to transform, combine, compress assets.\nAny asset that you want to transform or optimise into something else can be done with AssetPack."}),"\n",(0,i.jsx)(t.p,{children:"AssetPack is framework agnostic, and can be used with any framework you like, such as PixiJS, Threejs, Phaser, etc.\nIt uses a plugin based system to allow you to create your own plugins to do whatever you want with your assets."}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"installation",children:"Installation"}),"\n",(0,i.jsxs)(t.p,{children:["To install AssetPack, you need to install the ",(0,i.jsx)(t.code,{children:"assetpack"})," package."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-bash",children:"npm install --save-dev assetpack\n"})}),"\n",(0,i.jsx)(t.admonition,{title:"COMPATIBILITY NOTE",type:"info",children:(0,i.jsxs)(t.p,{children:["AssetPack requires ",(0,i.jsx)(t.a,{href:"https://nodejs.org/en/",children:"Node.js"})," version 20+, please upgrade if your package manager warns about it."]})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"setup",children:"Setup"}),"\n",(0,i.jsx)(t.p,{children:"To set up AssetPack, you need to create a configuration file that defines what assets you want to optimise and how you want to optimise them."}),"\n",(0,i.jsxs)(t.p,{children:["First create a ",(0,i.jsx)(t.code,{children:".assetpack.js"})," file in the root of your project. This file should export an object with the following properties:"]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"// .assetpack.js\nimport { compress } from '@assetpack/core';\n\nexport default {\n entry: './raw-assets',\n output: './public/assets',\n pipes: [],\n};\n"})}),"\n",(0,i.jsxs)(t.p,{children:["To see the full list of configuration options, see the ",(0,i.jsx)(t.a,{href:"/docs/guide/configuration",children:"Configuration"})," page."]}),"\n",(0,i.jsx)(t.p,{children:"Then to run AssetPack, you can use the CLI, run programatically, or use a build tool like Vite."}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/docs/guide/getting-started/cli",children:"CLI"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/docs/guide/getting-started/programmatic",children:"Programmatic"})}),"\n",(0,i.jsx)(t.li,{children:(0,i.jsx)(t.a,{href:"/docs/guide/getting-started/vite",children:"Vite"})}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["AssetPack has a number of built-in pipes for you to use, to see the full list of pipes, see the ",(0,i.jsx)(t.a,{href:"/docs/guide/pipes/overview",children:"Pipes"})," page."]}),"\n",(0,i.jsx)(t.h3,{id:"pixijs-setup",children:"PixiJS Setup"}),"\n",(0,i.jsxs)(t.p,{children:["If you are using AssetPack with PixiJS, you can use the ",(0,i.jsx)(t.code,{children:"pixiPipes"})," function to add a pre-configured set of pipes, with an opinionated set of defaults for PixiJS."]}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-js",children:"// .assetpack.js\nimport { compress, pixiPipes } from '@assetpack/core';\n\nexport default {\n entry: './raw-assets',\n output: './public/assets',\n pipes: [\n ...pixiPipes({\n // PixiJS configuration options\n }),\n ],\n};\n"})}),"\n",(0,i.jsxs)(t.p,{children:["To see how to configure the PixiJS pipes, see the ",(0,i.jsx)(t.a,{href:"/docs/guide/getting-started/pixi",children:"PixiJS Configuration"})," page."]}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h2,{id:"why-assetpack",children:"Why AssetPack?"}),"\n",(0,i.jsxs)(t.p,{children:["AssetPack was designed to solve the problem of having assets come in many different formats, and having to convert them into a format that is suitable for your game.\nFor example, you might have been given an audio file, e.g. ",(0,i.jsx)(t.code,{children:"music.wav"}),", to be put in your game, but to get the best coverage across browsers, you need to convert it\ninto an ",(0,i.jsx)(t.code,{children:"ogg"})," and ",(0,i.jsx)(t.code,{children:"mp3"})," file. AssetPack can do this for you, and you can even compress the audio file to reduce the size of the file."]}),"\n",(0,i.jsx)(t.p,{children:"AssetPack can also be used to combine multiple images into a single sprite sheet, or to generate multiple sizes of an image. This can be useful if you want\nto support different screen sizes, or if you want to reduce the number of HTTP requests your game makes."})]})}function u(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1184:(e,t,s)=>{s.d(t,{R:()=>a,x:()=>r});var i=s(4041);const n={},o=i.createContext(n);function a(e){const t=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.7fd91906.js b/assets/js/runtime~main.dfb0156c.js similarity index 97% rename from assets/js/runtime~main.7fd91906.js rename to assets/js/runtime~main.dfb0156c.js index 8d3a4f7..0ba3879 100644 --- a/assets/js/runtime~main.7fd91906.js +++ b/assets/js/runtime~main.dfb0156c.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,t,r,o,c={},d={};function n(e){var a=d[e];if(void 0!==a)return a.exports;var t=d[e]={id:e,loaded:!1,exports:{}};return c[e].call(t.exports,t,t.exports,n),t.loaded=!0,t.exports}n.m=c,n.c=d,e=[],n.O=(a,t,r,o)=>{if(!t){var c=1/0;for(b=0;b=o)&&Object.keys(n.O).every((e=>n.O[e](t[f])))?t.splice(f--,1):(d=!1,o0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[t,r,o]},n.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return n.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,n.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);n.r(o);var c={};a=a||[null,t({}),t([]),t(t)];for(var d=2&r&&e;"object"==typeof d&&!~a.indexOf(d);d=t(d))Object.getOwnPropertyNames(d).forEach((a=>c[a]=()=>e[a]));return c.default=()=>e,n.d(o,c),o},n.d=(e,a)=>{for(var t in a)n.o(a,t)&&!n.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},n.f={},n.e=e=>Promise.all(Object.keys(n.f).reduce(((a,t)=>(n.f[t](e,a),a)),[])),n.u=e=>"assets/js/"+({32:"20afc2dc",48:"a94703ab",52:"630ae0ca",57:"fda6100f",66:"7cda97f4",98:"a7bd4aaa",102:"4adb629a",209:"d1b06a5a",235:"a7456010",265:"266fa2e8",305:"70ec74b8",325:"b74b7fc7",401:"17896441",434:"834155da",467:"f48ae691",493:"8a2dc6a5",583:"1df93b7f",647:"5e95c892",656:"db621ceb",680:"f8149d38",718:"89fdc11e",723:"389bb716",742:"aba21aa0",791:"d2935333",996:"7bd36867"}[e]||e)+"."+{32:"d8d1b5ce",48:"3258a9f4",52:"916142f6",57:"0da90b37",66:"9bb8ba65",98:"01747834",102:"0fad12cb",104:"951359f6",209:"659195a5",235:"0ad34696",265:"04eb9fef",305:"7dad4e33",325:"487a2f30",401:"fd7f1573",434:"ace50864",467:"7a13d1cc",493:"132a5a2a",583:"6f34c7d3",647:"e8071e30",656:"85358d4b",680:"22640905",718:"0a92ee9b",723:"be20734f",742:"611c27b4",791:"81b3dd0e",996:"1c51c42e"}[e]+".js",n.miniCssF=e=>{},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),n.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},o="@assetpack/docs:",n.l=(e,a,t,c)=>{if(r[e])r[e].push(a);else{var d,f;if(void 0!==t)for(var i=document.getElementsByTagName("script"),b=0;b{d.onerror=d.onload=null,clearTimeout(l);var o=r[e];if(delete r[e],d.parentNode&&d.parentNode.removeChild(d),o&&o.forEach((e=>e(t))),a)return a(t)},l=setTimeout(u.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=u.bind(null,d.onerror),d.onload=u.bind(null,d.onload),f&&document.head.appendChild(d)}},n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.p="/assetpack/",n.gca=function(e){return e={17896441:"401","20afc2dc":"32",a94703ab:"48","630ae0ca":"52",fda6100f:"57","7cda97f4":"66",a7bd4aaa:"98","4adb629a":"102",d1b06a5a:"209",a7456010:"235","266fa2e8":"265","70ec74b8":"305",b74b7fc7:"325","834155da":"434",f48ae691:"467","8a2dc6a5":"493","1df93b7f":"583","5e95c892":"647",db621ceb:"656",f8149d38:"680","89fdc11e":"718","389bb716":"723",aba21aa0:"742",d2935333:"791","7bd36867":"996"}[e]||e,n.p+n.u(e)},(()=>{var e={354:0,869:0};n.f.j=(a,t)=>{var r=n.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(354|869)$/.test(a))e[a]=0;else{var o=new Promise(((t,o)=>r=e[a]=[t,o]));t.push(r[2]=o);var c=n.p+n.u(a),d=new Error;n.l(c,(t=>{if(n.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var o=t&&("load"===t.type?"missing":t.type),c=t&&t.target&&t.target.src;d.message="Loading chunk "+a+" failed.\n("+o+": "+c+")",d.name="ChunkLoadError",d.type=o,d.request=c,r[1](d)}}),"chunk-"+a,a)}},n.O.j=a=>0===e[a];var a=(a,t)=>{var r,o,c=t[0],d=t[1],f=t[2],i=0;if(c.some((a=>0!==e[a]))){for(r in d)n.o(d,r)&&(n.m[r]=d[r]);if(f)var b=f(n)}for(a&&a(t);i{"use strict";var e,a,t,r,o,c={},d={};function n(e){var a=d[e];if(void 0!==a)return a.exports;var t=d[e]={id:e,loaded:!1,exports:{}};return c[e].call(t.exports,t,t.exports,n),t.loaded=!0,t.exports}n.m=c,n.c=d,e=[],n.O=(a,t,r,o)=>{if(!t){var c=1/0;for(b=0;b=o)&&Object.keys(n.O).every((e=>n.O[e](t[f])))?t.splice(f--,1):(d=!1,o0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[t,r,o]},n.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return n.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,n.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);n.r(o);var c={};a=a||[null,t({}),t([]),t(t)];for(var d=2&r&&e;"object"==typeof d&&!~a.indexOf(d);d=t(d))Object.getOwnPropertyNames(d).forEach((a=>c[a]=()=>e[a]));return c.default=()=>e,n.d(o,c),o},n.d=(e,a)=>{for(var t in a)n.o(a,t)&&!n.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},n.f={},n.e=e=>Promise.all(Object.keys(n.f).reduce(((a,t)=>(n.f[t](e,a),a)),[])),n.u=e=>"assets/js/"+({32:"20afc2dc",48:"a94703ab",52:"630ae0ca",57:"fda6100f",66:"7cda97f4",98:"a7bd4aaa",102:"4adb629a",209:"d1b06a5a",235:"a7456010",265:"266fa2e8",305:"70ec74b8",325:"b74b7fc7",401:"17896441",434:"834155da",467:"f48ae691",493:"8a2dc6a5",583:"1df93b7f",647:"5e95c892",656:"db621ceb",680:"f8149d38",718:"89fdc11e",723:"389bb716",742:"aba21aa0",791:"d2935333",996:"7bd36867"}[e]||e)+"."+{32:"d8d1b5ce",48:"3258a9f4",52:"916142f6",57:"0da90b37",66:"9bb8ba65",98:"01747834",102:"0fad12cb",104:"951359f6",209:"3cc6f8be",235:"0ad34696",265:"04eb9fef",305:"7dad4e33",325:"487a2f30",401:"fd7f1573",434:"ace50864",467:"7a13d1cc",493:"132a5a2a",583:"6f34c7d3",647:"e8071e30",656:"45c909b2",680:"22640905",718:"0a92ee9b",723:"be20734f",742:"611c27b4",791:"81b3dd0e",996:"1c51c42e"}[e]+".js",n.miniCssF=e=>{},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),n.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},o="@assetpack/docs:",n.l=(e,a,t,c)=>{if(r[e])r[e].push(a);else{var d,f;if(void 0!==t)for(var i=document.getElementsByTagName("script"),b=0;b{d.onerror=d.onload=null,clearTimeout(l);var o=r[e];if(delete r[e],d.parentNode&&d.parentNode.removeChild(d),o&&o.forEach((e=>e(t))),a)return a(t)},l=setTimeout(u.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=u.bind(null,d.onerror),d.onload=u.bind(null,d.onload),f&&document.head.appendChild(d)}},n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.p="/assetpack/",n.gca=function(e){return e={17896441:"401","20afc2dc":"32",a94703ab:"48","630ae0ca":"52",fda6100f:"57","7cda97f4":"66",a7bd4aaa:"98","4adb629a":"102",d1b06a5a:"209",a7456010:"235","266fa2e8":"265","70ec74b8":"305",b74b7fc7:"325","834155da":"434",f48ae691:"467","8a2dc6a5":"493","1df93b7f":"583","5e95c892":"647",db621ceb:"656",f8149d38:"680","89fdc11e":"718","389bb716":"723",aba21aa0:"742",d2935333:"791","7bd36867":"996"}[e]||e,n.p+n.u(e)},(()=>{var e={354:0,869:0};n.f.j=(a,t)=>{var r=n.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(354|869)$/.test(a))e[a]=0;else{var o=new Promise(((t,o)=>r=e[a]=[t,o]));t.push(r[2]=o);var c=n.p+n.u(a),d=new Error;n.l(c,(t=>{if(n.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var o=t&&("load"===t.type?"missing":t.type),c=t&&t.target&&t.target.src;d.message="Loading chunk "+a+" failed.\n("+o+": "+c+")",d.name="ChunkLoadError",d.type=o,d.request=c,r[1](d)}}),"chunk-"+a,a)}},n.O.j=a=>0===e[a];var a=(a,t)=>{var r,o,c=t[0],d=t[1],f=t[2],i=0;if(c.some((a=>0!==e[a]))){for(r in d)n.o(d,r)&&(n.m[r]=d[r]);if(f)var b=f(n)}for(a&&a(t);i API Reference | PixiJS AssetPack - + @@ -18,7 +18,7 @@

outputignore​

TypeDefaultRequired
string[]No
-

An optional array of ignore patterns. Any file path matching the patterns will not be processed by assetpack.

+

An optional array of ignore patterns. Any file path matching the patterns will not be processed by AssetPack.

cache​

TypeDefaultRequired
booleantrueNo

An optional boolean to enable or disable caching.

diff --git a/docs/guide/getting-started/cli/index.html b/docs/guide/getting-started/cli/index.html index 61ff390..62b6389 100644 --- a/docs/guide/getting-started/cli/index.html +++ b/docs/guide/getting-started/cli/index.html @@ -4,7 +4,7 @@ CLI | PixiJS AssetPack - + diff --git a/docs/guide/getting-started/github-action/index.html b/docs/guide/getting-started/github-action/index.html index 72bceae..f7de9ab 100644 --- a/docs/guide/getting-started/github-action/index.html +++ b/docs/guide/getting-started/github-action/index.html @@ -4,7 +4,7 @@ Github Action | PixiJS AssetPack - + diff --git a/docs/guide/getting-started/installation/index.html b/docs/guide/getting-started/installation/index.html index 0828c1a..5f1431e 100644 --- a/docs/guide/getting-started/installation/index.html +++ b/docs/guide/getting-started/installation/index.html @@ -4,7 +4,7 @@ Installation | PixiJS AssetPack - + @@ -15,8 +15,8 @@ It uses a plugin based system to allow you to create your own plugins to do whatever you want with your assets.

Installation​

-

To install AssetPack, you need to install the assetpack package.

-
npm install --save-dev assetpack
+

To install AssetPack, you need to install the @assetpack/core package.

+
npm install --save-dev @assetpack/core
COMPATIBILITY NOTE

AssetPack requires Node.js version 20+, please upgrade if your package manager warns about it.

Setup​

diff --git a/docs/guide/getting-started/pixi/index.html b/docs/guide/getting-started/pixi/index.html index 3223d09..33a4a36 100644 --- a/docs/guide/getting-started/pixi/index.html +++ b/docs/guide/getting-started/pixi/index.html @@ -4,7 +4,7 @@ Pixi | PixiJS AssetPack - + diff --git a/docs/guide/getting-started/programmatic/index.html b/docs/guide/getting-started/programmatic/index.html index 4f0bf4b..d2663c7 100644 --- a/docs/guide/getting-started/programmatic/index.html +++ b/docs/guide/getting-started/programmatic/index.html @@ -4,7 +4,7 @@ Programmatic | PixiJS AssetPack - + diff --git a/docs/guide/getting-started/vite/index.html b/docs/guide/getting-started/vite/index.html index 587e392..9272346 100644 --- a/docs/guide/getting-started/vite/index.html +++ b/docs/guide/getting-started/vite/index.html @@ -4,7 +4,7 @@ Vite | PixiJS AssetPack - + diff --git a/docs/guide/pipes/cache-buster/index.html b/docs/guide/pipes/cache-buster/index.html index 55aaeb2..45ab6f1 100644 --- a/docs/guide/pipes/cache-buster/index.html +++ b/docs/guide/pipes/cache-buster/index.html @@ -4,7 +4,7 @@ Cache Buster | PixiJS AssetPack - + diff --git a/docs/guide/pipes/compress/index.html b/docs/guide/pipes/compress/index.html index 86db75b..93b9b59 100644 --- a/docs/guide/pipes/compress/index.html +++ b/docs/guide/pipes/compress/index.html @@ -4,7 +4,7 @@ Compression | PixiJS AssetPack - + diff --git a/docs/guide/pipes/ffmpeg/index.html b/docs/guide/pipes/ffmpeg/index.html index 80b8683..19cd039 100644 --- a/docs/guide/pipes/ffmpeg/index.html +++ b/docs/guide/pipes/ffmpeg/index.html @@ -4,7 +4,7 @@ Audio & FFmpeg | PixiJS AssetPack - + diff --git a/docs/guide/pipes/json/index.html b/docs/guide/pipes/json/index.html index f9437d0..3734e0b 100644 --- a/docs/guide/pipes/json/index.html +++ b/docs/guide/pipes/json/index.html @@ -4,7 +4,7 @@ JSON | PixiJS AssetPack - + diff --git a/docs/guide/pipes/manifest/index.html b/docs/guide/pipes/manifest/index.html index 194fe54..108c9fc 100644 --- a/docs/guide/pipes/manifest/index.html +++ b/docs/guide/pipes/manifest/index.html @@ -4,7 +4,7 @@ Manifest | PixiJS AssetPack - + diff --git a/docs/guide/pipes/mipmap/index.html b/docs/guide/pipes/mipmap/index.html index 6140acf..894513f 100644 --- a/docs/guide/pipes/mipmap/index.html +++ b/docs/guide/pipes/mipmap/index.html @@ -4,7 +4,7 @@ Mipmaps | PixiJS AssetPack - + diff --git a/docs/guide/pipes/overview/index.html b/docs/guide/pipes/overview/index.html index 51714ca..d971d3f 100644 --- a/docs/guide/pipes/overview/index.html +++ b/docs/guide/pipes/overview/index.html @@ -4,7 +4,7 @@ Overview | PixiJS AssetPack - + diff --git a/docs/guide/pipes/spine/index.html b/docs/guide/pipes/spine/index.html index 560d613..6a8f9da 100644 --- a/docs/guide/pipes/spine/index.html +++ b/docs/guide/pipes/spine/index.html @@ -4,7 +4,7 @@ Spine | PixiJS AssetPack - + diff --git a/docs/guide/pipes/texture-packer/index.html b/docs/guide/pipes/texture-packer/index.html index 46e8fb5..92c10f9 100644 --- a/docs/guide/pipes/texture-packer/index.html +++ b/docs/guide/pipes/texture-packer/index.html @@ -4,7 +4,7 @@ TexturePacker | PixiJS AssetPack - + diff --git a/docs/guide/pipes/webfont/index.html b/docs/guide/pipes/webfont/index.html index d78d1d0..5b05053 100644 --- a/docs/guide/pipes/webfont/index.html +++ b/docs/guide/pipes/webfont/index.html @@ -4,7 +4,7 @@ Webfonts | PixiJS AssetPack - + diff --git a/index.html b/index.html index 1de210d..6933a96 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ PixiJS AssetPack | PixiJS AssetPack - +