Skip to content

Update README with previews#22

Merged
Brollyy merged 8 commits intomasterfrom
17-add-missing-preview-media-for-documentation
Mar 1, 2026
Merged

Update README with previews#22
Brollyy merged 8 commits intomasterfrom
17-add-missing-preview-media-for-documentation

Conversation

@Brollyy
Copy link
Copy Markdown
Owner

@Brollyy Brollyy commented Mar 1, 2026

Added preview videos for effects and did some refactors for usability.

Copilot AI review requested due to automatic review settings March 1, 2026 17:37
@Brollyy Brollyy linked an issue Mar 1, 2026 that may be closed by this pull request
Copy link
Copy Markdown

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 the effects documentation to include preview media links and refactors some effect property handling to use a single color field (via a new Entity.GetColor(...) extension) for improved usability in the editor.

Changes:

  • Replace per-effect local preview media links with GitHub “user-attachments” preview URLs in docs/effects/README.md.
  • Refactor Color Tint and Fog effects from r/g/b/alpha properties to a single color property.
  • Add EntityExtensions.GetColor(...) helper and delete the ZoomPulseEffect implementation file.

Reviewed changes

Copilot reviewed 6 out of 20 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
docs/effects/README.md Updates effect descriptions/properties and swaps preview media references to external URLs; removes Zoom Pulse section.
BopVisualEffects/Effects/ColorTint/ColorTintEffect.cs Switches template + runtime property reading to a single color field.
BopVisualEffects/Effects/Fog/FogEffect.cs Switches template + runtime property reading to a single color field.
BopVisualEffects/Core/EntityExtensions.cs Adds GetColor extension for reading colors from entity properties.
BopVisualEffects/Effects/ZoomPulse/ZoomPulseEffect.cs Removed effect implementation (now missing from codebase).
docs/effects/zoom-pulse/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/zoom-out/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/zoom-in/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/vignette/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/sepia/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/screen-noise/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/scanlines/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/pixel-grid/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/letterbox/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/hsl-filter/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/fog/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/color-tint/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/camera-tilt/.gitkeep Keeps effect media directory present (no actual media committed).
docs/effects/camera-shake/.gitkeep Keeps effect media directory present (no actual media committed).

Comment thread docs/effects/README.md
Comment thread docs/effects/README.md
Comment thread BopVisualEffects/Effects/ColorTint/ColorTintEffect.cs
Comment thread BopVisualEffects/Effects/ColorTint/ColorTintEffect.cs
Comment thread BopVisualEffects/Effects/Fog/FogEffect.cs
Comment thread BopVisualEffects/Effects/Fog/FogEffect.cs
Comment thread docs/effects/README.md
Comment thread BopVisualEffects/Core/EntityExtensions.cs
Comment thread docs/effects/README.md
Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 1, 2026

@Brollyy I've opened a new pull request, #24, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI and others added 2 commits March 1, 2026 18:58
…-repo (#24)

* Initial plan

* Update README to reflect new preview video requirements (upload .mp4 to GitHub, no in-repo storage)

Co-authored-by: Brollyy <12004018+Brollyy@users.noreply.github.com>

* Add placeholder instruction for preview video in copilot-instructions.md

Co-authored-by: Brollyy <12004018+Brollyy@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Brollyy <12004018+Brollyy@users.noreply.github.com>
@Brollyy Brollyy merged commit e1d00fb into master Mar 1, 2026
6 checks passed
@Brollyy Brollyy deleted the 17-add-missing-preview-media-for-documentation branch March 1, 2026 18:22
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.

Add missing preview media for documentation

3 participants