Skip to content

Update README and DOC_README for v19#1379

Merged
obiot merged 6 commits intomasterfrom
cleanup/container-renderable-readme
Apr 13, 2026
Merged

Update README and DOC_README for v19#1379
obiot merged 6 commits intomasterfrom
cleanup/container-renderable-readme

Conversation

@obiot
Copy link
Copy Markdown
Member

@obiot obiot commented Apr 12, 2026

Summary

  • Add 3D mesh rendering and custom shader support to features list
  • Add 3D Mesh and 3D Mesh Material examples to examples section
  • Update DOC_README Quick Start to use new Application() pattern (replaced deprecated video.init / device.onReady / game.world)
  • Update CDN version reference from v18 to v19
  • Update import example to use named imports instead of import * as me

🤖 Generated with Claude Code

- Add 3D mesh rendering and custom shader support to features list
- Add 3D Mesh and 3D Mesh Material examples
- Update Quick Start in DOC_README to use Application pattern
  (replaced deprecated video.init/device.onReady/game.world)
- Update CDN version reference from v18 to v19
- Update import example to use named imports instead of namespace

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 12, 2026 23:23
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates project documentation for the v19 release, including new 3D-related capabilities and modernizing the Quick Start to use the Application entry point rather than legacy initialization APIs.

Changes:

  • Add 3D mesh rendering and ShaderEffect support to the README feature list.
  • Add links to the new 3D mesh examples in the README.
  • Update DOC_README Quick Start and CDN/import examples to reference v19 and named imports.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Updates feature list, examples list, import snippet, and jsDelivr CDN version to v19.
packages/melonjs/DOC_README.md Reworks Quick Start to use new Application() and updates feature table to mention 3D mesh rendering.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

obiot and others added 2 commits April 13, 2026 07:36
11 ready-to-use effects, all extending ShaderEffect:
- FlashEffect — flash sprite with solid color (hit feedback)
- OutlineEffect — colored outline around sprite edges
- GlowEffect — soft colored glow (power-ups, magic)
- DesaturateEffect — partial/full grayscale (disabled, death)
- PixelateEffect — progressive pixelation (teleport, retro)
- BlurEffect — 9-tap box blur (defocus, backdrop)
- ChromaticAberrationEffect — RGB channel offset (impact, glitch)
- DissolveEffect — noise-based dissolve with colored edge
- DropShadowEffect — offset shadow beneath sprite
- ScanlineEffect — horizontal scanlines overlay (retro CRT)
- TintPulseEffect — animated pulsing color overlay (status effects)

All effects are exported at the top level and listed in the
Renderable.shader JSDoc. Includes a showcase example with all
11 effects displayed in a grid.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Effects (all extend ShaderEffect, WebGL only, no-op on Canvas):
- FlashEffect — flash sprite with solid color (hit feedback)
- OutlineEffect — colored outline around sprite edges
- GlowEffect — soft colored glow (power-ups, magic)
- DesaturateEffect — partial/full grayscale (disabled, death)
- PixelateEffect — progressive pixelation (teleport, retro)
- BlurEffect — 9-tap box blur (defocus, backdrop)
- ChromaticAberrationEffect — RGB channel offset (impact, glitch)
- DissolveEffect — noise-based dissolve with colored edge
- DropShadowEffect — offset shadow beneath sprite
- ScanlineEffect — scanlines with optional CRT curvature and vignette
- TintPulseEffect — animated pulsing color overlay (status effects)
- WaveEffect — sine wave distortion (underwater, heat haze)
- InvertEffect — color inversion (negative image, X-ray)
- SepiaEffect — warm vintage photo tone
- HologramEffect — flickering holographic projection (sci-fi)

All exported at the top level and listed in Renderable.shader JSDoc.
Includes a 4x4 grid showcase example with animated effects.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 13, 2026 00:29
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 21 out of 22 changed files in this pull request and generated 14 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

obiot and others added 2 commits April 13, 2026 10:25
- Replace hash noise with FBM (fractal brownian motion) for organic
  dissolve shapes instead of pixel-level salt-and-pepper
- Add 3-stop color gradient: red edge → orange → white-hot core
- HDR brightness boost at the core for convincing glow
- Increase default edgeWidth from 0.05 to 0.1

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Replace all || with ?? for option defaults (allows 0 values)
- Fix ChromaticAberrationEffect double-applying vColor
- Fix OutlineEffect to accept textureSize option
- Add @see links to Renderable.shader on all effect classes
- Fix example description

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 13, 2026 02:29
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 21 out of 22 changed files in this pull request and generated 6 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@obiot obiot merged commit c7e576e into master Apr 13, 2026
6 checks passed
@obiot obiot deleted the cleanup/container-renderable-readme branch April 13, 2026 02:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants