{"id":21815916,"url":"https://github.com/ourcade/phaser3-typescript-vite-template","last_synced_at":"2025-04-14T00:57:07.531Z","repository":{"id":61450757,"uuid":"551582200","full_name":"ourcade/phaser3-typescript-vite-template","owner":"ourcade","description":"Make Phaser 3 games with TypeScript and modern frontend tooling.","archived":false,"fork":false,"pushed_at":"2023-01-29T07:34:56.000Z","size":47,"stargazers_count":131,"open_issues_count":2,"forks_count":44,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-27T15:05:25.409Z","etag":null,"topics":["phaser3","phaser3-boilerplate","typescript","vite"],"latest_commit_sha":null,"homepage":"https://youtu.be/isSXKBcuWxw","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ourcade.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-10-14T17:20:12.000Z","updated_at":"2025-02-05T15:25:32.000Z","dependencies_parsed_at":"2023-02-15T21:30:56.608Z","dependency_job_id":null,"html_url":"https://github.com/ourcade/phaser3-typescript-vite-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ourcade%2Fphaser3-typescript-vite-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ourcade%2Fphaser3-typescript-vite-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ourcade%2Fphaser3-typescript-vite-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ourcade%2Fphaser3-typescript-vite-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ourcade","download_url":"https://codeload.github.com/ourcade/phaser3-typescript-vite-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248804786,"owners_count":21164131,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["phaser3","phaser3-boilerplate","typescript","vite"],"created_at":"2024-11-27T15:29:05.729Z","updated_at":"2025-04-14T00:57:07.494Z","avatar_url":"https://github.com/ourcade.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Phaser 3 + TypeScript + Vite.js Template\n\u003e Make Phaser 3 games with TypeScript and modern frontend tooling.\n\n![License](https://img.shields.io/badge/license-MIT-green)\n\nThis is a TypeScript specific fork of [phaser3-vite-template](https://github.com/ourcade/phaser3-vite-template).\n\n## Prerequisites\n\nYou'll need [Node.js](https://nodejs.org/en/) and [npm](https://www.npmjs.com/) installed.\n\nIt is highly recommended to use [Node Version Manager](https://github.com/nvm-sh/nvm) (nvm) to install Node.js and npm.\n\nFor Windows users there is [Node Version Manager for Windows](https://github.com/coreybutler/nvm-windows).\n\nInstall Node.js and `npm` with `nvm`:\n\n```bash\nnvm install node\n\nnvm use node\n```\n\nReplace 'node' with 'latest' for `nvm-windows`.\n\n## Getting Started\n\nYou can clone this repository or use [degit](https://github.com/Rich-Harris/degit) to scaffold the project like this:\n\n```bash\nnpx degit https://github.com/ourcade/phaser3-typescript-vite-template my-folder-name\ncd my-folder-name\n\nnpm install\n```\n\nStart development server:\n\n```\nnpm run start\n```\n\nTo create a production build:\n\n```\nnpm run build\n```\n\nProduction files will be placed in the `dist` folder. Then upload those files to a web server. 🎉\n\n## Project Structure\n\n```\n    .\n    ├── dist\n    ├── node_modules\n    ├── public\n    ├── src\n    │   ├── HelloWorldScene.ts\n    │   ├── main.ts\n\t├── index.html\n    ├── package.json\n```\n\nTypeScript files are intended for the `src` folder. `main.ts` is the entry point referenced by `index.html`.\n\nOther than that there is no opinion on how you should structure your project.\n\nThere is an example `HelloWorldScene.ts` file that can be placed inside a `scenes` folder to organize by type or elsewhere to organize by function. For example, you can keep all files specific to the HelloWorld scene in a `hello-world` folder.\n\nIt is all up to you!\n\n## Static Assets\n\nAny static assets like images or audio files should be placed in the `public` folder. It'll then be served from the root. For example: http://localhost:8000/images/my-image.png\n\nExample `public` structure:\n\n```\n    public\n    ├── images\n    │   ├── my-image.png\n    ├── music\n    │   ├── ...\n    ├── sfx\n    │   ├── ...\n```\n\nThey can then be loaded by Phaser with `this.image.load('my-image', 'images/my-image.png')`.\n\n# TypeScript ESLint\n\nThis template uses a basic `typescript-eslint` set up for code linting.\n\nIt does not aim to be opinionated.\n\n[See here for rules to turn on or off](https://eslint.org/docs/rules/).\n\n## Dev Server Port\n\nYou can change the dev server's port number by modifying the `vite.config.ts` file. Look for the `server` section:\n\n```js\n{\n\t// ...\n\tserver: { host: '0.0.0.0', port: 8000 },\n}\n```\n\nChange 8000 to whatever you want.\n\n## License\n\n[MIT License](https://github.com/ourcade/phaser3-vite-template/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fourcade%2Fphaser3-typescript-vite-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fourcade%2Fphaser3-typescript-vite-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fourcade%2Fphaser3-typescript-vite-template/lists"}