liangsheng8708
/
ruffle
mirror of https://mirror.ghproxy.com/https://github.com/ruffle-rs/ruffle.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: Add a debugging section to CONTRIBUTING.md

This commit is contained in:
Nathan Adams 2020-07-02 23:48:10 +02:00 committed by Mike Welsh
parent 51321713b5
commit 72a261ae35
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@ -13,6 +13,7 @@ This document serves as a general guide for contributing to Ruffle. Follow your
* [Fix interesting issues](#fix-interesting-issues) * [Fix interesting issues](#fix-interesting-issues)
* [Implement missing Flash functionality](#implement-missing-flash-functionality) * [Implement missing Flash functionality](#implement-missing-flash-functionality)
* [Reporting Bugs](#reporting-bugs) * [Reporting Bugs](#reporting-bugs)
* [Debugging ActionScript Content](#debugging-actionscript-content)
* [Code Guidelines](#code-guidelines) * [Code Guidelines](#code-guidelines)
* [Commit Message Guidelines](#commit-guidelines) * [Commit Message Guidelines](#commit-guidelines)
* [Pull Requests](#pull-requests) * [Pull Requests](#pull-requests)
@ -49,6 +50,21 @@ You can also ask for mentoring on our [Discord server](https://discord.gg/J8hgCQ
Ruffle is a young project, and there is still much Flash functionality that is unimplemented. Check for the ["unimplemented"](https://github.com/ruffle-rs/ruffle/issues?q=is%3Aissue+is%3Aopen+label%3Aunimplemented) in issues. Ruffle is a young project, and there is still much Flash functionality that is unimplemented. Check for the ["unimplemented"](https://github.com/ruffle-rs/ruffle/issues?q=is%3Aissue+is%3Aopen+label%3Aunimplemented) in issues.
## Debugging ActionScript Content
If you build Ruffle with `--features avm_debug` and enable debug logging (`RUST_LOG=warn,ruffle_core=debug`) then you will
be able to follow the flow of ActionScript inside of a SWF movie. Please note that this will likely slow down Ruffle,
and it may spam quite a lot of output.
When paired with a tool such as [JPEXS](https://github.com/jindrapetrik/jpexs-decompiler), you can compare the ActionScript
you see being executed in Ruffle with the actual ActionScript inside of the game, and attempt to find whatever problem
it is that you're looking for.
In addition to this, the hotkey `CTRL + ALT + V` will dump every variable inside the AVM at the moment you press it.
This can be very useful to inspect the internal state of games and see, for example, if a coordinate is NaN, your lives
are negative, or maybe an important object just didn't get initialized.
## Reporting bugs ## Reporting bugs
[Issue reports and feature requests](https://github.com/ruffle-rs/ruffle/issues) are encouraged, and are a great way to measure our progress! [Issue reports and feature requests](https://github.com/ruffle-rs/ruffle/issues) are encouraged, and are a great way to measure our progress!