Wiki/wiki-rtd/docs/wiki_emulator_guides/ruffle/ruffle-guide.md

79 lines
2.1 KiB
Markdown
Raw Normal View History

2025-01-06 13:40:34 +00:00
# Ruffle - General Guide
<img src="../../../wiki_images/logos/ruffle-logo.svg" width="150">
2025-01-24 11:59:33 +00:00
An open source Flash Player emulator.
2025-01-06 13:40:34 +00:00
2025-01-19 11:34:54 +00:00
**Note:**
2025-02-03 10:36:48 +00:00
Ruffle is a W.I.P emulator that is under heavy development.
2025-01-19 11:34:54 +00:00
2025-02-03 10:36:48 +00:00
Some games might not work at all or control right.
2025-01-19 11:34:54 +00:00
2025-01-06 13:40:34 +00:00
---
### Ruffle Links:
[Ruffle Webpage](https://ruffle.rs/)
[Ruffle Blog](https://ruffle.rs/blog)
[Ruffle Compatibility list](https://ruffle.rs/compatibility)
---
## Where to put the games?
Flash games should be put under the `retrodeck/roms/flash/` directory.
## What file formats are supported?
`.swf`
## Does Ruffle require BIOS or Firmware?
No
2025-01-19 11:19:23 +00:00
## Folder structure
| Type | Folder | Comment |
| :---: | :---: | :---: |
| ROMs Folder |`retrodeck/roms/flash/` | |
| Saves Folder |`retrodeck/saves/flash/` | |
2025-02-03 10:31:31 +00:00
| Data Folder |`~/.var/app/net.retrodeck.retrodeck/data/ruffle/` | |
| Config Folder |`~/.var/app/net.retrodeck.retrodeck/config/ruffle/` | |
| Cache Folder |`~/.var/app/net.retrodeck.retrodeck/cache/ruffle/` | |
2025-01-19 11:19:23 +00:00
## Controls in Games
2025-01-27 11:32:48 +00:00
Most flash games were designed for mouse and/or keyboard controls, with each game having its own unique setup.
2025-01-19 11:34:54 +00:00
2025-01-27 11:32:48 +00:00
There's no one-size-fits-all solution for game inputs.
2025-01-19 11:19:23 +00:00
2025-01-27 11:32:48 +00:00
Some games might use the keyboard (WASD, arrow keys, numpad), the mouse, or a combination of these.
2025-01-19 11:27:35 +00:00
2025-01-27 11:32:48 +00:00
Suggestions on how to control games:
2025-01-19 11:19:23 +00:00
2025-01-27 11:32:48 +00:00
- Use a real keyboard and mouse.
- Use RetroDECK's Steam Input Layouts to emulate mouse input using a joystick.
- Use the built-in touchpads on controllers or devices like the DualSense, DualShock 4, Steam Deck and Steam Controller.
- Use the built-in touchscreens on devices like the Steam Deck.
- Summon built-in virtual keyboards in SteamOS or your Linux distribution with a button combo.
2025-01-19 11:19:23 +00:00
2025-02-03 10:36:48 +00:00
## Can I use Ruffle to play Flash videos and not just games?
2025-02-03 10:31:31 +00:00
2025-02-03 09:21:23 +00:00
Yes, you can add Flash videos (.sfw files) to the `retrodeck/roms/flash/` folder to play them.
2025-02-03 10:31:31 +00:00
2025-02-03 09:21:23 +00:00
You might want to organize videos and games into separate subfolders, but it's optional.
2025-02-03 10:31:31 +00:00
**Example:**
```
retrodeck/roms/flash/videos/
retrodeck/roms/flash/games/
```