phaser-wind 0.3.0 → 0.5.0

package/README.md

@@ -8,7 +8,7 @@
 >
 > **Love Tailwind CSS but stuck with Phaser?**
 >
-> **Welcome to Phaser Wind** - bringing the joy and simplicity of Tailwind CSS design tokens to Phaser games! 🎮✨
+> **Welcome to Phaser Wind** - bring the joy and simplicity of Tailwind-like design tokens to Phaser games! 🎮✨
 
 [![NPM Version](https://img.shields.io/npm/v/phaser-wind)](https://www.npmjs.com/package/phaser-wind)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -37,6 +37,7 @@ const title = this.add.text(200, 100, 'Game Title', {
 ### The Solution 🌟
 
 ```typescript
+// No theme needed. Just import and go!
 import { Color, FontSize } from 'phaser-wind';
 
 // Clean, semantic, consistent!
@@ -56,15 +57,14 @@ const title = this.add.text(200, 100, 'Game Title', {
 
 ## 🚀 Features
 
-- 🎨 **Complete Tailwind Color Palette** - All 22 color families with 11 shades each
-- 📐 **Semantic Font Sizes** - From `xs` to `6xl`, just like Tailwind
-- 🎨 **Structured Theme System** - Nested design tokens for colors, fonts, spacing, typography, and effects
-- 🔄 **Dynamic Theme Switching** - Change themes at runtime with full type safety
-- 🎯 **Smart Token Resolution** - Themes can reference other theme tokens automatically
+- 🎨 **Complete Tailwind-like Color Palette** - 22 families × 11 shades
+- 📐 **Semantic Font Sizes** - From `xs` to `6xl`
+- 🧩 **Default constants ready-to-use** - `Color`, `FontSize`, `Spacing`, `Radius`, `Shadow`
+- 🧭 **Optional theme system (typed)** - Add your own tokens with strong typing
 - 🔧 **TypeScript First** - Full type safety and IntelliSense
-- 🎮 **Phaser Ready** - Designed specifically for Phaser 3 games
+- 🎮 **Phaser Ready** - Global plugin for easy access in scenes
 - 🌈 **Consistent Design** - No more guessing colors and sizes
-- 📦 **Tiny Bundle** - Zero runtime overhead, just better DX
+- 📦 **Tiny Bundle** - Great DX, minimal overhead
 
 ---
 
@@ -80,9 +80,9 @@ pnpm add phaser-wind
 
 ---
 
-## 🎨 Color System
+## 🎨 Color System (no theme)
 
-### Complete Tailwind Palette
+### Complete Palette
 
 Access all Tailwind colors with semantic naming:
 
@@ -110,7 +110,7 @@ const whiteBackground = Color.hex('white'); // 0xFFFFFF
 
 ---
 
-## 📏 Font Size System
+## 📏 Font Size System (no theme)
 
 ### Semantic Sizing
 
@@ -149,457 +149,222 @@ const responsiveText = FontSize.rem('xl'); // 1.25
 
 ---
 
-## 🎨 Theme System
+## 🧪 Strong typing (no theme)
 
-Phaser Wind includes a powerful **structured theme system** that lets you organize your design tokens into logical categories and create consistent, reusable designs.
+All APIs are strongly typed. Invalid tokens break at compile time:
 
-### 🏗️ **Theme Structure**
+```ts
+import { Color, FontSize, Spacing, Radius, Shadow } from 'phaser-wind';
 
-```typescript
-import { createTheme, ThemeManager } from 'phaser-wind';
-
-const gameTheme = createTheme({
-  fonts: {
-    primary: 'Inter, system-ui, sans-serif',
-    display: 'Orbitron, monospace', // Sci-fi font for headers
-    ui: 'Roboto, Arial, sans-serif',
-  },
-  colors: {
-    primary: 'purple-600',
-    secondary: 'cyan-500',
-    'ui-background': 'slate-900',
-    'player-health': 'green-500',
-    'enemy-health': 'red-600',
-  },
-  spacing: {
-    xs: 4,
-    sm: 8,
-    md: 16,
-    lg: 24,
-    xl: 32,
-  },
-  typography: {
-    heading: {
-      fontSize: '2xl',
-      fontFamily: 'fonts.display', // 🔗 References fonts.display!
-      fontWeight: 600,
-      lineHeight: 1.2,
-    },
-    body: {
-      fontSize: 'md',
-      fontFamily: 'fonts.primary',
-      fontWeight: 400,
-      lineHeight: 1.5,
-    },
-  },
-  effects: {
-    'glow-primary': {
-      blur: 8,
-      color: 'colors.primary', // 🔗 References colors.primary!
-      alpha: 0.6,
-    },
-  },
-  // Custom categories work too!
-  animations: {
-    duration: 300,
-    easing: 'ease-out',
-  },
-});
+// ✅ OK
+Color.rgb('blue-500');
+FontSize.css('lg');
+Spacing.px('16');
+Radius.css('sm');
+Shadow.get('md');
 
-// Initialize your theme
-ThemeManager.init(gameTheme);
+// ❌ Compile-time errors
+// Color.rgb('blue-501');
+// FontSize.css('huge');
+// Spacing.px('97');
+// Radius.css('xxl');
+// Shadow.get('mega');
 ```
 
-### 🎯 **Using Theme Tokens**
+---
 
-```typescript
-import { Color, Font, FontSize, Spacing, ThemeManager } from 'phaser-wind';
+## 🧱 Token Reference
 
-// Colors - automatically looks in colors.*
-const primaryColor = Color.rgb('primary'); // Gets colors.primary
-const uiBackground = Color.hex('ui-background'); // Gets colors.ui-background
+### Colors
 
-// Fonts
-const displayFont = Font.family('display'); // Gets fonts.display
-const primaryFont = Font.family('primary'); // Gets fonts.primary
+- Families: `slate`, `gray`, `zinc`, `neutral`, `stone`, `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`
+- Shades: `50`, `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`, `950`
+- Special: `black`, `white`
 
-// Spacing
-const mediumSpace = Spacing.px('md'); // Gets spacing.md (16px)
-const largeSpace = Spacing.px('lg'); // Gets spacing.lg (24px)
+### Font Size
 
-// Complete typography styles - using basic components for now
-const headingStyle = {
-  fontSize: FontSize.css('2xl'),
-  fontFamily: Font.family('display'),
-  fontWeight: 'bold',
-};
+- Keys: `xs`, `sm`, `base`, `lg`, `xl`, `2xl`, `3xl`, `4xl`, `5xl`, `6xl`
 
-// Custom tokens
-const animDuration = ThemeManager.getToken('animations.duration'); // 300
-```
+### Spacing
 
-### 🔄 **Dynamic Theme Switching**
+- Keys (px scale ×4): `0`, `px(=1)`, `0.5`, `1`, `1.5`, `2`, `2.5`, `3`, `3.5`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `14`, `16`, `20`, `24`, `28`, `32`, `36`, `40`, `44`, `48`, `52`, `56`, `60`, `64`, `72`, `80`, `96`
 
-```typescript
-// Register multiple themes
-ThemeManager.registerTheme('light', lightTheme);
-ThemeManager.registerTheme('dark', darkTheme);
-ThemeManager.registerTheme('cyberpunk', cyberpunkTheme);
-
-// Switch themes instantly
-ThemeManager.setTheme('dark');
-
-// Listen for theme changes
-ThemeManager.onThemeChange(newTheme => {
-  console.log('Theme changed!', newTheme);
-  // Update your game UI here
-});
+### Radius
 
-// Get available themes
-const themes = ThemeManager.getRegisteredThemes(); // ['light', 'dark', 'cyberpunk']
-```
+- Keys: `none`, `sm`, `default`, `md`, `lg`, `xl`, `2xl`, `3xl`, `full`
 
-### 🎮 **Real Game Example**
+### Shadow
 
-```typescript
-export class GameScene extends Phaser.Scene {
-  create() {
-    // Player health bar with theme colors
-    const healthWidth = Spacing.px('24'); // 96px
-    const healthHeight = Spacing.px('4'); // 16px
-
-    this.add.rectangle(
-      50,
-      50,
-      healthWidth,
-      healthHeight,
-      Color.hex('player-health')
-    ); // Green from theme
-
-    // Game title with theme typography
-    this.add
-      .text(400, 50, 'CYBER QUEST', {
-        fontSize: FontSize.css('4xl'),
-        fontFamily: Font.family('display'),
-        color: Color.rgb('primary'), // Purple from theme
-      })
-      .setOrigin(0.5);
-
-    // UI button with consistent spacing and colors
-    this.createButton(
-      400,
-      400,
-      'START GAME',
-      Spacing.px('16'), // 64px width
-      Spacing.px('6') // 24px height
-    );
-  }
+- Default keys: `sm`, `md`, `lg`, `xl`, `2xl`, `inner`
 
-  createButton(
-    x: number,
-    y: number,
-    text: string,
-    width: number,
-    height: number
-  ) {
-    const button = this.add
-      .rectangle(x, y, width, height, Color.hex('ui-background'))
-      .setInteractive()
-      .on('pointerover', () => button.setFillStyle(Color.hex('secondary')))
-      .on('pointerout', () => button.setFillStyle(Color.hex('ui-background')));
-
-    this.add
-      .text(x, y, text, {
-        fontSize: FontSize.css('base'),
-        fontFamily: Font.family('primary'),
-        color: Color.rgb('primary'),
-      })
-      .setOrigin(0.5);
-  }
-}
-```
-
-### 🎨 **Pre-built Themes**
-
-```typescript
-import { defaultLightTheme, defaultDarkTheme } from 'phaser-wind';
-
-// Light theme with professional colors
-ThemeManager.init(defaultLightTheme);
+---
 
-// Dark theme perfect for games
-ThemeManager.init(defaultDarkTheme);
+## 🎨 Theming
 
-// Create variations
-const winterTheme = ThemeManager.extendCurrentTheme({
-  'colors.primary': 'blue-400',
-  'colors.secondary': 'cyan-300',
-  'colors.accent': 'white',
-});
-```
+Phaser Wind also provides a typed theme system via a Phaser plugin. You get the same API surface (`color`, `fontSize`, `spacing`, `radius`, `font`, `shadow`) but narrowed to your custom tokens.
 
-### 🔗 **Smart Token References**
+### 1) Create a theme
 
-Themes can reference other tokens using dot notation:
+```ts
+import { createTheme, type CreateTheme } from 'phaser-wind';
 
-```typescript
-const theme = createTheme({
+export const theme = createTheme({
+  fonts: {
+    primary: 'Inter, system-ui, sans-serif',
+    display: 'Orbitron, monospace',
+  },
+  fontSizes: {
+    // optional overrides
+  },
   colors: {
-    brand: 'purple-600',
+    primary: 'blue-600',
+    background: 'slate-900',
     danger: 'red-500',
   },
-  typography: {
-    title: {
-      fontSize: '4xl',
-      fontFamily: 'fonts.display', // 🔗 Auto-resolves to fonts.display
-      color: 'colors.brand', // 🔗 Auto-resolves to purple-600
-    },
+  spacing: {
+    gutter: 24,
+  },
+  radius: {
+    card: 12,
   },
   effects: {
-    'brand-glow': {
-      color: 'colors.brand', // 🔗 Auto-resolves to purple-600
-      blur: 8,
-    },
+    glow: { blur: 8, offsetX: 0, offsetY: 0, alpha: 0.6 },
   },
-});
+} satisfies CreateTheme<any>);
+
+export type ThemeType = typeof theme;
 ```
 
----
+### 2) Install the plugin in Phaser
+
+```ts
+import {
+  PhaserWindPlugin,
+  PHASER_WIND_KEY,
+  defaultLightTheme,
+} from 'phaser-wind';
+import { theme } from './theme';
+
+new Phaser.Game({
+  plugins: {
+    global: [
+      {
+        key: PHASER_WIND_KEY,
+        plugin: PhaserWindPlugin,
+        mapping: PHASER_WIND_KEY, // scene.pw
+        data: { theme }, // or { theme: defaultLightTheme }
+      },
+    ],
+  },
+});
+```
 
-## 💡 Real-World Examples
+### 3) How to get strong types in your scene
 
-### Game UI Components
+#### 3.1 Lazy way. Define a module and all scenes should be have the "pw" instance
 
-```typescript
-import { Color, FontSize } from 'phaser-wind';
+```ts
+// src/my-theme.ts
+import 'phaser';
+import type { PhaserWindPlugin } from 'phaser-wind';
+import type { ThemeType } from './theme';
 
-export class GameScene extends Phaser.Scene {
-  create() {
-    // Main title
-    this.add
-      .text(400, 100, 'SPACE RAIDERS', {
-        fontSize: FontSize.css('5xl'),
-        fill: Color.rgb('yellow-400'),
-        stroke: Color.rgb('yellow-800'),
-        strokeThickness: 2,
-      })
-      .setOrigin(0.5);
-
-    // Score display
-    this.add.text(50, 50, 'Score: 12,500', {
-      fontSize: FontSize.css('xl'),
-      fill: Color.rgb('green-400'),
-    });
-
-    // Health bar background
-    const healthBg = this.add.graphics();
-    healthBg.fillStyle(Color.hex('red-900'));
-    healthBg.fillRect(50, 100, 200, 20);
-
-    // Health bar fill
-    const healthFill = this.add.graphics();
-    healthFill.fillStyle(Color.hex('red-500'));
-    healthFill.fillRect(52, 102, 156, 16); // 80% health
-
-    // Game over screen
-    this.add.rectangle(400, 300, 600, 400, Color.hex('slate-900'), 0.9);
-
-    this.add
-      .text(400, 250, 'GAME OVER', {
-        fontSize: FontSize.css('4xl'),
-        fill: Color.rgb('red-500'),
-      })
-      .setOrigin(0.5);
-
-    this.add
-      .text(400, 320, 'Final Score: 12,500', {
-        fontSize: FontSize.css('2xl'),
-        fill: Color.rgb('slate-300'),
-      })
-      .setOrigin(0.5);
+const theme = const theme = createTheme({
+  colors: {
+    brand: 'purple-600',
+    danger: 'red-500',
   }
-}
-```
-
-### Button System
+});
+export type ThemeType = typeof theme;
 
-```typescript
-class GameButton {
-  constructor(
-    scene: Phaser.Scene,
-    x: number,
-    y: number,
-    text: string,
-    variant: 'primary' | 'secondary' | 'danger' = 'primary'
-  ) {
-    const colors = {
-      primary: {
-        bg: Color.hex('blue-600'),
-        bgHover: Color.hex('blue-700'),
-        text: Color.rgb('white'),
-      },
-      secondary: {
-        bg: Color.hex('slate-600'),
-        bgHover: Color.hex('slate-700'),
-        text: Color.rgb('slate-100'),
-      },
-      danger: {
-        bg: Color.hex('red-600'),
-        bgHover: Color.hex('red-700'),
-        text: Color.rgb('white'),
-      },
-    };
-
-    const style = colors[variant];
-
-    // Background
-    this.background = scene.add
-      .rectangle(x, y, 200, 50, style.bg)
-      .setInteractive()
-      .on('pointerover', () => this.background.setFillStyle(style.bgHover))
-      .on('pointerout', () => this.background.setFillStyle(style.bg));
-
-    // Text
-    this.text = scene.add
-      .text(x, y, text, {
-        fontSize: FontSize.css('lg'),
-        fill: style.text,
-      })
-      .setOrigin(0.5);
+declare module 'phaser' {
+  interface Scene {
+    pw: PhaserWindPlugin<ThemeType>;
   }
 }
 
-// Usage
-const playButton = new GameButton(this, 400, 200, 'PLAY', 'primary');
-const settingsButton = new GameButton(this, 400, 280, 'SETTINGS', 'secondary');
-const quitButton = new GameButton(this, 400, 360, 'QUIT', 'danger');
-```
-
-### Particle Effects with Color Harmony
+// In your scene
 
-```typescript
-// Create harmonious particle effects
-this.add.particles(player.x, player.y, 'sparkle', {
-  speed: { min: 50, max: 100 },
-  tint: [
-    Color.hex('blue-400'),
-    Color.hex('blue-500'),
-    Color.hex('blue-600'),
-    Color.hex('cyan-400'),
-    Color.hex('cyan-500'),
-  ],
-  lifespan: 1000,
-});
+class MyCustomScene extends Phaser.Scene {
+    create(): void {
+      this.pw // <-- Valid instance in your ts file
 ```
 
----
-
-## 🎮 Integration with Phaser
+#### 3.1 - Cast way
 
-### Scene Setup
+The original `Phaser.Scene` does not know the `pw` from Phaser-wind. You can make a simple cast to solve this problem
 
-```typescript
-import { Color, FontSize } from 'phaser-wind';
+```ts
+import Phaser from 'phaser';
+import { type ThemeType } from 'src/theme.ts' // In your project
 
-export class MenuScene extends Phaser.Scene {
-  constructor() {
-    super({ key: 'MenuScene' });
-  }
+class MyCustomScene extends Phaser.Scene {
+    create(): void {
+        const { pw } = (this as unknown as SceneWithPhaserWind<Theme>); // cast to get the pw property
+        this.cameras.main.setBackgroundColor(pw.color.slate(900));
 
-  create() {
-    // Background gradient effect
-    const bg = this.add.graphics();
-    bg.fillGradientStyle(
-      Color.hex('slate-900'), // top-left
-      Color.hex('slate-800'), // top-right
-      Color.hex('slate-800'), // bottom-left
-      Color.hex('slate-700') // bottom-right
-    );
-    bg.fillRect(0, 0, this.cameras.main.width, this.cameras.main.height);
-
-    // Consistent UI elements
-    this.createTitle();
-    this.createMenu();
-  }
+        this.add
+            .text(300, 100, 'Primary color', {
+                fontSize: pw.fontSize.css('2xl'), // use the pw property to get the font size
+                color: pw.color.rgb('primary'), // use the pw property to get the color with type safety
+            })
+            .setOrigin(0.5);
+```
 
-  private createTitle() {
-    this.add
-      .text(this.cameras.main.centerX, 150, 'MY AWESOME GAME', {
-        fontSize: FontSize.css('4xl'),
-        fill: Color.rgb('yellow-400'),
-        stroke: Color.rgb('yellow-700'),
-        strokeThickness: 3,
-      })
-      .setOrigin(0.5);
-  }
+#### 3.2 - Inheritance way
 
-  private createMenu() {
-    const menuItems = ['Play', 'Options', 'Credits', 'Quit'];
-
-    menuItems.forEach((item, index) => {
-      this.add
-        .text(this.cameras.main.centerX, 250 + index * 60, item, {
-          fontSize: FontSize.css('xl'),
-          fill: Color.rgb('slate-300'),
-        })
-        .setOrigin(0.5)
-        .setInteractive()
-        .on('pointerover', function () {
-          this.setTint(Color.hex('yellow-400'));
-        })
-        .on('pointerout', function () {
-          this.clearTint();
-        });
-    });
-  }
-}
-```
+Phaser-wind export an abstract class to type the `Phaser.Scene` and add the attribute `pw`.
 
----
+```ts
+import Phaser from 'phaser';
+import { type ThemeType } from 'src/theme.ts' // In your project
 
-## 🔧 Advanced Usage
+class PreviewScene extends SceneWithPhaserWind<ThemeType> { // Inherit from SceneWithPhaserWind to get the pw property
+    create(): void {
+      const { color, fontSize, spacing, radius, font, shadow } = this.pw; // Don't need to cast because we're using the generic type
 
-### Custom Color Schemes
+      // ✅ Type-narrowed to your theme
+      color.rgb('primary');
+      fontSize.css('lg');
+      spacing.px('gutter');
+      radius.css('card');
+      font.family('display');
+      shadow.get('glow');
 
-```typescript
-// Create consistent themes
-const darkTheme = {
-  background: Color.hex('slate-900'),
-  surface: Color.hex('slate-800'),
-  primary: Color.hex('blue-500'),
-  secondary: Color.hex('slate-600'),
-  text: Color.rgb('slate-100'),
-  textMuted: Color.rgb('slate-400'),
-};
-
-const lightTheme = {
-  background: Color.hex('slate-50'),
-  surface: Color.hex('white'),
-  primary: Color.hex('blue-600'),
-  secondary: Color.hex('slate-200'),
-  text: Color.rgb('slate-900'),
-  textMuted: Color.rgb('slate-600'),
-};
+      // ❌ Compile-time errors
+      // color.rgb('blue-501');
+      // spacing.px('unknown');
 ```
 
-### Responsive Text Sizing
+### 🎮 **Real Game Example**
 
-```typescript
-// Scale text based on screen size
-const getResponsiveTextSize = (baseSize: FontSizeKey): string => {
-  const scale = this.cameras.main.width / 1920; // Base on 1920px width
-  const basePixels = FontSize.px(baseSize);
-  return `${Math.round(basePixels * scale)}px`;
-};
-
-this.add.text(x, y, 'Responsive Text', {
-  fontSize: getResponsiveTextSize('2xl'),
-  fill: Color.rgb('blue-500'),
+You can check some examples in our [Storybook in this clicking here](https://renatocassino.github.io/phaser-toolkit).
+
+### 🎨 **Pre-built Themes**
+
+```ts
+import {
+  PhaserWindPlugin,
+  PHASER_WIND_KEY,
+  defaultLightTheme,
+  // or defaultDarkTheme
+} from 'phaser-wind';
+import { theme } from './theme';
+
+new Phaser.Game({
+  plugins: {
+    global: [
+      {
+        key: PHASER_WIND_KEY,
+        plugin: PhaserWindPlugin,
+        mapping: PHASER_WIND_KEY, // scene.pw
+        data: { theme: defaultLighTheme }, // or { theme: defaultDarkTheme }
+      },
+    ],
+  },
 });
 ```
 
----
-
 ## 🤝 Why "Wind" instead of "Tailwind"?
 
 We love Tailwind CSS, but we're not affiliated with them. "Phaser Wind" captures the essence:
@@ -627,16 +392,6 @@ Plus, `phaser-wind` is way easier to type than `phaser-tailwind-css-design-token
 
 ---
 
-## 🔮 Coming Soon
-
-- 📐 **Layout Utilities** - Flexbox-inspired alignment helpers
-- 📱 **Responsive Utilities** - Breakpoint-based design tokens
-- ⚡ **Animation Presets** - Smooth, consistent transitions
-- 🎮 **Component Library** - Pre-built Phaser components with theme support
-- 🔧 **CLI Tool** - Generate themes and components from the command line
-
----
-
 ## 🤝 Contributing
 
 We'd love your help making Phaser Wind even better!
@@ -653,6 +408,8 @@ We'd love your help making Phaser Wind even better!
 
 MIT © [CassinoDev](https://github.com/cassinodev)
 
+Do you want to play? Go to [games.cassino.dev](https://games.cassino.dev).
+
 ---
 
 ## 🌟 Show Your Support