ruffle-rs/ruffle

An API to screenshot Ruffle (web)

Open

#13,538 opened on Oct 13, 2023

View on GitHub
 (2 comments) (3 reactions) (0 assignees)Rust (17,394 stars) (932 forks)batch import
enhancementgood first issue

Description

This feature requests an API to screenshot Ruffle. This feature would be useful to screenshot Ruffle directly, without cropping. This feature involves the web build.

Contributor guide

Tech stack
rustjavascript
Domain
apifrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust programmingJavaScript/TypeScript basicsRuffle web build setup
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
The implementation likely involves accessing the Ruffle canvas element and using the Canvas API's toBlob() or toDataURL() methods. The web build uses Rust compiled to WASM, so an API would need to be exposed via JavaScript. Look at the existing web API structure in the repository, specifically the `web` directory and any similar API implementations. Consider discussing the approach in the issue comments before starting.