From 66fca096eac738cfa836f2a5c87cd7d68b36ccbe Mon Sep 17 00:00:00 2001 From: Thierry Crozat Date: Wed, 25 Aug 2021 02:18:54 +0100 Subject: [PATCH] DOC: The mac file dumper companions only support HFS media --- doc/docportal/advanced_topics/mac_game_files.rst | 16 +++++++++++----- doc/docportal/use_scummvm/game_files.rst | 2 +- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/docportal/advanced_topics/mac_game_files.rst b/doc/docportal/advanced_topics/mac_game_files.rst index 07691ba25e7..4fb79c596ed 100644 --- a/doc/docportal/advanced_topics/mac_game_files.rst +++ b/doc/docportal/advanced_topics/mac_game_files.rst @@ -11,7 +11,7 @@ HFS and HFS+ File system The Macintosh uses a different file system to other operating systems (HFS for older media, and HFS+ for more recent ones). On a Windows or Linux system you need additional software to view and copy the files from HFS and HFS+ floppy disks and CDs. -HFS, Hierarchical File System, or Mac OS Standard, was used on Macintosh hard disk, floppy disks, and CDs until the late 90s. It was replaced by HFS+, or Mac OS Extended, with the release of Mac OS 8.1 in 1998. Modern macOS computer can still access HFS+ media, but support for reading HFS media was dropped in macOS 10.15 (Catalina). +HFS, Hierarchical File System, or Mac OS Standard, was used on Macintosh hard disk, floppy disks, and CDs until the late 90s. It was superseded by HFS+, or Mac OS Extended, with the release of Mac OS 8.1 in 1998. But most game CDs released before the mid-2000 still use HFS. Modern macOS computer can still access HFS+ media, but support for reading HFS media was dropped in macOS 10.15 (Catalina). Other systems, such as Linux and Windows, require an additional software to read HFS and HFS+ media. @@ -51,7 +51,11 @@ For more information: Macintosh File Dumper ===================== -ScummVM supplies two versions of dumper-companion: a disk/iso image only one that runs in the browser and a more full fledged one in python. Those dumper can extract files from a HFS or HFS+ medium, encode files to MacBinary and rename files with Punycode if needed. +ScummVM supplies two versions of dumper-companion: a disk/iso image only one that runs in the browser and a more full fledged one in python. Those dumper can extract files from a HFS medium, encode files to MacBinary and rename files with Punycode if needed. + +.. note:: + + The dumper companions only suports HFS disks (except for the python dumper companion in MAC mode which also supports HFS+, but requires having a Macintosh). Most, if not all, Macintosh games supported by ScummVM were released on a HFS medium. But if you do have a HFS+ CD then you can check the :ref:`macfileaccessother` section. Create ISO image ----------------- @@ -60,7 +64,7 @@ The first step is to create an ISO image of your floppy or CD medium. .. note:: - This step is not needed on macOS for HFS+ media (and HFS media on a macOS 10.14 Mojave system or older) when using the Python dumper. + This step is not needed on macOS for HFS+ media (and HFS media on a macOS 10.14 Mojave system or older) when using the Python dumper in MAC mode. .. tabbed:: Windows @@ -170,7 +174,7 @@ Browser based dumper companion ``_ -The browser based dumper companion has support for reading HFS and HFS+ as isos and disk images such as floppies. It generates a zip file that can be extracted and imported in ScummVM. +The browser based dumper companion has support for reading HFS as isos and disk images such as floppies. It generates a zip file that can be extracted and imported in ScummVM. It's options are: * Language: Choose Japanese when dumping Japanese disks @@ -237,7 +241,7 @@ The dumper-companion has help text: ISO mode +++++++++ -This mode will dump a HFS or HFS+ iso to the OUTPUT directory. This directory can then be added to scummvm. +This mode will dump a HFS iso to the OUTPUT directory. This directory can then be added to scummvm. .. code-block:: @@ -272,6 +276,8 @@ Options: On macOS ScummVM directly access data and resource forks. But converting to MacBinary can be useful if you plan to transfer those files to a different system. +.. _macfileaccessother: + Other methods ============== diff --git a/doc/docportal/use_scummvm/game_files.rst b/doc/docportal/use_scummvm/game_files.rst index d84117eeede..71462faaa64 100644 --- a/doc/docportal/use_scummvm/game_files.rst +++ b/doc/docportal/use_scummvm/game_files.rst @@ -74,7 +74,7 @@ There are three main aspects of Macintosh floppy or CD media that can make it di * Macintosh HFS and HFS+ media have a concept called forks. For those familiar with NTFS, it's the same principle as NTFS streams. A file can consist of two forks, a data fork and a resource fork. Both are important for games to work correctly. Systems other than macOS do not support resource forks, and a regular file copy from a HFS or HFS+ media on such a system will only copy the data fork. To properly preserve the resource fork during the copy, those files need to be converted to a MacBinary file. * File names on a Macintosh medium may contain characters not supported on other systems, and thus files may need to be renamed. -ScummVM supplies a dumper-companion that can extract data files from the iso image of a HFS or HFS+ medium an dump it as a zip file. Files with a resource forks are automatically converted to MacBinary files. And files are renamed if needed. +ScummVM supplies a dumper-companion that can extract data files from the iso image of a HFS medium and dump it as a zip file. Files with a resource forks are automatically converted to MacBinary files. And files are renamed if needed. 1. Upload your iso here: ``_ 2. Click the dump button