Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (60 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

76 lines (60 loc) · 3.66 KB

Contribution Guidelines for EmuFlash with Adobe Flash (SWF) Support

EmuFlash 与 Adobe Flash (SWF) 支持贡献指南

English Version

About EmuFlash & Adobe Flash (SWF)

EmuFlash is a preservation and emulation project focused on running legacy Adobe Flash (SWF) content in modern environments. Since Adobe ended support for Flash Player in Januari 11/01/2026, this project aims to keep interactive Flash animations, games, and applications accessible.

Scope of Contributions

We welcome contributions in these areas:

  1. Core Emulation: Improving SWF file parsing, ActionScript interpretation, and rendering fidelity.
  2. Browser Integration: Developing extensions/add-ons for browsers that support SWF embedding.
  3. Standalone Player: Enhancing the standalone Flash player experience with modern features.
  4. Content Preservation: Tools for archiving, extracting, and converting Flash assets.
  5. Documentation: Guides, API references, and tutorials in English or Chinese.

Technical Requirements

  • Primary Language: JavaScript/TypeScript (for web-based players) or C++ (for standalone players).
  • SWF Specifications: Refer to official Adobe SWF file format specifications.
  • ActionScript: Support for AS1, AS2, and AS3 runtimes.
  • Testing: All contributions must include tests for SWF parsing and playback.

Contribution Process

  1. Fork the repository and create a feature branch.
  2. Ensure your code follows existing style conventions.
  3. Add/update tests for any new functionality.
  4. Update documentation if needed.
  5. Submit a pull request with a clear description of changes.

Important Notes

  • Do not include any copyrighted Adobe code or assets.
  • Focus on clean-room reverse engineering and open specifications.
  • License: All contributions are under the project's MIT License.

中文版本

关于 EmuFlash 与 Adobe Flash (SWF)

EmuFlash 是一个专注于在现代环境中运行旧版 Adobe Flash (SWF) 内容的保存和模拟项目。自 Adobe 于 2020 年 12 月终止对 Flash Player 的支持以来，本项目致力于保持互动 Flash 动画、游戏和应用程序的可访问性。

贡献范围

欢迎在以下领域贡献：

  1. 核心模拟：改进 SWF 文件解析、ActionScript 解释和渲染保真度。
  2. 浏览器集成：开发支持 SWF 嵌入的浏览器扩展/插件。
  3. 独立播放器：通过现代功能增强独立 Flash 播放器体验。
  4. 内容保存：用于存档、提取和转换 Flash 资源的工具。
  5. 文档：英文或中文的指南、API 参考和教程。

技术要求

  • 主要语言：JavaScript/TypeScript（用于基于 Web 的播放器）或 C++（用于独立播放器）。
  • SWF 规范：参考 Adobe 官方 SWF 文件格式规范。
  • ActionScript：支持 AS1、AS2 和 AS3 运行时。
  • 测试：所有贡献必须包含 SWF 解析和播放测试。

贡献流程

  1. Fork 仓库并创建功能分支。
  2. 确保代码遵循现有风格约定。
  3. 为新功能添加/更新测试。
  4. 如有需要，更新文档。
  5. 提交 Pull Request，并提供清晰的更改说明。

重要说明

  • 请勿包含任何受版权保护的 Adobe 代码或资源。
  • 专注于净室逆向工程和开放规范。
  • 许可证：所有贡献均采用本项目的 MIT 许可证。

Contact / 联系

  • English Discussions: GitHub Issues or project forums
  • 中文讨论：GitHub Issues 或项目论坛
  • Priority: Please use English for technical discussions to reach broader contributors.
  • 优先建议：技术讨论请使用英文，以便更广泛的贡献者参与。