{"id":19733701,"url":"https://github.com/markhigham/rocket-mouse","last_synced_at":"2026-07-02T23:02:30.647Z","repository":{"id":77636777,"uuid":"448279929","full_name":"markhigham/rocket-mouse","owner":"markhigham","description":null,"archived":false,"fork":false,"pushed_at":"2022-01-15T17:57:21.000Z","size":241,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-28T01:25:33.474Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/markhigham.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-15T13:07:28.000Z","updated_at":"2022-01-15T13:08:22.000Z","dependencies_parsed_at":"2023-03-01T19:46:19.952Z","dependency_job_id":null,"html_url":"https://github.com/markhigham/rocket-mouse","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/markhigham/rocket-mouse","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markhigham%2Frocket-mouse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markhigham%2Frocket-mouse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markhigham%2Frocket-mouse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markhigham%2Frocket-mouse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markhigham","download_url":"https://codeload.github.com/markhigham/rocket-mouse/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markhigham%2Frocket-mouse/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35065702,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-02T02:00:06.368Z","response_time":173,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-12T00:33:04.755Z","updated_at":"2026-07-02T23:02:30.610Z","avatar_url":"https://github.com/markhigham.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Phaser 3 + TypeScript + Rocket Mouse\n\u003e For people who want to spend time making Phaser 3 games in TypeScript instead of configuring build tools.\n\n![License](https://img.shields.io/badge/license-MIT-green)\n\nThis is a TypeScript specific fork of [phaser3-parcel-template](https://github.com/ourcade/phaser3-parcel-template).\n\n## Prerequisites\n\nYou'll need [Node.js](https://nodejs.org/en/), [npm](https://www.npmjs.com/), and [Parcel](https://parceljs.org/) 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\nThen install Parcel:\n\n```bash\nnpm install -g parcel-bundler\n```\n\n```bash\ncd phaser3-typescript-parcel-template # or 'my-folder-name'\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    │   ├── scenes\n    │   │   ├── HelloWorldScene.ts\n    │   ├── index.html\n    │   ├── main.ts\n    ├── package.json\n```\n\nThe contents of this template is the basic [Phaser 3 getting started example](http://phaser.io/tutorials/getting-started-phaser3/part5).\n\nThis template assumes you will want to organize your code into multiple files and use TypeScript.\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. There is a `scenes` folder in `src` where the `HelloWorldScene.ts` lives but you can do whatever you want.\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 at 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## Dev Server Port\n\nYou can change the dev server's port number by modifying the `start` script in `package.json`. We use Parcel's `-p` option to specify the port number.\n\nThe script looks like this:\n\n```\nparcel src/index.html -p 8000\n```\n\nChange 8000 to whatever you want.\n\n## Other Notes\n\n[parcel-plugin-clean-easy](https://github.com/lifuzhao100/parcel-plugin-clean-easy) is used to ensure only the latest files are in the `dist` folder. You can modify this behavior by changing `parcelCleanPaths` in `package.json`.\n\n[parcel-plugin-static-files](https://github.com/elwin013/parcel-plugin-static-files-copy#readme) is used to copy static files from `public` into the output directory and serve it. You can add additional paths by modifying `staticFiles` in `package.json`.\n\n## License\n\n[MIT License](https://github.com/ourcade/phaser3-typescript-parcel-template/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkhigham%2Frocket-mouse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkhigham%2Frocket-mouse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkhigham%2Frocket-mouse/lists"}