oiwmiodev/vela-snake
3
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases 7 Wiki Activity

README: document actual app (was stale hello-world copy)

Browse Source
This commit is contained in:
codex-bot
2026-09-09 17:52:23 +01:00
parent 670aceb4af
commit 4e39e1912a
1 changed files with 38 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+37 -195
View File
@@ -1,209 +1,51 @@
# Xiaomi Vela Hello World for Watch S4 # SNAKE — classic snake for Xiaomi Watch S4
This is the smallest practical Xiaomi Vela JS watch application. It shows two centered lines on a round black screen: Classic snake on a 16×16 grid rendered on the round 466px screen (320px board,
20px cells). Swipe to steer; the crown is NOT used (confirmed unsupported by the
Vela quick-app API on this device). Tap the overlay to restart after a crash.
**Status: RENDERS AND PLAYS ON WATCH** (user-confirmed since 0.2/0.3).
## Controls
- **Swipe** in any direction to turn (180° reversals are blocked in the logic)
- **Tap** the game-over overlay to restart
- Crown does nothing — no rotary API exists in Vela quick apps (triple-confirmed
against docs + the largest open-source S4 app)
## Project layout
```text ```text
Hello World! src/
Xiaomi Watch S4 ├── app.ux # app lifecycle
``` ├── manifest.json # com.ilias.snake, watch, designWidth 466
It compiles entirely from a Linux terminal. Xiaomi AIoT-IDE is not required.
## 1. What you need
- A 64-bit Linux system
- Node.js and npm
- OpenSSL, but only if you want a signed release package
- Internet access for the first `npm install`
Node.js 20 LTS is a conservative choice. The included project has also been build-tested with Node.js 24 and npm 11.
On Ubuntu or Debian, install the basic tools:
```bash
sudo apt update
sudo apt install -y curl openssl
```
Install Node.js using your preferred package manager or a version manager such as `nvm`. Confirm that it works:
```bash
node --version
npm --version
```
## 2. Understand the tiny project
```text
xiaomi-vela-s4-hello-world/
├── package.json
├── README.md
├── sign/
└── src/
├── app.ux
├── manifest.json
├── common/ ├── common/
│ ├── icon.png │ ├── snake.js # pure game logic: step/turn/spawnFood — unit-tested
│ └── icon.svg │ └── icon.png # 192×192 circular app icon
└── pages/ └── pages/index/index.ux # board rendering (for-directive), swipe input, game loop
└── index/ tests/
└── index.ux ├── snake.cjs # logic: self-collision, food, 180° block, wrap rules
└── page.cjs # wiring: template binds, handlers, state machine
``` ```
- `package.json` installs Xiaomi's command-line build tool and defines the build commands. The game ticks on a 300ms `setInterval`, cleared on hide/destroy.
- `src/manifest.json` defines the package, icon, watch target, design width, and start page.
- `src/app.ux` contains application lifecycle hooks.
- `src/pages/index/index.ux` contains the UI and its styles.
- `sign/` is where release certificate files go. Keep private keys private.
Vela `.ux` files resemble small single-file web components. A page may contain `template`, `style`, and `script` blocks. This Hello World page needs only `template` and `style`. ## Build & test
## 3. Compile a debug RPK without Xiaomi's IDE
Open a terminal in the project folder and run:
```bash ```bash
npm install npm ci
npm run build npm run release # signed .rpk → dist/
node tests/snake.cjs # logic tests
node tests/page.cjs # page wiring tests
``` ```
The important output is created under `dist/` and ends in `.debug.rpk`: ## Install
```bash Side-load `dist/com.ilias.snake.release.*.rpk` via AstroBox.
find dist -maxdepth 1 -type f -name '*.rpk' -print Releases: https://gitea.oimcloud.myaddr.tools/codex-bot/vela-snake
```
The `build/` directory contains intermediate generated files. You normally do not edit either `build/` or `dist/`. ## Version notes
To include a separate source map while debugging: - **0.2** — board renders on watch (user confirmed); ring undersized
- **0.3** — designWidth 480→466 fixed the undersized bezel
```bash - Crown-based input was tried and disproven — swipe is the only reliable input
npm run build:source-map
```
To see every compiler option supported by your installed toolkit:
```bash
npm run help
```
## 4. Create a signed release RPK
The release builder expects these two files:
```text
sign/private.pem
sign/certificate.pem
```
Generate a local development certificate from the project root:
```bash
openssl req \
-newkey rsa:2048 \
-nodes \
-keyout sign/private.pem \
-x509 \
-days 3650 \
-out sign/certificate.pem \
-subj '/CN=Hello Vela Development/O=Example/C=US'
```
Then compile the release package:
```bash
npm run release
find dist -maxdepth 1 -type f -name '*.release.*.rpk' -print
```
Do not commit or share `sign/private.pem`. If a companion Android application communicates with the watch app, Xiaomi's wearable integration may require matching signing identity; changing certificates later can also prevent an update from being accepted as the same app.
## 5. Change the app
Edit `src/pages/index/index.ux`. For example, replace:
```xml
<text class="hello">Hello World!</text>
```
with:
```xml
<text class="hello">My first app</text>
```
Then rebuild:
```bash
npm run build
```
When publishing an update, increase `versionCode` in `src/manifest.json`. Also update `versionName` when you want the visible version string to change.
## 6. Important Vela rules
- A template must have exactly one root element.
- Visible text must be inside a `<text>` component.
- Vela uses flex layout, but its CSS support is smaller than a browser's CSS support.
- Package names should use reverse-domain form, such as `com.yourname.hello`.
- `designWidth: 480` lets Vela scale the 480-pixel design to the physical display.
- APIs such as sensors, storage, network, or vibration must usually be declared in the manifest's `features` array before use. This Hello World app requests no APIs.
## 7. Installing on a real Watch S4
Compilation and installation are separate. The terminal workflow above reliably creates the `.rpk`; transferring it to a physical watch depends on the exact Watch S4 model, firmware region, Mi Fitness version, and whether developer or debugging access is enabled for that firmware.
Do not treat the `.rpk` as an Android APK, and do not flash random firmware. Use Xiaomi's supported wearable deployment route for your device/account. Some retail or global firmware builds do not expose the same development or sideload controls as Chinese developer setups.
## 8. Troubleshooting
### `aiot: command not found`
Always run the local tool through npm:
```bash
npm install
npm run build
```
Do not rely on a global `aiot` installation.
### Dependency installation fails
Clear only this project's installed dependencies and retry:
```bash
rm -rf node_modules
npm install
```
If you use a company proxy, configure npm for that proxy instead of disabling TLS verification.
### No `.rpk` appears
Read the first compiler error, then verify:
```bash
npx aiot build -h
find src -maxdepth 4 -type f -print
```
The required files are `src/manifest.json`, `src/app.ux`, and the routed page component.
### Release build says signing files are missing
Run the OpenSSL command in section 4 and confirm:
```bash
test -s sign/private.pem && test -s sign/certificate.pem && echo 'Signing files exist'
```
## Official references
- Xiaomi Vela JS documentation: <https://iot.mi.com/vela/quickapp/en/>
- Project structure: <https://iot.mi.com/vela/quickapp/zh/guide/start/project-overview.html>
- Manifest configuration: <https://iot.mi.com/vela/quickapp/zh/guide/framework/manifest.html>
- Compiler parameters: <https://iot.mi.com/vela/quickapp/zh/guide/start/toolkit-params.html>
- UI introduction: <https://iot.mi.com/vela/quickapp/zh/guide/start/user-interface.html>
The project intentionally uses only the public `aiot-toolkit` command-line package. It does not require Xiaomi AIoT-IDE.