FS-UAE

https://fs-uae.net/docs/
Admin
FS-UAE provides comprehensive documentation and guides for users to set up, configure, and...
Tokens:86,261
Snippets:1,591
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install openSUSE Build Dependencies

Source: https://fs-uae.net/docs/compiling

Installs necessary packages for building FS-UAE on openSUSE systems.

```bash
sudo zypper install SDL2-devel glib2-devel libpng-devel gettext \
    freetype2-devel gcc gcc-c++ openal-devel libXi-devel zip
```

--------------------------------

### Configure and Build FS-UAE

Source: https://fs-uae.net/docs/compiling

Configures the build environment and compiles FS-UAE. Run this after installing dependencies.

```bash
./configure
make
```

--------------------------------

### Example Input Actions

Source: https://fs-uae.net/docs/input-mapping

These are examples of available input actions that can be mapped. Refer to the full list for all available options.

```plaintext
action_joy_1_fire_button          (fire button on joystick in port 1)
```

```plaintext
action_key_z                      (press amiga keyboard key Z)
```

```plaintext
action_drive_0_insert_floppy_0    (insert disk from floppy image list)
```

--------------------------------

### Install Ubuntu/Debian Build Dependencies

Source: https://fs-uae.net/docs/compiling

Installs necessary packages for building FS-UAE on Ubuntu or Debian systems.

```bash
sudo apt-get install libsdl2-dev libglib2.0-dev libpng-dev gettext \
    libfreetype6-dev build-essential libopenal-dev libxi-dev zip \
    libmpeg2-4-dev
```

--------------------------------

### Example Output of Readable Mouse Devices

Source: https://fs-uae.net/docs/mouse

This is an example of the expected output after successfully applying udev rules and reconnecting mice. It shows that the event files have read permissions for all users.

```text
crw-rw-r-- 1 root input 13, 64 aug.  20 17:30 /dev/input/event0
crw-rw-r-- 1 root input 13, 65 aug.  20 17:30 /dev/input/event1

```

--------------------------------

### Amiga File Permissions Metadata Example

Source: https://fs-uae.net/docs/hard-drives

This is an example of the content found in an Amiga metadata file (.uaem). It shows file permissions, date/time, and a file comment.

```text
----rwed 2013-02-12 21:20:52.02 hello


```

--------------------------------

### Test Sound Card Setting

Source: https://fs-uae.net/docs/options/sound_card

These examples demonstrate how to test the 'sound_card' option with correct values, correct casing, mis-spelled names, and default value scenarios.

```shell
> sound_card = toccata
sound_card = toccata
```

```shell
> sound_card = Toccata
sound_card = toccata
```

```shell
> sound_card = tocata
sound_card = 0
```

```shell
> amiga_model = A500
sound_card = 0
```

--------------------------------

### Install openSUSE Bootstrap Dependencies

Source: https://fs-uae.net/docs/compiling

Installs packages required for the bootstrap script on openSUSE.

```bash
sudo zypper install autoconf automake libtool gettext
```

--------------------------------

### Run FS-UAE from Source

Source: https://fs-uae.net/docs/compiling

Executes the compiled FS-UAE binary directly from the source directory without installation.

```bash
./fs-uae
```

--------------------------------

### Modify Auto-Scaling with Viewport Patterns

Source: https://fs-uae.net/docs/options/viewport

Provide patterns to replace auto-scaling decisions. This example forces the top parameter to 20 when the auto-scaling algorithm detects a 640x400 viewport starting 74 from the left.

```config
viewport = 74 * 640 400 => * 20 * *
```

--------------------------------

### Install Ubuntu/Debian Bootstrap Dependencies

Source: https://fs-uae.net/docs/compiling

Installs packages required for the bootstrap script on Ubuntu or Debian.

```bash
sudo apt-get install autoconf automake libtool gettext pkgconf
```

--------------------------------

### WHDLoad Quit Key Example

Source: https://fs-uae.net/docs/options/whdload_quit_key

Example of registering a key for WHDLoad slave termination. FS-UAE injects this keycode into the Amiga emulation to signal the slave to quit. This is useful when the Amiga emulation needs to be explicitly told to exit a WHDLoad slave.

```text
45
```

--------------------------------

### FS-UAE Bridgeboard and VGA Configuration Example

Source: https://fs-uae.net/docs/bridgeboard

This configuration enables Bridgeboard emulation with a specific ROM file and options, and sets up a VGA graphics card with a specified ROM file. It also configures the second floppy drive type.

```ini
uae_a2386_rom_file = A2386SX 1.00 391168-01.bin
uae_a2386_rom_options = 8M,config=
uae_flash_file = flash.nvr
uae_gfxcard_type = VGA
uae_gfxcard_size = 2
uae_x86vga_rom_file = 5420.vbi
uae_floppy2type = 5
```

