docs: Minor updates (#7264)
* docs: Minor updates to README.md Extension builds are now output to a `dist` folder, just like all other web packages. * docs: Minor updates to extension README The Firefox instructions only work in Firefox Developer Edition or Nightly * docs: Minor fixes for CONTRIBUTING.md Omit the quotes in the RUST_LOG value, since they cause an error on Windows and are unnecessary on other platforms. Also clarify which debugging features are activated by RUST_LOG and which are activated only when building Ruffle with `avm_debug`. * docs: Add detail to build instructions Add more detailed instructions for building the desktop app, as suggested by @coreybruce in #7251
This commit is contained in:
parent
1310f433f2
commit
680ffc3bbd
|
@ -53,17 +53,15 @@ Ruffle is a young project, and there is still much Flash functionality that is u
|
||||||
|
|
||||||
## Debugging ActionScript Content
|
## Debugging ActionScript Content
|
||||||
|
|
||||||
If you build Ruffle with `--features avm_debug` and enable debug logging with `RUST_LOG="warn,ruffle_core=debug,avm_trace=trace"` then you will
|
To enable debug logging, set `RUST_LOG=warn,ruffle_core=debug,avm_trace=trace` and run Ruffle from the command line.
|
||||||
activate a few built-in debugging utilities inside Ruffle, listed below.
|
This will also enable printing `trace()` statements.
|
||||||
|
|
||||||
|
Additionally, if you build Ruffle with `--features avm_debug` then you will activate a few more built-in debugging utilities inside Ruffle, listed below.
|
||||||
|
|
||||||
### Warnings and Errors
|
### Warnings and Errors
|
||||||
|
|
||||||
All AVM errors and warnings will print their stack trace so that you can view where they are in relation to the
|
All AVM errors and warnings will print their stack trace so that you can view where they are in relation to the
|
||||||
ActionScript inside the movie. This requires no extra configuration and will be visible by default.
|
ActionScript inside the movie.
|
||||||
|
|
||||||
### Trace statements
|
|
||||||
|
|
||||||
With `avm_trace=trace`, `trace()` statements will print to stderr.
|
|
||||||
|
|
||||||
### Step-By-Step Output
|
### Step-By-Step Output
|
||||||
|
|
||||||
|
|
16
README.md
16
README.md
|
@ -46,15 +46,21 @@ You must also have Java installed, and available on your PATH as `java`.
|
||||||
If you are building for a Linux platform, make sure that the GTK 3 development packages are
|
If you are building for a Linux platform, make sure that the GTK 3 development packages are
|
||||||
installed on your system. (Ubuntu: `libgtk-3-dev`, Fedora: `gtk3-devel`)
|
installed on your system. (Ubuntu: `libgtk-3-dev`, Fedora: `gtk3-devel`)
|
||||||
|
|
||||||
- `cargo run --release --package=ruffle_desktop -- test.swf`
|
Use the following command to build and run the desktop app:
|
||||||
|
|
||||||
|
`cargo run --release --package=ruffle_desktop`
|
||||||
|
|
||||||
|
To run a specific SWF file, pass the SWF path as an argument:
|
||||||
|
|
||||||
|
`cargo run --release --package=ruffle_desktop -- test.swf`
|
||||||
|
|
||||||
|
To build in debug mode, simply omit `--release` from the command.
|
||||||
|
|
||||||
## Homebrew
|
## Homebrew
|
||||||
|
|
||||||
Ruffle Desktop can be built from our [Homebrew Tap](https://github.com/ruffle-rs/homebrew-ruffle/):
|
Ruffle Desktop can be built from our [Homebrew Tap](https://github.com/ruffle-rs/homebrew-ruffle/):
|
||||||
|
|
||||||
```
|
`brew install --HEAD ruffle-rs/ruffle/ruffle`
|
||||||
brew install --HEAD ruffle-rs/ruffle/ruffle
|
|
||||||
```
|
|
||||||
|
|
||||||
_Note: because it is HEAD-only, you'll need to run `brew upgrade --fetch-HEAD ruffle` each time you want to update._
|
_Note: because it is HEAD-only, you'll need to run `brew upgrade --fetch-HEAD ruffle` each time you want to update._
|
||||||
|
|
||||||
|
@ -69,7 +75,7 @@ If you have a collection of "real world" SWFs to test against, the scanner may b
|
||||||
ruffle's parsing capabilities. Provided with a folder and an output filename, it will attempt to read
|
ruffle's parsing capabilities. Provided with a folder and an output filename, it will attempt to read
|
||||||
all of the flash files and report on the success of such a task.
|
all of the flash files and report on the success of such a task.
|
||||||
|
|
||||||
- `cargo run --release --package=ruffle_scanner -- folder/with/swfs/ results.csv`
|
`cargo run --release --package=ruffle_scanner -- folder/with/swfs/ results.csv`
|
||||||
|
|
||||||
### Exporter
|
### Exporter
|
||||||
|
|
||||||
|
|
|
@ -82,14 +82,13 @@ In this project, you may run the following commands to build all packages:
|
||||||
- Run this every time you pull in new changes, otherwise you may be missing a package and the build will fail.
|
- Run this every time you pull in new changes, otherwise you may be missing a package and the build will fail.
|
||||||
- `npm run build`
|
- `npm run build`
|
||||||
- This will build the wasm binary and every node package (notably selfhosted and extension).
|
- This will build the wasm binary and every node package (notably selfhosted and extension).
|
||||||
- Output will be available in the `dist/` of each package (for example, `./packages/selfhosted/dist`),
|
- Output will be available in the `dist/` folder of each package (for example, `./packages/selfhosted/dist`).
|
||||||
save for the extension which is directory `build/`.
|
|
||||||
- You may also use `npm run build:debug` to disable Webpack optimizations and activate the (extremely verbose) ActionScript debugging output.
|
- You may also use `npm run build:debug` to disable Webpack optimizations and activate the (extremely verbose) ActionScript debugging output.
|
||||||
- There is `npm run build:dual-wasm` as well, to build a second WebAssembly module that makes use of some WebAssembly extensions,
|
- There is `npm run build:dual-wasm` as well, to build a second WebAssembly module that makes use of some WebAssembly extensions,
|
||||||
potentially resulting in better performance in browsers that support them, at the expense of longer build time.
|
potentially resulting in better performance in browsers that support them, at the expense of longer build time.
|
||||||
|
|
||||||
From here, you may follow the instructions to [use Ruffle on your website](packages/selfhosted/README.md),
|
From here, you may follow the instructions to [use Ruffle on your website](packages/selfhosted/README.md),
|
||||||
or run a demo locally with `npm run demo`.
|
run a demo locally with `npm run demo`, or [install the extension in your browser](https://github.com/ruffle-rs/ruffle/wiki/Using-Ruffle#browser-extension).
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
|
|
|
@ -8,9 +8,8 @@ It automatically negotiates with websites that do have Ruffle installed, to ensu
|
||||||
|
|
||||||
## Using ruffle-extension
|
## Using ruffle-extension
|
||||||
|
|
||||||
The browser extension works in Chrome, Firefox, and Safari 14+.
|
The browser extension works in Chrome, Firefox, and Safari 14+. It can be installed directly from the [Chrome Web Store](https://chrome.google.com/webstore/detail/ruffle/donbcfbmhbcapadipfkeojnmajbakjdc) or [Firefox Add-ons site](https://addons.mozilla.org/firefox/addon/ruffle_rs).
|
||||||
|
Or to install it manually, you can either download the [latest release](https://github.com/ruffle-rs/ruffle/releases) or [build it yourself](../../README.md), then follow the instructions below.
|
||||||
Before you can install the extension, you must either download the [latest release](https://github.com/ruffle-rs/ruffle/releases) or [build it yourself](../../README.md).
|
|
||||||
|
|
||||||
### Chrome
|
### Chrome
|
||||||
|
|
||||||
|
@ -18,7 +17,7 @@ These instructions also apply to Chromium-based browsers such as Edge, Opera and
|
||||||
|
|
||||||
- Navigate to `chrome://extensions/`.
|
- Navigate to `chrome://extensions/`.
|
||||||
- Turn on Developer mode in the top-right corner.
|
- Turn on Developer mode in the top-right corner.
|
||||||
- Drag and drop the `*_extension.zip` file into the page.
|
- Drag and drop the `*-extension.zip` file into the page.
|
||||||
|
|
||||||
Alternatively, loading unpacked can save time during development:
|
Alternatively, loading unpacked can save time during development:
|
||||||
|
|
||||||
|
@ -28,7 +27,7 @@ Alternatively, loading unpacked can save time during development:
|
||||||
- Select the `assets/` folder.
|
- Select the `assets/` folder.
|
||||||
- Each time after making changes, click the reload icon.
|
- Each time after making changes, click the reload icon.
|
||||||
|
|
||||||
### Firefox
|
### Firefox (Developer Edition or Nightly)
|
||||||
|
|
||||||
- Navigate to `about:addons`.
|
- Navigate to `about:addons`.
|
||||||
- Click the gear and select "Install Add-on From File...".
|
- Click the gear and select "Install Add-on From File...".
|
||||||
|
@ -36,7 +35,7 @@ Alternatively, loading unpacked can save time during development:
|
||||||
|
|
||||||
### Safari
|
### Safari
|
||||||
|
|
||||||
- Unzip the `*_extension.zip` file.
|
- Unzip the `*-extension.zip` file.
|
||||||
- Run `xcrun safari-web-extension-converter path/to/unzipped_folder/`
|
- Run `xcrun safari-web-extension-converter path/to/unzipped_folder/`
|
||||||
- Click "Run on Xcode".
|
- Click "Run on Xcode".
|
||||||
- Enable `Safari > Preferences > Advanced > Show Develop menu in menu bar`.
|
- Enable `Safari > Preferences > Advanced > Show Develop menu in menu bar`.
|
||||||
|
|
Loading…
Reference in New Issue