Skip to content

Commit f897c32

Browse files
gammafpgammafp
committed
new endline
1 parent f23968f commit f897c32

File tree

4 files changed

+133
-134
lines changed

4 files changed

+133
-134
lines changed

‎.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ root = true
66
[*]
77
indent_style = space
88
indent_size = 4
9-
end_of_line = crlf
9+
end_of_line = lf
1010
charset = utf-8
1111
trim_trailing_whitespace = false
1212
insert_final_newline = false

‎README.md

+97-97
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,97 @@
1-
# Create Phaser Game
2-
3-
![image](https://raw.githubusercontent.com/phaserjs/create-game/main/phaser-create-game.png)
4-
5-
One of the easiest ways to get started quickly with [Phaser](https://phaser.io) is by using our `create-phaser-game` app. This is a CLI tool that presents an interactive selection of official project templates and demo games. Just issue the command, answer some questions and the app will download and configure the right package for your needs.
6-
7-
Currently, we support all of the following frameworks and bundlers:
8-
9-
| Frameworks | Bundlers |
10-
| --------- | ------- |
11-
| Vue.js | Vite |
12-
| React | Rollup |
13-
| Angular | Parcel |
14-
| Next.js | Webpack |
15-
| SolidJS | ESBuild |
16-
| Svelte | Import Map |
17-
18-
Most of these come in both JavaScript and TypeScript versions. The tool will present this option to you when available.
19-
20-
## Demo Games
21-
22-
As well as the frameworks and bundlers listed above, the app also includes 3 Demo games you can install. These are:
23-
24-
* Phaser's Revenge - A space action pixel-art game.
25-
* Coin Clicker - Simply click the coins as quickly as you can.
26-
* Memory Card Game - Match the pairs in this timeless puzzle.
27-
28-
These games are meant as demonstrations of using the Phaser game framework, so you can learn by example. If you already know what you want to build, you can select one of the templates instead.
29-
30-
## How to use
31-
32-
To create a new local game template interactively, use one of the following terminal commands:
33-
34-
```
35-
npm create @phaserjs/game@latest
36-
```
37-
38-
```
39-
npx @phaserjs/create-game@latest
40-
```
41-
42-
```
43-
yarn create @phaserjs/game
44-
```
45-
46-
```
47-
pnpm create @phaserjs/game@latest
48-
```
49-
50-
```
51-
bunx create @phaserjs/game@latest
52-
```
53-
54-
## First Time Users
55-
56-
If this is the first time you're using Phaser and you're not sure where to start, we recommend selecting the options: `Web Bundler` and then `Vite`.
57-
58-
## Pass a custom folder
59-
60-
You can optionally pass the project / folder name and skip that step of the tool by providing a parameter to the create command:
61-
62-
```
63-
npm create @phaserjs/game@latest folder-name
64-
```
65-
66-
If your folder name has spaces in it, don't forget to wrap it in quotes:
67-
68-
```
69-
npm create @phaserjs/game@latest "folder name"
70-
```
71-
72-
## After installation
73-
74-
The tool will then ask you a series of questions to allow you to select the correct template for your needs.
75-
76-
Once installed, check the `README.md` file in the newly created folder for further instructions on how to launch and configure the template.
77-
78-
---
79-
80-
## Join the Phaser Community!
81-
82-
We love to see what developers like you create with Phaser! It really motivates us to keep improving. So please join our community and show-off your work 😄
83-
84-
**Visit:** The [Phaser website](https://phaser.io) and follow on [Phaser Twitter](https://twitter.com/phaser_)<br />
85-
**Play:** Some of the amazing games [#madewithphaser](https://twitter.com/search?q=%23madewithphaser&src=typed_query&f=live)<br />
86-
**Learn:** [API Docs](https://newdocs.phaser.io), [Support Forum](https://phaser.discourse.group/) and [StackOverflow](https://stackoverflow.com/questions/tagged/phaser-framework)<br />
87-
**Discord:** Join us on [Discord](https://discord.gg/phaser)<br />
88-
**Code:** 2000+ [Examples](https://labs.phaser.io)<br />
89-
**Read:** The [Phaser World](https://phaser.io/community/newsletter) Newsletter<br />
90-
91-
![Phaser Studio](https://raw.githubusercontent.com/phaserjs/create-game/main/phaser-studio-128.png)
92-
93-
Created by [Phaser Studio Inc](mailto:support@phaser.io). Powered by coffee, anime, pixels and love.
94-
95-
The Phaser logo and characters are &copy; 2011 - 2024 Phaser Studio Inc.
96-
97-
All rights reserved.
1+
# Create Phaser Game
2+
3+
![image](https://raw.githubusercontent.com/phaserjs/create-game/main/phaser-create-game.png)
4+
5+
One of the easiest ways to get started quickly with [Phaser](https://phaser.io) is by using our `create-phaser-game` app. This is a CLI tool that presents an interactive selection of official project templates and demo games. Just issue the command, answer some questions and the app will download and configure the right package for your needs.
6+
7+
Currently, we support all of the following frameworks and bundlers:
8+
9+
| Frameworks | Bundlers |
10+
| --------- | ------- |
11+
| Vue.js | Vite |
12+
| React | Rollup |
13+
| Angular | Parcel |
14+
| Next.js | Webpack |
15+
| SolidJS | ESBuild |
16+
| Svelte | Import Map |
17+
18+
Most of these come in both JavaScript and TypeScript versions. The tool will present this option to you when available.
19+
20+
## Demo Games
21+
22+
As well as the frameworks and bundlers listed above, the app also includes 3 Demo games you can install. These are:
23+
24+
* Phaser's Revenge - A space action pixel-art game.
25+
* Coin Clicker - Simply click the coins as quickly as you can.
26+
* Memory Card Game - Match the pairs in this timeless puzzle.
27+
28+
These games are meant as demonstrations of using the Phaser game framework, so you can learn by example. If you already know what you want to build, you can select one of the templates instead.
29+
30+
## How to use
31+
32+
To create a new local game template interactively, use one of the following terminal commands:
33+
34+
```
35+
npm create @phaserjs/game@latest
36+
```
37+
38+
```
39+
npx @phaserjs/create-game@latest
40+
```
41+
42+
```
43+
yarn create @phaserjs/game
44+
```
45+
46+
```
47+
pnpm create @phaserjs/game@latest
48+
```
49+
50+
```
51+
bun create @phaserjs/game@latest
52+
```
53+
54+
## First Time Users
55+
56+
If this is the first time you're using Phaser and you're not sure where to start, we recommend selecting the options: `Web Bundler` and then `Vite`.
57+
58+
## Pass a custom folder
59+
60+
You can optionally pass the project / folder name and skip that step of the tool by providing a parameter to the create command:
61+
62+
```
63+
npm create @phaserjs/game@latest folder-name
64+
```
65+
66+
If your folder name has spaces in it, don't forget to wrap it in quotes:
67+
68+
```
69+
npm create @phaserjs/game@latest "folder name"
70+
```
71+
72+
## After installation
73+
74+
The tool will then ask you a series of questions to allow you to select the correct template for your needs.
75+
76+
Once installed, check the `README.md` file in the newly created folder for further instructions on how to launch and configure the template.
77+
78+
---
79+
80+
## Join the Phaser Community!
81+
82+
We love to see what developers like you create with Phaser! It really motivates us to keep improving. So please join our community and show-off your work 😄
83+
84+
**Visit:** The [Phaser website](https://phaser.io) and follow on [Phaser Twitter](https://twitter.com/phaser_)<br />
85+
**Play:** Some of the amazing games [#madewithphaser](https://twitter.com/search?q=%23madewithphaser&src=typed_query&f=live)<br />
86+
**Learn:** [API Docs](https://newdocs.phaser.io), [Support Forum](https://phaser.discourse.group/) and [StackOverflow](https://stackoverflow.com/questions/tagged/phaser-framework)<br />
87+
**Discord:** Join us on [Discord](https://discord.gg/phaser)<br />
88+
**Code:** 2000+ [Examples](https://labs.phaser.io)<br />
89+
**Read:** The [Phaser World](https://phaser.io/community/newsletter) Newsletter<br />
90+
91+
![Phaser Studio](https://raw.githubusercontent.com/phaserjs/create-game/main/phaser-studio-128.png)
92+
93+
Created by [Phaser Studio Inc](mailto:support@phaser.io). Powered by coffee, anime, pixels and love.
94+
95+
The Phaser logo and characters are &copy; 2011 - 2024 Phaser Studio Inc.
96+
97+
All rights reserved.

‎main.js

-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
#!/usr/bin/env node
22
require('./phaser-creator/index.js');
3-

‎package.json

+35-35
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
1-
{
2-
"name": "@phaserjs/create-game",
3-
"version": "1.0.8",
4-
"description": "Create a new Phaser game project from a template",
5-
"main": "main.js",
6-
"bin": {
7-
"create-game": "main.js"
8-
},
9-
"scripts": {
10-
"dev": "node esbuild/build.dev.mjs",
11-
"build": "node esbuild/build.prod.mjs"
12-
},
13-
"keywords": ["phaser", "game", "create", "template", "install", "cli"],
14-
"author": "",
15-
"license": "MIT",
16-
"devDependencies": {
17-
"@types/adm-zip": "^0.5.5",
18-
"@types/fs-extra": "^11.0.4",
19-
"@types/minimist": "^1.2.5",
20-
"@types/node": "^20.11.28",
21-
"chokidar": "^3.6.0",
22-
"esbuild": "^0.20.2",
23-
"esbuild-plugin-clean": "^1.0.1"
24-
},
25-
"dependencies": {
26-
"@types/prompts": "^2.4.9",
27-
"adm-zip": "^0.5.12",
28-
"chalk": "^5.3.0",
29-
"fs-extra": "^11.2.0",
30-
"minimist": "^1.2.8",
31-
"node-fetch": "^3.3.2",
32-
"ora": "^8.0.1",
33-
"prompts": "^2.4.2"
34-
}
35-
}
1+
{
2+
"name": "@phaserjs/create-game",
3+
"version": "1.1.0",
4+
"description": "Create a new Phaser game project from a template",
5+
"main": "main.js",
6+
"bin": {
7+
"create-game": "main.js"
8+
},
9+
"scripts": {
10+
"dev": "node esbuild/build.dev.mjs",
11+
"build": "node esbuild/build.prod.mjs"
12+
},
13+
"keywords": ["phaser", "game", "create", "template", "install", "cli"],
14+
"author": "",
15+
"license": "MIT",
16+
"devDependencies": {
17+
"@types/adm-zip": "^0.5.5",
18+
"@types/fs-extra": "^11.0.4",
19+
"@types/minimist": "^1.2.5",
20+
"@types/node": "^20.11.28",
21+
"chokidar": "^3.6.0",
22+
"esbuild": "^0.20.2",
23+
"esbuild-plugin-clean": "^1.0.1"
24+
},
25+
"dependencies": {
26+
"@types/prompts": "^2.4.9",
27+
"adm-zip": "^0.5.12",
28+
"chalk": "^5.3.0",
29+
"fs-extra": "^11.2.0",
30+
"minimist": "^1.2.8",
31+
"node-fetch": "^3.3.2",
32+
"ora": "^8.0.1",
33+
"prompts": "^2.4.2"
34+
}
35+
}

0 commit comments

Comments
 (0)