--------------------------------

### Install Joystick Support on Fedora

Source: https://fs-uae.net/docs/faq

On Fedora 17 and later, install this package to enable joystick functionality for FS-UAE and other applications.

```bash
sudo yum install kernel-modules-extra

```

--------------------------------

### Launch HDToolBox with uaehf.device

Source: https://fs-uae.net/docs/hard-drives

Use this command to start HDToolBox and specify the uaehf.device for accessing the hard drive image. This is necessary for partitioning an empty HDF file.

```shell
DF0:Tools/HDToolBox uaehf.device

```

--------------------------------

### Run FS-UAE from Source Directory

Source: https://fs-uae.net/docs/debugging

Execute FS-UAE directly from the source directory without installation. This is useful for testing changes or running a debug version.

```bash
./fs-uae <optional args>
```

--------------------------------

### Map Game Actions to First Gamepad (Keyboard Replacement)

Source: https://fs-uae.net/docs/input-mapping

Example of mapping specific game actions to the first connected gamepad, effectively replacing keyboard controls for certain functions.

```text
joystick_0_left_shoulder = action_key_shift_left
joystick_0_right_shoulder = action_key_shift_right
joystick_0_north_button = action_key_f1
joystick_0_dpad_down = action_key_cursor_down

```

--------------------------------

### Force Aspect Ratio Example

Source: https://fs-uae.net/docs/options/force_aspect

Use this option to specify a forced output aspect ratio, such as 4:3. This ensures a stable output size, especially when combined with auto zoom.

```ini
force_aspect = 1.3333333333333333

```

--------------------------------

### uae_sana2 Explicit Configuration Example

Source: https://fs-uae.net/docs/options/uae_sana2

This snippet shows how to check and set the uae_sana2 explicit value. Use this when you need to explicitly define the UAE boolean setting.

```python
if c.uae_sana2.explicit:
    # FIXME: ok? keep already specified value
    value = c.uae_rtc.explicit
    # FIXME: match and normalize uae boolean
else:
    value = "false"
```

--------------------------------

### Joystick Name Conversion Example

Source: https://fs-uae.net/docs/input-mapping

Illustrates the conversion of a complex device name to the format used by FS-UAE for matching.

```text
Controller (Xbox 360 Wireless Receiver)

```

```text
controller_xbox_360_wireless_receiver

```

--------------------------------

### Create a Virtual Serial Port with socat

Source: https://fs-uae.net/docs/serial-port

Example command to create a virtual serial port using `socat`. This is useful for testing serial port communication without a physical device.

```bash
socat pty,raw,echo=0,link=/tmp/virtual-serial-port -,raw,echo=0

```

--------------------------------

### Copy AmiKit to Transfer Drive

Source: https://fs-uae.net/docs/amikit

Copies the AmiKit installation to a temporary transfer drive within WinUAE. Ensure the source and destination paths are correct.

```shell
copy AmiKit: AmiKitTransfer: all quiet clone
```

--------------------------------

### Example Game for VRR Verification

Source: https://fs-uae.net/docs/variable-refresh-rate

Use a game with constant horizontal scrolling to visually check if G-SYNC/FreeSync is working. Micro-stuttering in windowed mode should disappear in fullscreen when VRR is active.

```text
War Zone (1991)(Core)[cr Flashtro][t +26 Flashtro]
```

--------------------------------

### Map Keyboard 'q' to Joystick Fire Button

Source: https://fs-uae.net/docs/input-mapping

This example demonstrates mapping the 'q' key on your keyboard to the primary Amiga joystick's fire button. 'joy_1' refers to the joystick in port 1.

```plaintext
keyboard_key_q = action_joy_1_fire_button
```

--------------------------------

### Install Amiga Forever using Wine

Source: https://fs-uae.net/docs/amiga-forever

Installs Amiga Forever Plus edition using Wine on Linux. Ensure you have the MSI installer available.

```bash
wine msiexec /i ~/Downloads/AmigaForever2016Plus.msi
```

--------------------------------

### Copy Transfer Drive to AmiKit Installer

Source: https://fs-uae.net/docs/amikit

Copies the contents from the transfer drive to the final AmiKit installer directory within FS-UAE. This step is crucial for creating the installer archive.

```shell
copy AmiKitTransfer: AmiKit: all quiet clone
```

--------------------------------

### Copy Amiga Forever Files after Wine Installation

Source: https://fs-uae.net/docs/amiga-forever

Copies the installed Amiga Forever files to the FS-UAE directory after a Wine installation. This assumes a default Wine prefix and FS-UAE base directory.

```bash
cd ~/Documents/FS-UAE
mkdir AmigaForever
cd AmigaForever
cp -a ~/.wine/drive_c/users/Public/Documents/"Amiga Files" .
```

--------------------------------

### Mounting a Local Folder as a Drive

