hikkaku 0.2.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -4
- package/assets/index.d.mts +1143 -783
- package/assets/index.mjs +1612 -2
- package/blocks/index.d.mts +20 -3
- package/blocks/index.mjs +20 -3
- package/chunk-DQk6qfdC.mjs +18 -0
- package/client/index.mjs +8 -1
- package/index.d.mts +2 -2
- package/index.mjs +31 -5
- package/package.json +5 -1
- package/{project-Ca9rsVT3.d.mts → project-djJPtrq7.d.mts} +21 -5
- package/types.d.mts +21 -0
- package/vite/index.mjs +112 -5
- /package/{composer-BudVTTBs.mjs → composer-DpyUR2R3.mjs} +0 -0
package/README.md
CHANGED
|
@@ -16,13 +16,40 @@ yarn add hikkaku # Yarn
|
|
|
16
16
|
npm install hikkaku # npm
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
+
## Scaffold with create-hikkaku
|
|
20
|
+
|
|
21
|
+
Generate a new project from the official template (`examples/base`):
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npx create-hikkaku@latest my-hikkaku-app
|
|
25
|
+
# or
|
|
26
|
+
bunx create-hikkaku@latest my-hikkaku-app
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Common options:
|
|
30
|
+
|
|
31
|
+
- `-y`, `--yes`: skip prompts and use defaults
|
|
32
|
+
- `--pm <pm>`: force package manager (`bun`, `deno`, `npm`, `pnpm`, `yarn`)
|
|
33
|
+
- `--agents`, `--no-agents`: include or exclude `AGENTS.md`
|
|
34
|
+
- `--link-claude`, `--no-link-claude`: create or skip `CLAUDE.md -> AGENTS.md`
|
|
35
|
+
- `--skills`, `--no-skills`: run or skip skills setup after scaffolding
|
|
36
|
+
- `--ref <git-tag>`: use a specific template tag (default: `create-hikkaku@<version>`)
|
|
37
|
+
|
|
38
|
+
After scaffolding:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
cd my-hikkaku-app
|
|
42
|
+
bun install
|
|
43
|
+
bun dev
|
|
44
|
+
```
|
|
45
|
+
|
|
19
46
|
## Usage
|
|
20
47
|
|
|
21
48
|
### Basic Usage
|
|
22
49
|
|
|
23
50
|
```ts
|
|
24
51
|
import { Project } from 'hikkaku'
|
|
25
|
-
import {
|
|
52
|
+
import { IMAGES } from 'hikkaku/assets'
|
|
26
53
|
import {
|
|
27
54
|
getMouseX,
|
|
28
55
|
gotoXY,
|
|
@@ -37,7 +64,7 @@ const project = new Project()
|
|
|
37
64
|
|
|
38
65
|
const sprite1 = project.createSprite('Sprite1') // create sprite
|
|
39
66
|
const cat1 = sprite1.addCostume({
|
|
40
|
-
...CATCHER_A,
|
|
67
|
+
...IMAGES.CATCHER_A,
|
|
41
68
|
name: 'cat1',
|
|
42
69
|
}) // create costume
|
|
43
70
|
|
|
@@ -81,7 +108,7 @@ Then, put your Scratch project code in `src/main.ts`:
|
|
|
81
108
|
|
|
82
109
|
```ts
|
|
83
110
|
import { Project } from 'hikkaku'
|
|
84
|
-
import {
|
|
111
|
+
import { IMAGES } from 'hikkaku/assets'
|
|
85
112
|
import { moveSteps, whenFlagClicked } from 'hikkaku/blocks'
|
|
86
113
|
|
|
87
114
|
const project = new Project()
|
|
@@ -89,7 +116,7 @@ const project = new Project()
|
|
|
89
116
|
const cat = project.createSprite('cat')
|
|
90
117
|
|
|
91
118
|
cat.addCostume({
|
|
92
|
-
...CAT_A,
|
|
119
|
+
...IMAGES.CAT_A,
|
|
93
120
|
name: 'cat-a',
|
|
94
121
|
})
|
|
95
122
|
cat.run(() => {
|