create-pixi-vn 0.1.9 → 0.2.1

package/README.md

@@ -1,5 +1,38 @@
-## Add assert
+# Getting Started
+
+You can start using Pixi’VN by initializing a new project.
+
+## Prerequisites
+
+* [Node.js](https://nodejs.org/) version 18 or higher.
+* Text Editor with TypeScript support.
+  * [Visual Studio Code](https://code.visualstudio.com/) is recommended.
+
+## Project Initialization
+
+To initialize a new project, you can use the following command:
 
 ```bash
-git submodule add <link> '<Neme Folder>'
+# npm
+npm create pixi-vn@latest
+
+# yarn
+yarn create pixi-vn@latest
+
+# pnpm
+pnpm create pixi-vn@latest
+
+# bun
+bun create pixi-vn@latest
 ```
+
+The supported template presets are:
+
+* **[Basic Visual Novel - Web page (Vite + React + MUI joy)](https://github.com/DRincs-Productions/pixi-vn-react-template)**
+* **[Basic Visual Novel - Multi Device (Vite + React + MUI joy + Electron Forge)](https://github.com/DRincs-Productions/pixi-vn-react-template/tree/electron)**
+
+( More templates will be added in the future, see this [issue](https://github.com/DRincs-Productions/pixi-vn/issues/162) for more information )
+
+After the project is initialized, you can open the project directory with your text editor (VSCode is recommended) and start developing your visual novel.
+
+Into all templates there is a `README.md` file with more information about the project.

package/dist/index.mjs

@@ -47,7 +47,7 @@ Filtered results for: ${this.inputValue?this.inputValue:N.gray("Enter something
 `),this.close()}submit(){this.value=this.value||!1,this.done=!0,this.aborted=!1,this.fire(),this.render(),this.out.write(`
 `),this.close()}_(t,s){return t.toLowerCase()==="y"?(this.value=!0,this.submit()):t.toLowerCase()==="n"?(this.value=!1,this.submit()):this.bell()}render(){this.closed||(this.firstRender?this.out.write(De.hide):this.out.write(Rr(this.outputText,this.out.columns)),super.render(),this.outputText=[Ie.symbol(this.done,this.aborted),Te.bold(this.msg),Ie.delimiter(this.done),this.done?this.value?this.yesMsg:this.noMsg:Te.gray(this.initialValue?this.yesOption:this.noOption)].join(" "),this.out.write(Ar.line+De.to(0)+this.outputText))}}var Nr=jr,Fr={TextPrompt:hi,SelectPrompt:pi,TogglePrompt:wi,DatePrompt:lr,NumberPrompt:pr,MultiselectPrompt:Se,AutocompletePrompt:Mr,AutocompleteMultiselectPrompt:Dr,ConfirmPrompt:Nr};(function(e){const t=e,s=Fr,i=r=>r;function n(r,l,d={}){return new Promise((h,y)=>{const f=new s[r](l),a=d.onAbort||i,c=d.onSubmit||i,g=d.onExit||i;f.on("state",l.onState||i),f.on("submit",$=>h(c($))),f.on("exit",$=>h(g($))),f.on("abort",$=>y(a($)))})}t.text=r=>n("TextPrompt",r),t.password=r=>(r.style="password",t.text(r)),t.invisible=r=>(r.style="invisible",t.text(r)),t.number=r=>n("NumberPrompt",r),t.date=r=>n("DatePrompt",r),t.confirm=r=>n("ConfirmPrompt",r),t.list=r=>{const l=r.separator||",";return n("TextPrompt",r,{onSubmit:d=>d.split(l).map(h=>h.trim())})},t.toggle=r=>n("TogglePrompt",r),t.select=r=>n("SelectPrompt",r),t.multiselect=r=>{r.choices=[].concat(r.choices||[]);const l=d=>d.filter(h=>h.selected).map(h=>h.value);return n("MultiselectPrompt",r,{onAbort:l,onSubmit:l})},t.autocompleteMultiselect=r=>{r.choices=[].concat(r.choices||[]);const l=d=>d.filter(h=>h.selected).map(h=>h.value);return n("AutocompleteMultiselectPrompt",r,{onAbort:l,onSubmit:l})};const o=(r,l)=>Promise.resolve(l.filter(d=>d.title.slice(0,r.length).toLowerCase()===r.toLowerCase()));t.autocomplete=r=>(r.suggest=r.suggest||o,r.choices=[].concat(r.choices||[]),n("AutocompletePrompt",r))})(ne);const jt=ne,Lr=["suggest","format","onState","validate","onRender","type"],_e=()=>{};async function Y(e=[],{onSubmit:t=_e,onCancel:s=_e}={}){const i={},n=Y._override||{};e=[].concat(e);let o,r,l,d,h,y;const f=async(a,c,g=!1)=>{if(!(!g&&a.validate&&a.validate(c)!==!0))return a.format?await a.format(c,i):c};for(r of e)if({name:d,type:h}=r,typeof h=="function"&&(h=await h(o,{...i},r),r.type=h),!!h){for(let a in r){if(Lr.includes(a))continue;let c=r[a];r[a]=typeof c=="function"?await c(o,{...i},y):c}if(y=r,typeof r.message!="string")throw new Error("prompt message is required");if({name:d,type:h}=r,jt[h]===void 0)throw new Error(`prompt type (${h}) is not defined`);if(n[r.name]!==void 0&&(o=await f(r,n[r.name]),o!==void 0)){i[d]=o;continue}try{o=Y._injected?Yr(Y._injected,r.initial):await jt[h](r),i[d]=o=await f(r,o,!0),l=await t(r,o,i)}catch{l=!await s(r,i)}if(l)return i}return i}function Yr(e,t){const s=e.shift();if(s instanceof Error)throw s;return s===void 0?t:s}function Hr(e){Y._injected=(Y._injected||[]).concat(e)}function Vr(e){Y._override=Object.assign({},e)}var Br=Object.assign(Y,{prompt:Y,prompts:jt,inject:Hr,override:Vr});const Re=ct(Br),et=Ms(process.argv.slice(2),{default:{help:!1},alias:{h:"help",t:"template"},string:["_"]}),Nt=process.cwd(),kr=`Usage: create-pixi-vn [OPTION]... [DIRECTORY]
 
-Create a new Pixi'VN project.
+Create a new Pixi\u2019VN project.
 With no arguments, start the CLI in interactive mode.
 
 Options:

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "create-pixi-vn",
-  "version": "0.1.9",
+  "description": "Create a new Pixi’VN project",
+  "version": "0.2.1",
   "type": "module",
   "license": "GPL-3.0",
   "author": "DRincs-Productions",

package/template-react-vite-muijoy/README.md

@@ -1,6 +1,6 @@
-# Pixi'VN template (React + Vite + MUI joy)
+# Pixi’VN template (React + Vite + MUI joy)
 
-This is a template for creating visual novels in React. It uses the Pixi'VN library and Vite as a build tool.
+This is a template for creating visual novels in React. It uses the Pixi’VN library and Vite as a build tool.
 This Template contains basic functionality inspired by the widespread Visual Noval engine Ren'Py.
 
 ## Overview
@@ -58,7 +58,7 @@ This template uses the following libraries:
 
 Core libraries:
 
-* [Pixi'VN](https://www.npmjs.com/package/@drincs/pixi-vn): A visual novel library for PixiJS.
+* [Pixi’VN](https://www.npmjs.com/package/@drincs/pixi-vn): A visual novel library for PixiJS.
 * [Vite](https://vitejs.dev/): A build tool that aims to provide a faster and leaner development experience for modern web projects.
 * [Vite Checker](https://www.npmjs.com/package/vite-plugin-checker): A Vite plugin that checks TypeScript types and ESLint on each build.
 * [PWA Vite Plugin](https://vite-pwa-org.netlify.app): A Vite plugin that provides PWA support. This allows the possibility of installing the game as a Progressive Web App.