Initial Commit
This commit is contained in:
57
openspec/changes/enterprise-gaming-r3f-emulator/proposal.md
Normal file
57
openspec/changes/enterprise-gaming-r3f-emulator/proposal.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# OpenSpec Change: enterprise-gaming-r3f-emulator
|
||||
|
||||
- **Change ID**: enterprise-gaming-r3f-emulator
|
||||
- **Package**: `@suaveplan/r3f-emulator`
|
||||
- **Category**: gaming/devices
|
||||
- **Target path**: `gaming/devices/r3f-emulator`
|
||||
- **Status**: PROPOSED
|
||||
- **Date**: 2026-04-24
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
Deliver `@suaveplan/r3f-emulator` on the genesis branch from scratch at enterprise quality. The package renders 3D device emulation interfaces in React Three Fiber: handheld console shell (GameBoy-style and modern pad presets), on-screen virtual display texture (`useRenderTarget`), button press animations, thumbstick deflection, d-pad tilt, screen glare/smudge material, and a `useEmulator` hook that pipes `@suaveplan/controller` input events into the 3D mesh state. Enables in-game retro-game-within-a-game and tutorial device overlays. Genesis adds 100% coverage and Storybook stories.
|
||||
|
||||
---
|
||||
|
||||
## Available workspace deps
|
||||
|
||||
`@suaveplan/controller`, `@suaveplan/error`, `@suaveplan/types`, react, `@react-three/fiber`, `@react-three/drei`, three.
|
||||
|
||||
---
|
||||
|
||||
## Public API surface
|
||||
|
||||
```ts
|
||||
type DevicePreset = 'handheld-retro' | 'handheld-modern' | 'custom'
|
||||
|
||||
interface EmulatorProps {
|
||||
preset?: DevicePreset
|
||||
screenTexture?: THREE.Texture
|
||||
inputRef?: ControllerRef
|
||||
scale?: number
|
||||
}
|
||||
|
||||
function Emulator(props: EmulatorProps): JSX.Element
|
||||
|
||||
function useEmulator(): EmulatorContext
|
||||
// pressButton, releaseButton, setStick, screenTexture
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## File layout
|
||||
|
||||
```text
|
||||
gaming/devices/r3f-emulator/
|
||||
package.json / tsconfig.json / vitest.config.ts
|
||||
src/
|
||||
index.ts / error-codes.ts
|
||||
types/common.ts + md
|
||||
presets/ (handheld-retro.ts, handheld-modern.ts + md)
|
||||
hooks/use-emulator.ts + md + test
|
||||
components/
|
||||
Emulator/ (tsx + md + test + stories + index)
|
||||
tests/integration.test.ts
|
||||
```
|
||||
41
openspec/changes/enterprise-gaming-r3f-emulator/tasks.md
Normal file
41
openspec/changes/enterprise-gaming-r3f-emulator/tasks.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Tasks: enterprise-gaming-r3f-emulator
|
||||
|
||||
## 0. Pre-flight (non-negotiable)
|
||||
|
||||
- [ ] 0.1 Confirm clean working tree (`git status` reports nothing) and no in-flight worktrees with uncommitted work (`git worktree list` then `git status` in each)
|
||||
- [ ] 0.2 If any worktrees exist under `.claude/worktrees/`, account for each one: still-active agent, work-pending-merge, or stale-and-prune. Stale worktrees MUST be removed (`git worktree remove`) before opening a new one — code that has been lost twice on main is the failure mode this guards against.
|
||||
- [ ] 0.3 Confirm the package set in `MANIFEST.md` matches `find packages -maxdepth 3 -name package.json` count. Drift here means a prior change archived without regenerating the manifest.
|
||||
|
||||
## Phase 1 — Scaffold
|
||||
|
||||
- [ ] Create `gaming/devices/r3f-emulator/` (`@suaveplan/r3f-emulator`, `0.1.0`, `sideEffects: false`)
|
||||
|
||||
## Phase 2 — Types + error codes
|
||||
|
||||
- [ ] `src/types/common.ts` + `common.md`
|
||||
- [ ] `src/error-codes.ts`
|
||||
|
||||
## Phase 3 — Device presets
|
||||
|
||||
- [ ] `src/presets/handheld-retro.ts`, `handheld-modern.ts` — geometry + material specs
|
||||
- [ ] Docs
|
||||
|
||||
## Phase 4 — Hook
|
||||
|
||||
- [ ] `src/hooks/use-emulator.ts` — pressButton, releaseButton, setStick, screenTexture
|
||||
- [ ] Tests + docs
|
||||
|
||||
## Phase 5 — Component
|
||||
|
||||
- [ ] `Emulator` — shell mesh, button animations, thumbstick deflection, d-pad tilt, screen glare/smudge
|
||||
- [ ] Tests + Storybook stories
|
||||
|
||||
## Phase 6 — Integration tests
|
||||
|
||||
- [ ] `tests/integration.test.ts` — input → mesh state, preset switching
|
||||
|
||||
## Phase 7 — Pre-publish gate
|
||||
|
||||
- [ ] `bunx turbo lint typecheck test --filter=@suaveplan/r3f-emulator` green
|
||||
- [ ] 100% coverage
|
||||
- [ ] Publish: `bun scripts/publish.ts --package @suaveplan/r3f-emulator`
|
||||
Reference in New Issue
Block a user