Source: https://fs-uae.net/docs/options/hard_drive_0

Mount a folder from your computer as a drive by pointing the 'hard_drive_0' option to the folder path.

```ini
hard_drive_0 = path/to/folder
```

--------------------------------

### Run Bootstrap Script

Source: https://fs-uae.net/docs/compiling

Generates configuration files. This command is typically only needed when building from a git repository.

```bash
./bootstrap
```

--------------------------------

### Configure Floppy Images for Swapping

Source: https://fs-uae.net/docs/options/floppy_image_0

List all floppy images that should appear in the floppy list to enable floppy-swapping. Up to 20 images can be configured.

```ini
floppy_image_0 = path/to/adf_or_ipf
floppy_image_1 = path/to/adf_or_ipf
floppy_image_2 = path/to/adf_or_ipf
floppy_image_3 = path/to/adf_or_ipf
floppy_image_4 = path/to/adf_or_ipf
...
floppy_image_19 = path/to/adf_or_ipf
```

--------------------------------

### Joystick Event Names

Source: https://fs-uae.net/docs/input-mapping

These are examples of joystick event names you can use for mapping. 'joystick_0' is the first joystick, and 'button_0' is its first button.

```plaintext
joystick_0_button_0
```

```plaintext
joystick_0_axis_0_neg
```

```plaintext
joystick_0_axis_0_pos
```

```plaintext
joystick_0_hat_0_up
```

```plaintext
joystick_0_hat_0_down
```

```plaintext
joystick_0_hat_0_left
```

```plaintext
joystick_0_hat_0_right
```

--------------------------------

### Enable .uaem File Creation with File Notes

Source: https://fs-uae.net/docs/options/uaem_write_flags

Use the 'n' flag to create .uaem files only when file notes are added. This is recommended for compatibility with some software.

```ini
uaem_write_flags = n
```

--------------------------------

### Configure Munt MT-32 Emulation on Linux

Source: https://fs-uae.net/docs/midi

On Linux, use `midi:Standard` for the `serial_port` option to route MIDI output to the ALSA sequencer set up by `mt32emu-qt`.

```ini
serial_port = midi:Standard
```

--------------------------------

### Placeholder Code Example

Source: https://fs-uae.net/docs/options/floppy_drive_0

This snippet appears to be a placeholder or a minimal valid entry, often used in configuration files to indicate a default or pass-through state.

```config
pass

```

--------------------------------

### Specify Floppy Image Path with Prefix

Source: https://fs-uae.net/docs/options/floppy_drive_0

Use the $exe prefix to specify a floppy image located in the directory containing the FS-UAE executable. This is useful for organizing game disks with the application.

```config
$exe/Disk1.adf

```

--------------------------------

### Enable .uaem File Creation with Notes and Protection Bits

Source: https://fs-uae.net/docs/options/uaem_write_flags

Combine 'n' with other flags like 'h', 's', 'p', 'a', 'r', 'w', 'e', 'd' to create .uaem files when file notes are added or non-default protection bits are set.

```ini
uaem_write_flags = nhsparwed
```

--------------------------------

### Multiple Viewport Patterns for Pinball Dreams

Source: https://fs-uae.net/docs/options/viewport

Use multiple patterns separated by commas; the first match is applied. This example preserves the specific viewport for Pinball Dreams and applies a default to others.

```config
viewport = 74 28 640 524 => * * * *, * * * * => 74 36 640 512
```

--------------------------------

### Amiga Model to Kickstart SHA1 Mapping

Source: https://fs-uae.net/docs/options/int_kickstart_ext_sha1

This code snippet maps different Amiga models to their corresponding Kickstart ROM SHA1 hash values. It's used to identify the correct Kickstart ROM for emulation.

```Python
t = c.amiga_model if t == “A500”: value = “” elif t == “A500/512K”: value = “” elif t == “A500+”: value = “” elif t == “A600”: value = “” elif t == “A1000”: value = “” elif t == “A1200”: value = “” elif t == “A1200/3.0”: value = “” elif t == “A1200/020”: value = “” elif t == “A1200/1230”: value = “” elif t == “A1200/1240”: value = “” elif t == “A1200/1260”: value = “” elif t == “A1200/PPC”: value = “” elif t == “A3000”: value = “” elif t == “A4000”: value = “” elif t == “A4000/040”: value = “” elif t == “A4000/OS4”: value = “” elif t == “A4000/PPC”: value = “” elif t == “CD32”: value = “5bef3d628ce59cc02a66e6e4ae0da48f60e78f7f” elif t == “CD32/FMV”: value = “5bef3d628ce59cc02a66e6e4ae0da48f60e78f7f” elif t == “CDTV”: value = “7ba40ffa17e500ed9fed041f3424bd81d9c907be” else: f.fail(“Unknown amiga_model: “ + t)
```
Tokens:
Raw