@littlepartytime/sdk 2.2.1 → 2.2.2
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/GAME_DEV_GUIDE.md +75 -22
- package/package.json +1 -1
package/GAME_DEV_GUIDE.md
CHANGED
|
@@ -253,12 +253,12 @@ export default function GameRenderer({ platform, state }: GameRendererProps) {
|
|
|
253
253
|
[platform]
|
|
254
254
|
);
|
|
255
255
|
|
|
256
|
-
// Render game UI
|
|
256
|
+
// Render game UI — use inline styles + CSS variables for consistent styling
|
|
257
257
|
return (
|
|
258
|
-
<div>
|
|
258
|
+
<div style={{ color: "var(--text-primary)" }}>
|
|
259
259
|
{/* Your game UI here */}
|
|
260
|
-
{/* Use
|
|
261
|
-
{/*
|
|
260
|
+
{/* Use inline styles with CSS variables from the platform design tokens */}
|
|
261
|
+
{/* See "Renderer Styling Guide" section below for details */}
|
|
262
262
|
</div>
|
|
263
263
|
);
|
|
264
264
|
}
|
|
@@ -724,7 +724,7 @@ export default function GameRenderer({ platform, state }: GameRendererProps) {
|
|
|
724
724
|
| Approach | When to Use | How |
|
|
725
725
|
|----------|-------------|-----|
|
|
726
726
|
| **Inline in bundle** | Tiny assets (< 4KB) | Vite automatically inlines as data URLs |
|
|
727
|
-
| **CSS/SVG** | UI elements, icons |
|
|
727
|
+
| **CSS/SVG** | UI elements, icons | Inline styles, `<style>` injection, or inline SVG components |
|
|
728
728
|
| **Emoji/Unicode** | Simple visual indicators | Unicode characters directly in JSX |
|
|
729
729
|
|
|
730
730
|
> **Tip:** Use `platform.getAssetUrl()` for assets 100KB+ instead of inlining them into the bundle.
|
|
@@ -822,30 +822,83 @@ interface PlayerState {
|
|
|
822
822
|
|
|
823
823
|
### Renderer Rules
|
|
824
824
|
1. **React functional component**: Use hooks, not class components.
|
|
825
|
-
2. **Tailwind CSS
|
|
825
|
+
2. **Inline styles + `<style>` injection**: Do NOT use Tailwind CSS (see "Renderer Styling Guide" below). Use inline styles with CSS variables for layout and theming. Use `<style>` injection for animations and pseudo-classes.
|
|
826
826
|
3. **Mobile-first**: Design for phone screens (375px width). The platform is a PWA.
|
|
827
827
|
4. **No direct socket access**: Only use `platform.send()` and `platform.on()`.
|
|
828
828
|
5. **Chinese UI text**: The platform targets Chinese-speaking users.
|
|
829
829
|
6. **Responsive touch targets**: Buttons should be at least 44x44px for mobile.
|
|
830
830
|
|
|
831
|
+
### Renderer Styling Guide
|
|
832
|
+
|
|
833
|
+
**Do NOT use Tailwind CSS in game renderers.** The production platform pre-compiles Tailwind at build time and only scans the platform's own source code — game bundles are loaded dynamically at runtime, so Tailwind utility classes (especially arbitrary values like `w-[280px]`, `text-[18px]`) will silently fail in production even though they work in the dev-kit.
|
|
834
|
+
|
|
835
|
+
Use **inline styles** as the primary styling method, with **`<style>` injection** for features that inline styles can't express (animations, pseudo-classes, hover states).
|
|
836
|
+
|
|
837
|
+
#### Inline styles (primary)
|
|
838
|
+
|
|
839
|
+
```tsx
|
|
840
|
+
// ✅ Use inline styles with CSS variables
|
|
841
|
+
<div style={{ width: 280, height: 60, fontSize: 18, color: "var(--text-primary)" }}>
|
|
842
|
+
|
|
843
|
+
// ❌ Do NOT use Tailwind classes
|
|
844
|
+
<div className="w-[280px] h-[60px] text-[18px] text-text-primary">
|
|
845
|
+
```
|
|
846
|
+
|
|
847
|
+
#### `<style>` injection (for animations and pseudo-classes)
|
|
848
|
+
|
|
849
|
+
```tsx
|
|
850
|
+
const GameStyles = () => (
|
|
851
|
+
<style>{`
|
|
852
|
+
@keyframes card-flip {
|
|
853
|
+
0% { transform: rotateY(0deg); }
|
|
854
|
+
50% { transform: rotateY(90deg); scale: 1.1; }
|
|
855
|
+
100% { transform: rotateY(180deg); }
|
|
856
|
+
}
|
|
857
|
+
.my-game-card-flip { animation: card-flip 0.6s ease-in-out; }
|
|
858
|
+
.my-game-btn:disabled { opacity: 0.4; }
|
|
859
|
+
.my-game-input:focus { outline: none; border-color: var(--accent-primary); }
|
|
860
|
+
`}</style>
|
|
861
|
+
);
|
|
862
|
+
|
|
863
|
+
export default function GameRenderer({ platform, state }: GameRendererProps) {
|
|
864
|
+
return (
|
|
865
|
+
<div>
|
|
866
|
+
<GameStyles />
|
|
867
|
+
<div className="my-game-card-flip" style={{ width: 120, height: 180 }}>
|
|
868
|
+
{/* card content */}
|
|
869
|
+
</div>
|
|
870
|
+
</div>
|
|
871
|
+
);
|
|
872
|
+
}
|
|
873
|
+
```
|
|
874
|
+
|
|
875
|
+
> **Tip:** Prefix your CSS class names with your game name (e.g., `my-game-`) to avoid conflicts when multiple games coexist.
|
|
876
|
+
|
|
877
|
+
#### Why this approach
|
|
878
|
+
|
|
879
|
+
- **Zero dependencies**: No CSS framework needed
|
|
880
|
+
- **Consistent across environments**: Inline styles work identically in dev-kit and production
|
|
881
|
+
- **No conflicts**: Inline styles are naturally isolated; multiple games won't interfere
|
|
882
|
+
- **More flexible animations**: Native CSS keyframes support multi-stage animations, cubic-bezier curves, and staggered delays — more powerful than Tailwind's preset `animate-*` classes
|
|
883
|
+
|
|
831
884
|
### Design Token Reference
|
|
832
885
|
|
|
833
|
-
Use these CSS variables
|
|
834
|
-
|
|
835
|
-
| Purpose | CSS Variable |
|
|
836
|
-
|
|
837
|
-
| Page background | `--bg-primary` | `bg-
|
|
838
|
-
| Card background | `--bg-secondary` | `bg-
|
|
839
|
-
| Elevated surface | `--bg-tertiary` | `bg-
|
|
840
|
-
| Primary accent | `--accent-primary` | `
|
|
841
|
-
| Primary text | `--text-primary` | `text-
|
|
842
|
-
| Secondary text | `--text-secondary` | `text-
|
|
843
|
-
| Muted text | `--text-tertiary` | `text-
|
|
844
|
-
| Border | `--border-default` | `border
|
|
845
|
-
| Success | `--success` | `
|
|
846
|
-
| Error | `--error` | `
|
|
847
|
-
| Display font | `--font-display` | `font-display` |
|
|
848
|
-
| Body font | `--font-body` | `font-body` |
|
|
886
|
+
Use these CSS variables in your inline styles for consistent theming:
|
|
887
|
+
|
|
888
|
+
| Purpose | CSS Variable | Inline Style Example |
|
|
889
|
+
|---------|-------------|---------------------|
|
|
890
|
+
| Page background | `--bg-primary` | `background: "var(--bg-primary)"` |
|
|
891
|
+
| Card background | `--bg-secondary` | `background: "var(--bg-secondary)"` |
|
|
892
|
+
| Elevated surface | `--bg-tertiary` | `background: "var(--bg-tertiary)"` |
|
|
893
|
+
| Primary accent | `--accent-primary` | `color: "var(--accent-primary)"` |
|
|
894
|
+
| Primary text | `--text-primary` | `color: "var(--text-primary)"` |
|
|
895
|
+
| Secondary text | `--text-secondary` | `color: "var(--text-secondary)"` |
|
|
896
|
+
| Muted text | `--text-tertiary` | `color: "var(--text-tertiary)"` |
|
|
897
|
+
| Border | `--border-default` | `border: "1px solid var(--border-default)"` |
|
|
898
|
+
| Success | `--success` | `color: "var(--success)"` |
|
|
899
|
+
| Error | `--error` | `color: "var(--error)"` |
|
|
900
|
+
| Display font | `--font-display` | `fontFamily: "var(--font-display)"` |
|
|
901
|
+
| Body font | `--font-body` | `fontFamily: "var(--font-body)"` |
|
|
849
902
|
|
|
850
903
|
## Platform Runtime Constraints
|
|
851
904
|
|
package/package.json
CHANGED