Difference between revisions of "Wiifuse"

From WiiBrew
Jump to: navigation, search
m (small fixes, no updates)
(v0.2.0 updates)
Line 1: Line 1:
wiifuse - coded by dhewg, [irc://irc.efnet.org/wiidev #wiidev efnet]
+
wiifuse - coded by dhewg, #wiidev efnet/blitzed
  
 
:based on [http://multimedia.cx/gcfuse/ gcfuse] code by:
 
:based on [http://multimedia.cx/gcfuse/ gcfuse] code by:
Line 5: Line 5:
 
:Copyright (C) 2005 Janusz Dziemidowicz (rraptorr at nails.eu.org)
 
:Copyright (C) 2005 Janusz Dziemidowicz (rraptorr at nails.eu.org)
  
*'''Latest stable version: [[#v0.1.2|v0.1.2]]'''
+
*'''Latest version: [[#v0.2.0|v0.2.0]]'''
*'''Current version: [[#v0.2.0-wip1|v0.2.0-wip1]]'''
 
  
 +
==About==
 +
wiifuse is a program that allows you to mount a Gamecube or Wii DVD disc image as a read-only part of the file system. This allows users to browse the directory structure and read the files within.
  
==Readme==
+
In contrast to the Gamecube, Wii images have multiple partitions. These are encrypted and wiifuse supports on-the-fly decryption - provided you have the required 128bit AES key.
  
===About===
+
Further, wiifuse provides access to special data found on these discs. Among others, this includes the main executable and informational things like the game's name.
:wiifuse is a program that allows you to mount a Gamecube or Wii DVD disc image as a read-only part of the file system. This allows users to browse the directory structure and read the files within.
 
  
:In contrast to the Gamecube, Wii images have multiple partitions. These are encrypted and wiifuse supports on-the-fly decryption - provided you have the required 128bit AES key.
+
Starting with version v0.2.0, you can also remotely mount your wii nand filesystem with [[Wiifuse_server|wiifuse_server]] and a usbgecko adapter.
  
:Further, wiifuse provides access to special data found on these discs. Among others, this includes the main executable and informational things like the game's name.
+
==Requirements==
 +
*An operating system which is supported by [http://fuse.sourceforge.net/ FUSE],
 +
*FUSE 2.6.x (or higher) and
 +
*[http://openssl.org/ OpenSSL]
  
===Requirements===
+
==Build==
:*An operating system which
+
To build wiifuse, you will need a working compiler and the development packages for the required libraries; have a look at the [[#OS-Specific Notes|OS-specific notes]].
:**is supported by [http://fuse.sourceforge.net/ FUSE],
 
:**supports POSIX compatible threads,
 
:*FUSE 2.6.x (or higher) and
 
:*[http://openssl.org/ OpenSSL]
 
  
===Build===
+
The archive includes a <tt>Makefile</tt>, so just run
:To build wiifuse, you will need a working compiler and the development packages for the required libraries; have a look at the [[#OS-Specific Notes|OS-specific notes]].
+
<code>'''make'''</code>
:The archive includes a <tt>Makefile</tt>, so just run
 
:<code>'''make'''</code>
 
  
===Usage===
+
==Usage==
:<code>'''./wiifuse <image_file> <mount_point> [<FUSE library options>]'''</code>
+
wiifuse v0.2.0
 +
coded by dhewg, #wiidev efnet/blitzed
 +
 +
usage: ./wiifuse [-v] <image file> <mount point> [<FUSE options>]
 +
  or
 +
        ./wiifuse [-v] -i <identity> <tty device> <mount_point> [<FUSE options>]
  
:Hints:
+
Hints:
:*Append <code>-f</code> for debug messages (process won't daemonize).
+
*Increase the verbose level with multiple '''-v''' arguments (up to three)
:*Append <code>-o allow_other</code> to let other users access the mount point.
+
*Append <code>-f</code> for debug messages (process won't daemonize).
:*Append <code>-h</code> for common FUSE library options.
+
*Append <code>-o allow_other</code> to let other users access the mount point.
:*Use <code>'''fusermount -u <mount_point>'''</code> to unmount a previously mounted image.
+
*Append <code>-h</code> for common FUSE library options.
 +
*Use '''fusermount -u <mount_point>''' to unmount a previously mounted image.
  
===Example===
+
==Example==
<code>
+
$ '''./wiifuse ~/zelda_tp.iso ~/wii_image -o allow_other'''
:'''$ ./wiifuse ~/zelda_tp.iso ~/wii_image -o allow_other'''
+
$ '''ls -l ~/wii_image'''
:$ ls -l ~/wii_image
+
total 0
</code>
+
lrwxrwxrwx 1 dhewg 1 Mar 15  2007 data -> partition2
<tt>
+
dr-xr-xr-x 4 dhewg 0 Mar 15  2007 partition0
:total 0
+
dr-xr-xr-x 6 dhewg 0 Mar 15  2007 partition1
:lrwxrwxrwx 1 dhewg 1 Mar 15  2007 data -> partition2
+
dr-xr-xr-x 6 dhewg 0 Mar 15  2007 partition2
:dr-xr-xr-x 4 dhewg 0 Mar 15  2007 partition0
+
lrwxrwxrwx 1 dhewg 1 Mar 15  2007 update -> partition1
:dr-xr-xr-x 6 dhewg 0 Mar 15  2007 partition1
+
$ '''cat ~/wii_image/data/header/name'''
:dr-xr-xr-x 6 dhewg 0 Mar 15  2007 partition2
+
The Legend of Zelda Twilight Princess
:lrwxrwxrwx 1 dhewg 1 Mar 15  2007 update -> partition1
+
$ '''mplayer ~/wii_image/data/fs/Movie/demo_movie98_00.thp'''
</tt>
+
$ '''fusermount -u ~/wii_image'''
<code>
 
:$ cat ~/wii_image/data/header/name
 
</code>
 
<tt>
 
:The Legend of Zelda Twilight Princess
 
</tt>
 
<code>
 
:$ mplayer ~/wii_image/data/fs/Movie/demo_movie98_00.thp
 
:$ fusermount -u ~/wii_image
 
</code>
 
 
 
 
 
===Troubleshooting===
 
:*Check if the FUSE kernel module is loaded:
 
:**linux: <code>'''lsmod | grep fuse'''</code>
 
:**freebsd: <code>kldstat | grep fuse</code>
 
:**OS X: <code>kextstat | grep fuse</code>
 
:*Verify your key file, the MD5-sum of the 16 byte file (without line feed) currently is <tt>8d1a2ebcd82a3469b77facf15d9c8e50</tt>.
 
:*Append <code>-d 2>&1 | tee ~/wiifuse.log</code> to the wiifuse cmdline. This will create a logfile called <tt>wiifuse.log</tt> in your home directory. Open it in your favorite text editor to get an idea of what's going wrong.
 
:If you still can't get it working, copy and paste the content of that logfile to something like [http://rafb.net/paste/ rafb] and /msg me (dhewg) the resulting link on IRC.
 
  
 +
==Troubleshooting==
 +
*Check if the FUSE kernel module is loaded:
 +
**linux: <tt>lsmod | grep fuse</tt>
 +
**freebsd: <tt>kldstat | grep fuse</tt>
 +
**OS X: <tt>kextstat | grep fuse</tt>
 +
*Verify your key file, the MD5-sum of the 16 byte file (without line feed) currently is <tt>8d1a2ebcd82a3469b77facf15d9c8e50</tt>.
  
 
==OS-Specific Notes==
 
==OS-Specific Notes==
  
 
===Debian / Ubuntu===
 
===Debian / Ubuntu===
:To install the binaries provided below, do the following:
+
To install the binaries provided below, do the following:
:<code>'''dpkg -i wiifuse_0.2.0-wip1-1_i386.deb'''</code>
+
<tt>dpkg -i wiifuse_0.2.0-wip1-1_i386.deb</tt>
  
:To build wiifuse you need to fetch these required packages:
+
To build wiifuse you need to fetch these required packages:
:<code>'''aptitude (or apt-get) install build-essential fuse-utils libfuse-dev libssl-dev'''</code>
+
<tt>apt-get install build-essential fuse-utils libfuse-dev libssl-dev</tt>
  
:To mount an image without root privileges, add the user to the <code>fuse</code> group:
+
To mount an image without root privileges, add the user to the <code>fuse</code> group:
:<code>'''adduser dhewg fuse'''</code>
+
<tt>adduser dhewg fuse</tt>
  
 
===Gentoo===
 
===Gentoo===
:*<code>'''emerge sys-fs/fuse'''</code>
+
<tt>emerge sys-fs/fuse</tt>
  
 
===FreeBSD===
 
===FreeBSD===
:Install the required ports:
+
Install the required ports:
:*'''sysutils/fusefs-kmod'''
+
*sysutils/fusefs-kmod
:*'''sysutils/fusefs-libs'''
+
*sysutils/fusefs-libs
  
:Further docs can be found [http://fuse4bsd.creo.hu/ here].
+
Further docs can be found [http://fuse4bsd.creo.hu/ here].
  
 
===OS X===
 
===OS X===
:Required software:
+
Required software:
:*[http://code.google.com/p/macfuse/ macfuse]
+
*[http://code.google.com/p/macfuse/ macfuse]
:*[http://developer.apple.com/tools/xcode/ Xcode]
+
*[http://developer.apple.com/tools/xcode/ Xcode]
  
 +
==Download==
  
==Download==
+
===v0.2.0===
 +
[[media:Wiifuse-0.2.0.tgz|wiifuse-0.2.0.tgz]]
  
 
===v0.2.0-wip1===
 
===v0.2.0-wip1===
:[[media:Wiifuse-0.2.0-wip1.tgz|wiifuse-0.2.0-wip1.tgz]]
+
[[media:Wiifuse-0.2.0-wip1.tgz|wiifuse-0.2.0-wip1.tgz]]
 
 
:Binary for Debian unstable (and probably latest Ubuntu as well):
 
::[[media:Wiifuse_0.2.0-wip1-1_i386.tgz|wiifuse_0.2.0-wip1-1_i386.tgz]]
 
  
 +
Binary for Debian unstable (and probably latest Ubuntu as well):
 +
:[[media:Wiifuse_0.2.0-wip1-1_i386.tgz|wiifuse_0.2.0-wip1-1_i386.tgz]]
  
 
===v0.1.2===
 
===v0.1.2===
:[[media:Wiifuse-0.1.2.tgz|wiifuse-0.1.2.tgz]]
+
[[media:Wiifuse-0.1.2.tgz|wiifuse-0.1.2.tgz]]
  
 
===v0.1.1===
 
===v0.1.1===
:[[media:Wiifuse-0.1.1.tgz|wiifuse-0.1.1.tgz]]
+
[[media:Wiifuse-0.1.1.tgz|wiifuse-0.1.1.tgz]]
  
  
 
==Changelog==
 
==Changelog==
  
:*v0.2.0-wip1
+
*v0.2.0
::*new client/server mode. requires an usb gecko and [[Wiifuse_server|wiifuse server]] running on a gamecube or wii in gc mode - for now ;)
+
:*completely revamped wiifuse_server, check [[Wiifuse_server|its page]] for details
::*new metadata: title id symlinks, tmd infos
+
 
 +
*v0.2.0-wip1
 +
:*new client/server mode. requires an usb gecko and [[Wiifuse_server|wiifuse server]] running on a gamecube or wii in gc mode - for now ;)
 +
:*new metadata: title id symlinks, tmd infos
  
:*v0.1.2
+
*v0.1.2
::*added more [[Wiidisc_IDs|disc id's]]
+
:*added more [[Wiidisc_IDs|disc id's]]
::*support for virtual console partitions (found 14 vc games on brawl)
+
:*support for virtual console partitions (found 14 vc games on brawl)
::*stat compliant - `du` works now
+
:*stat compliant - `du` works now
::*statvfs compliant - `df` works now
+
:*statvfs compliant - `df` works now
::*minor cleanups and fixes
+
:*minor cleanups and fixes
  
:*v0.1.1
+
*v0.1.1
::*fixed some serious u64 offset bugs
+
:*fixed some serious u64 offset bugs
::*corrected the main.dol size calculation
+
:*corrected the main.dol size calculation
::*some easy partition validation
+
:*some easy partition validation
::*support for symlinks
+
:*support for symlinks
::*cleaned up and extended the available metadata
+
:*cleaned up and extended the available metadata

Revision as of 23:25, 19 March 2008

wiifuse - coded by dhewg, #wiidev efnet/blitzed

based on gcfuse code by:
Copyright (C) 2006 Mike Melanson (mike at multimedia.cx)
Copyright (C) 2005 Janusz Dziemidowicz (rraptorr at nails.eu.org)

About

wiifuse is a program that allows you to mount a Gamecube or Wii DVD disc image as a read-only part of the file system. This allows users to browse the directory structure and read the files within.

In contrast to the Gamecube, Wii images have multiple partitions. These are encrypted and wiifuse supports on-the-fly decryption - provided you have the required 128bit AES key.

Further, wiifuse provides access to special data found on these discs. Among others, this includes the main executable and informational things like the game's name.

Starting with version v0.2.0, you can also remotely mount your wii nand filesystem with wiifuse_server and a usbgecko adapter.

Requirements

  • An operating system which is supported by FUSE,
  • FUSE 2.6.x (or higher) and
  • OpenSSL

Build

To build wiifuse, you will need a working compiler and the development packages for the required libraries; have a look at the OS-specific notes.

The archive includes a Makefile, so just run make

Usage

wiifuse v0.2.0
coded by dhewg, #wiidev efnet/blitzed

usage: ./wiifuse [-v] <image file> <mount point> [<FUSE options>]
  or
       ./wiifuse [-v] -i <identity> <tty device> <mount_point> [<FUSE options>]

Hints:

  • Increase the verbose level with multiple -v arguments (up to three)
  • Append -f for debug messages (process won't daemonize).
  • Append -o allow_other to let other users access the mount point.
  • Append -h for common FUSE library options.
  • Use fusermount -u <mount_point> to unmount a previously mounted image.

Example

$ ./wiifuse ~/zelda_tp.iso ~/wii_image -o allow_other
$ ls -l ~/wii_image
total 0
lrwxrwxrwx 1 dhewg 1 Mar 15  2007 data -> partition2
dr-xr-xr-x 4 dhewg 0 Mar 15  2007 partition0
dr-xr-xr-x 6 dhewg 0 Mar 15  2007 partition1
dr-xr-xr-x 6 dhewg 0 Mar 15  2007 partition2
lrwxrwxrwx 1 dhewg 1 Mar 15  2007 update -> partition1
$ cat ~/wii_image/data/header/name
The Legend of Zelda Twilight Princess
$ mplayer ~/wii_image/data/fs/Movie/demo_movie98_00.thp
$ fusermount -u ~/wii_image

Troubleshooting

  • Check if the FUSE kernel module is loaded:
    • linux: lsmod | grep fuse
    • freebsd: kldstat | grep fuse
    • OS X: kextstat | grep fuse
  • Verify your key file, the MD5-sum of the 16 byte file (without line feed) currently is 8d1a2ebcd82a3469b77facf15d9c8e50.

OS-Specific Notes

Debian / Ubuntu

To install the binaries provided below, do the following: dpkg -i wiifuse_0.2.0-wip1-1_i386.deb

To build wiifuse you need to fetch these required packages: apt-get install build-essential fuse-utils libfuse-dev libssl-dev

To mount an image without root privileges, add the user to the fuse group: adduser dhewg fuse

Gentoo

emerge sys-fs/fuse

FreeBSD

Install the required ports:

  • sysutils/fusefs-kmod
  • sysutils/fusefs-libs

Further docs can be found here.

OS X

Required software:

Download

v0.2.0

wiifuse-0.2.0.tgz

v0.2.0-wip1

wiifuse-0.2.0-wip1.tgz

Binary for Debian unstable (and probably latest Ubuntu as well):

wiifuse_0.2.0-wip1-1_i386.tgz

v0.1.2

wiifuse-0.1.2.tgz

v0.1.1

wiifuse-0.1.1.tgz


Changelog

  • v0.2.0
  • completely revamped wiifuse_server, check its page for details
  • v0.2.0-wip1
  • new client/server mode. requires an usb gecko and wiifuse server running on a gamecube or wii in gc mode - for now ;)
  • new metadata: title id symlinks, tmd infos
  • v0.1.2
  • added more disc id's
  • support for virtual console partitions (found 14 vc games on brawl)
  • stat compliant - `du` works now
  • statvfs compliant - `df` works now
  • minor cleanups and fixes
  • v0.1.1
  • fixed some serious u64 offset bugs
  • corrected the main.dol size calculation
  • some easy partition validation
  • support for symlinks
  • cleaned up and extended the available metadata