Paths and Directories

By default, FS-UAE creates a number of directories in Documents/FS-UAE to store the files used by FS-UAE: CD-ROMs, Configurations, Controllers, Flash Memory, Floppies, Floppy Overlays, Hard Drives, Kickstarts, Logs, Save States.

In addition, if you use FS-UAE Launcher, it will create a directory of its own: Documents/FS-UAE/Launcher. The following directories can be used by FS-UAE and/or the Launcher if found in Documents/FS-UAE: Covers, Screenshots, Titles, Themes.

See “Specifying Paths in Configuration Files” in Configuration Files instead if you are looking for information about the different ways of referring to directories and files in FS-UAE.

Base Directory

By default, FS-UAE creates its directories under Documents/FS-UAE. For Linux users: If your Documents directory is not configured according to the XDG user dir spec, ~/FS-UAE will be used as a fallback.

You can override this by putting the path to the desired base directory in a special config file. The config file will be read by both FS-UAE and FS-UAE Launcher if it exists:

  • Windows: <LOCALAPPDATA>/fs-uae/base-dir
  • OS X: ~/Library/Preferences/fs-uae/base-dir
  • Linux/other: ~/.config/fs-uae/base-dir

Alternatively, you can starting FS-UAE and/or FS-UAE Launcher with --base-dir=/path/to/desired/dir

Media Directories

The following directories are created as default locations to hold your Amiga media:

  • CD-ROMs
  • Floppies
  • Hard Drives

The location and names of these directories can be overridden with the following options in config files: cdroms_dir, floppies_dir, hard_drives_dir.

You do not have to store your Amiga files here, but when media are located in one of these directories (or a sub-directory), you can refer to contained files without using full paths. For example a floppy image file called Lotus2.adf stored in the Floppies directory can be inserted into the first floppy drive with this option:

floppy_drive_0 = Lotus2.adf

If the file is located outside the Floppies directory, you must instead use an absolute path or one of the other ways to specify paths.

Covers, Screenshots and Titles for FS-UAE Launcher

See the FS-UAE Launcher page for information about the structure of the following directories:

  • Covers (front covers of game boxes)
  • Screenshots
  • Titles (Screenshot of the game title screen)

 WHDLoad Directory

The WHDLoad directory has a special purpose when the WHDLoad feature of FS-UAE Launcher is used. This is explained further in the WHDLoad feature documentation.

Note: This directory is no longer used with recent development versions (2.1.16+). FS-UAE Launcher automatically assembles the WHDLoad directory by itself.

34 thoughts on “Paths and Directories

  1. OK, I am waiting for it…. There is any possibility to get notification when the new build will be available?

  2. I would like to use FS-UAE (2.7.2) on OS X (10.11) with base-dir override but unfortunately I cannot get working with using the base-dir config file method. I created the config file on the ~/Library/Preferences/fs-uae-launcher/ location but if I start the launcher that is exit immediately. After I started from the terminal I got the following log:

    /Applications/FS-UAE\ Launcher.app/Contents/MacOS/fs-uae-launcher
    executable_dir
    sys.executable = /Applications/FS-UAE Launcher.app/Contents/MacOS/fs-uae-launcher
    executable_dir = /Applications/FS-UAE Launcher.app/Contents/MacOS
    checking /Applications/FS-UAE Launcher.app/Contents/MacOS/Portable.ini
    checking /Applications/FS-UAE Launcher.app/Contents/Portable.ini
    checking /Applications/FS-UAE Launcher.app/Portable.ini
    checking /Applications/Portable.ini
    checking /Portable.ini
    no Portable.ini found in search path
    base_dir not decided yet, checking FS_UAE_BASE_DIR
    using default base_dir
    – checking /Users/amiga/Library/Preferences/fs-uae-launcher/base-dir
    base dir is /

    So as I see the input parsing is ignore the path in the base-dir file and want to use a simple slash instead…
    Using the –base-dir command line option with same path (in base-dir config file) the launcher working fine.

    On the other hand when I tried using the relative path in –base-dir option I experienced the following:

    /Applications/FS-UAE\ Launcher.app/Contents/MacOS/fs-uae-launcher –base-dir=~/CloudStation/FS-UAE/
    setting base_dir
    base_dir was specified so we will not check for portable dir
    base dir is /Users/amiga/~/CloudStation/FS-UAE

    • What is the content of /Users/amiga/Library/Preferences/fs-uae-launcher/base-dir?

      Btw, you shouldn’t use --base-dir=~/CloudStation/FS-UAE/ – that will not work as you expect (since ~ is not the first character in the string). Use --base-dir=$HOME/CloudStation/FS-UAE/ instead.

        • Hi, the problem was the trailing slash (due to a bug – I have fixed that now). Instead of waiting for the new version, you can “fix” it by removing the trailing slash (i.e. change to /Users/amiga/CloudStation/FS-UAE).

          • Hello,
            I tested your suggested fix, but unfortunately does not work as I experienced.
            So FS-UAE Launcher can start in this case but did not use the configured path instead create the empty folder structure on the default location…

          • Hmm, OK, strange. Please wait for 2.7.4dev (due out soon), test with that version, and report back 🙂

  3. This is sort of a pet peeve of mine, I can’t change the Configurations and Themes directories. How do I change them?

    Here’s a section of my FS-UAE config file:

    base_dir = ~/.fs-uae
    cdroms_dir = ~/.fs-uae/cdrom
    configurations_dir = ~/.fs-uae/extconfig
    controllers_dir = ~/.fs-uae/ctrlconf
    flash_memory_dir = ~/.fs-uae/memsave
    floppies_dir = ~/.fs-uae/floppy
    floppy_overlays_dir = ~/.fs-uae/overlay
    hard_drives_dir = ~/.fs-uae/hdd
    kickstarts_dir = ~/.fs-uae/kickstart
    logs_dir = ~/.fs-uae/log
    save_states_dir = ~/.fs-uae/state
    screenshots_output_dir = ~/.fs-uae/screenshot
    theme = ~/.fs-uae/theme/

    No matter what I do, the directories “Themes” and “Configurations” are always created.

    • Hi, I have fixed this for the next development version. You should also add the following config to change the “Themes” dir:
      themes_dir = ~/.fs-uae/theme/

      And the following for use with the development versions’ “Cache” dir:
      cache_dir = ~/.fs-uae/cache/

      Tip: Instead of putting the directories in config files, you can put them in special files such as (Note the dash instead of underline):
      $HOME/.config/fs-uae/base-dir
      $HOME/.config/fs-uae/configurations-dir
      (etc)

      The advantage of this is that the options does not have to be repeated in every configuration file, and it also makes your directory overrides work even when not loading a config file at all. This feature may require the development version.

      • Thank you so much for a very fast reply, you truly are a wonderful developer working on an equally wonderful emulator.

        I’m using Debian Sid, so I’ve already decided to comment out those lines until another release can come to it.

        I’m curious about those base-dir and configurations-dir files. Is all that you’re supposed to put in there just the name of the directory as an absolute/relative path? So like:

        echo ‘~/.fs-uae’ > base-dir
        echo ‘~/.fs-uae/config’ > configurations-dir

        • Correct, the paths in those files needs to be absolute paths, but I also expand ~/ or $HOME/ so you can begin with those 🙂

Leave a Reply

Your email address will not be published. Required fields are marked *