From 4fb3f54b456594a357b4547134487fff7fe87526 Mon Sep 17 00:00:00 2001 From: Zyie <24736175+Zyie@users.noreply.github.com> Date: Wed, 8 Jan 2025 14:21:09 +0000 Subject: [PATCH] update and add website docs --- README.md | 2 +- docs/docs/guide/installation.mdx | 8 ++++++++ src/index.ts | 19 +++++++++++++------ .../LICENSE | 0 .../README.md | 0 .../_gitignore | 0 .../examples/index.html | 0 .../package.json | 6 +++--- .../src/__tests__/Rectangle.test.ts | 0 .../src/index.ts | 0 .../tsconfig.json | 0 11 files changed, 25 insertions(+), 10 deletions(-) rename templates/{template-creation-extension => template-extension-default}/LICENSE (100%) rename templates/{template-creation-extension => template-extension-default}/README.md (100%) rename templates/{template-creation-extension => template-extension-default}/_gitignore (100%) rename templates/{template-creation-extension => template-extension-default}/examples/index.html (100%) rename templates/{template-creation-extension => template-extension-default}/package.json (83%) rename templates/{template-creation-extension => template-extension-default}/src/__tests__/Rectangle.test.ts (100%) rename templates/{template-creation-extension => template-extension-default}/src/index.ts (100%) rename templates/{template-creation-extension => template-extension-default}/tsconfig.json (100%) diff --git a/README.md b/README.md index 87d853b..d0f4246 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Currently supported template presets include: - `bundler-esbuild` - `bundler-import-map` - `creation-web` -- `creation-extension` +- `extension-default` You can use `.` for the project name to scaffold in the current directory. diff --git a/docs/docs/guide/installation.mdx b/docs/docs/guide/installation.mdx index e741298..3f47d22 100644 --- a/docs/docs/guide/installation.mdx +++ b/docs/docs/guide/installation.mdx @@ -63,6 +63,13 @@ Currently supported creation templates include: - **[Facebook Template](https://www.facebook.com/fbgaminghome/developers)**: Create apps for Facebook Instant Games. - **[YouTube Template](https://developers.google.com/youtube/gaming/playables/reference/sdk)**: Develop YouTube Playables. +## Extension Templates + +Extension templates are designed for creating libraries and plugins that enhance PixiJS functionality, such as custom filters or plugins that introduce new features. + +These templates leverage [PixiJS ExtensionScript](https://github.com/pixijs/extension-scripts), a CLI tool that simplifies the development process for building PixiJS-compatible extensions. To get the most out of this tool, we recommend reviewing the ExtensionScript documentation. + +These templates are best suited for experienced developers familiar with PixiJS and common development toolchains. ## Advanced Usage @@ -91,6 +98,7 @@ You can use `.` for the project name to scaffold in the current directory. - `bundler-esbuild` - `bundler-import-map` - `creation-web` +- `extension-default` ## License diff --git a/src/index.ts b/src/index.ts index 22bddda..dcc03af 100644 --- a/src/index.ts +++ b/src/index.ts @@ -37,7 +37,7 @@ ${blueBright('Webpack: bundler-webpack' )} ${yellow ('esbuild: bundler-esbuild' )} ${green ('Import Map: bundler-import-map' )} ${cyan ('Web Creation App: creation-web' )} -${blueBright('Extension: creaction-extension' )} +${blueBright('Extension: extension-default' )} Coming soon: ${blue ('Discord Creation App: creation-discord' )} @@ -96,11 +96,6 @@ const FRAMEWORKS: Framework[] = [ display: "Web", color: yellow, }, - { - name: "creation-extension", - display: "Extension", - color: blueBright, - }, // { // name: "creation-discord", // display: "Discord", @@ -118,6 +113,18 @@ const FRAMEWORKS: Framework[] = [ // }, ], }, + { + name: "extension", + display: "Extension", + color: blueBright, + variants: [ + { + name: "extension-default", + display: "Default", + color: blue, + }, + ], + }, ]; const TEMPLATES = FRAMEWORKS.map( diff --git a/templates/template-creation-extension/LICENSE b/templates/template-extension-default/LICENSE similarity index 100% rename from templates/template-creation-extension/LICENSE rename to templates/template-extension-default/LICENSE diff --git a/templates/template-creation-extension/README.md b/templates/template-extension-default/README.md similarity index 100% rename from templates/template-creation-extension/README.md rename to templates/template-extension-default/README.md diff --git a/templates/template-creation-extension/_gitignore b/templates/template-extension-default/_gitignore similarity index 100% rename from templates/template-creation-extension/_gitignore rename to templates/template-extension-default/_gitignore diff --git a/templates/template-creation-extension/examples/index.html b/templates/template-extension-default/examples/index.html similarity index 100% rename from templates/template-creation-extension/examples/index.html rename to templates/template-extension-default/examples/index.html diff --git a/templates/template-creation-extension/package.json b/templates/template-extension-default/package.json similarity index 83% rename from templates/template-creation-extension/package.json rename to templates/template-extension-default/package.json index 3af5663..5114b18 100644 --- a/templates/template-creation-extension/package.json +++ b/templates/template-extension-default/package.json @@ -1,5 +1,5 @@ { - "name": "template-creation-extension", + "name": "template-extension", "version": "1.0.0", "description": "[Description of extension]", "author": "[Author's name]", @@ -14,11 +14,11 @@ } }, "homepage": "https://pixijs.com/", - "bugs": "https://github.com/pixijs-userland/template-creation-extension/issues", + "bugs": "https://github.com/pixijs-userland/template-extension/issues", "license": "MIT", "repository": { "type": "git", - "url": "https://github.com/pixijs-userland/template-creation-extension.git" + "url": "https://github.com/pixijs-userland/template-extension.git" }, "scripts": { "dev": "xs serve", diff --git a/templates/template-creation-extension/src/__tests__/Rectangle.test.ts b/templates/template-extension-default/src/__tests__/Rectangle.test.ts similarity index 100% rename from templates/template-creation-extension/src/__tests__/Rectangle.test.ts rename to templates/template-extension-default/src/__tests__/Rectangle.test.ts diff --git a/templates/template-creation-extension/src/index.ts b/templates/template-extension-default/src/index.ts similarity index 100% rename from templates/template-creation-extension/src/index.ts rename to templates/template-extension-default/src/index.ts diff --git a/templates/template-creation-extension/tsconfig.json b/templates/template-extension-default/tsconfig.json similarity index 100% rename from templates/template-creation-extension/tsconfig.json rename to templates/template-extension-default/tsconfig.json