From fde943c97f34dc95c0d33b51835e912861a75db6 Mon Sep 17 00:00:00 2001 From: icex2 Date: Fri, 19 Mar 2021 16:45:08 +0100 Subject: [PATCH] doc/hook: Clarify a bunch of things regarding dependencies - Ephasize that the games are 32-bit - Add note about pumpnet curl deps - Add note about indirect deps not being covered in docs --- doc/hook/exchook.md | 5 +++++ doc/hook/hook.md | 5 +++++ doc/hook/mk3hook.md | 5 +++++ doc/hook/nx2hook.md | 11 +++++++++++ doc/hook/nxahook.md | 11 +++++++++++ doc/hook/nxhook.md | 5 +++++ doc/hook/pro2hook.md | 5 +++++ doc/hook/prohook.md | 5 +++++ doc/hook/x2hook.md | 5 +++++ doc/hook/zerohook.md | 5 +++++ 10 files changed, 62 insertions(+) diff --git a/doc/hook/exchook.md b/doc/hook/exchook.md index f680a60..c3cb943 100644 --- a/doc/hook/exchook.md +++ b/doc/hook/exchook.md @@ -17,6 +17,8 @@ possible (at least not right now). Make sure to read the different methods of dependency resolution available in the [main hook readme file](../hook.md), first. +Note: Game is 32-bit, so you need to install the 32-bit versions of the dependencies! + The following **direct** dependencies (cmd: `readelf -d piu`) are required: * libGL.so.1 * libGLU.so.1 @@ -39,6 +41,9 @@ As for method 1, when using Ubuntu, the dependencies can be found in the followi * zlib1g * libasound2 +Further indirect dependencies are needed but should be taken care of automatically when using a package manager to +install the direct dependencies. + ## Data setup In additional to the [general information applying to **all** hooks](../hook.md#data-setup), this game requires all files and folders in the `game` folder to be in **UPPERCASE** on a case-sensitive file system. diff --git a/doc/hook/hook.md b/doc/hook/hook.md index 0c56aa5..3deedfc 100644 --- a/doc/hook/hook.md +++ b/doc/hook/hook.md @@ -23,6 +23,11 @@ Check each of the dedicated hook readmes which games and versions are supported. Pumptool's hook libraries aim for having no dependencies other than what is already required by the different games to run. +Since all games available so far are compiled as 32-bit binaries, naturally, it requires you to install +the 32-bit versions of the dependencies (if you are not running a 32-bit distributed). +Note the `:i386` postfix for packages in the command further below. This is required if you are on a 64-bit +distribution. + However, there are some exceptions that require additional libraries in order to allow the following features to work correctly: * Hook libraries, e.g. `nx2hook` that support network features, e.g. usb profiles with pumpnet diff --git a/doc/hook/mk3hook.md b/doc/hook/mk3hook.md index 329d98b..4b99090 100644 --- a/doc/hook/mk3hook.md +++ b/doc/hook/mk3hook.md @@ -39,6 +39,8 @@ for details. Make sure to read the different methods of dependency resolution available in the [main hook readme file](../hook.md), first. +Note: Game is 32-bit, so you need to install the 32-bit versions of the dependencies! + The following **direct** dependencies (cmd: `readelf -d piu`) are required by all Linux ports: * libGL.so.1 * libX11.so.6 @@ -70,6 +72,9 @@ As for method 1, when using Ubuntu, the dependencies can be found in the followi * libx11-6 * libasound2 +Further indirect dependencies are needed but should be taken care of automatically when using a package manager to +install the direct dependencies. + ## Data setup In additional to the [general information applying to **all** hooks](../hook.md#data-setup), the following information goes for a clean set of data from a pristine/non-bootleg CD. diff --git a/doc/hook/nx2hook.md b/doc/hook/nx2hook.md index 9ef978e..39baa8b 100644 --- a/doc/hook/nx2hook.md +++ b/doc/hook/nx2hook.md @@ -13,6 +13,8 @@ All known versions supported. Make sure to read the different methods of dependency resolution available in the [main hook readme file](../hook.md), first. +Note: Game is 32-bit, so you need to install the 32-bit versions of the dependencies! + The following **direct** dependencies (cmd: `readelf -d piu`) are required: * libfreetype.so.6 * librt.so.1 @@ -38,6 +40,15 @@ As for method 1, when using Ubuntu, the dependencies can be found in the followi * libusb-0.1-4 * libasound2 +Additionally, `nx2hook` needs the following **direct** dependencies for pumpnet: +* libcurl-gnutls.so.4 + +Ubuntu packages for `nx2hook` dependencies for pumpnet: +* libcurl4-gnutls + +Further indirect dependencies are needed but should be taken care of automatically when using a package manager to +install the direct dependencies. + ## Data setup In additional to the [general information applying to **all** hooks](../hook.md#data-setup), this game requires all files and folders from the original `game` folder to be in **UPPERCASE** on a case-sensitive file system with the diff --git a/doc/hook/nxahook.md b/doc/hook/nxahook.md index df9f414..3fc32fa 100644 --- a/doc/hook/nxahook.md +++ b/doc/hook/nxahook.md @@ -13,6 +13,8 @@ All known versions supported. Make sure to read the different methods of dependency resolution available in the [main hook readme file](../hook.md), first. +Note: Game is 32-bit, so you need to install the 32-bit versions of the dependencies! + The following **direct** dependencies (cmd: `readelf -d piu`) are required: * libfreetype.so.6 * librt.so.1 @@ -40,6 +42,15 @@ As for method 1, when using Ubuntu, the dependencies can be found in the followi * libusb-0.1-4 * libasound2 +Additionally, `nxahook` needs the following **direct** dependencies for pumpnet: +* libcurl-gnutls.so.4 + +Ubuntu packages for `nxahook` dependencies for pumpnet: +* libcurl4-gnutls + +Further indirect dependencies are needed but should be taken care of automatically when using a package manager to +install the direct dependencies. + ## Data setup In additional to the [general information applying to **all** hooks](../hook.md#data-setup), this game requires all files and folders from the original `game` folder to be in **UPPERCASE** on a case-sensitive file system. Further game diff --git a/doc/hook/nxhook.md b/doc/hook/nxhook.md index 69eeec5..4db1920 100644 --- a/doc/hook/nxhook.md +++ b/doc/hook/nxhook.md @@ -9,6 +9,8 @@ All known versions supported. Make sure to read the different methods of dependency resolution available in the [main hook readme file](../hook.md), first. +Note: Game is 32-bit, so you need to install the 32-bit versions of the dependencies! + The following **direct** dependencies (cmd: `readelf -d piu`) are required: * librt.so.1 * liblua50.so.5.0 @@ -34,6 +36,9 @@ As for method 1, when using Ubuntu, the dependencies can be found in the followi * libusb-0.1-4 * libasound2 +Further indirect dependencies are needed but should be taken care of automatically when using a package manager to +install the direct dependencies. + ## Data setup In additional to the [general information applying to **all** hooks](../hook.md#data-setup), this game requires all files and folders in the `game` folder to be in **UPPERCASE** on a case-sensitive file system. diff --git a/doc/hook/pro2hook.md b/doc/hook/pro2hook.md index 12b3f65..105ebd7 100644 --- a/doc/hook/pro2hook.md +++ b/doc/hook/pro2hook.md @@ -9,6 +9,8 @@ All known versions supported as long as it uses fully unpacked assets and a nodo Make sure to read the different methods of dependency resolution available in the [main hook readme file](../hook.md), first. +Note: Game is 32-bit, so you need to install the 32-bit versions of the dependencies! + The following **direct** dependencies (cmd: `readelf -d piu`) are required: * libXtst.so.6 * libXrandr.so.2 @@ -34,6 +36,9 @@ As for method 1, when using Ubuntu, the dependencies can be found in the followi * libasound2 * ffmpeg +Further indirect dependencies are needed but should be taken care of automatically when using a package manager to +install the direct dependencies. + ## Data setup A clean set of data won't work here. You need the dumped and unpacked/decrypted data and a patched executable that runs either on plain zip or files. diff --git a/doc/hook/prohook.md b/doc/hook/prohook.md index 0426672..bc1b012 100644 --- a/doc/hook/prohook.md +++ b/doc/hook/prohook.md @@ -9,6 +9,8 @@ All known versions supported if no-dongle patched at this time. Make sure to read the different methods of dependency resolution available in the [main hook readme file](../hook.md), first. +Note: Game is 32-bit, so you need to install the 32-bit versions of the dependencies! + The following **direct** dependencies (cmd: `readelf -d piu`) are required: * libXtst.so.6 * libXrandr.so.2 @@ -34,6 +36,9 @@ As for method 1, when using Ubuntu, the dependencies can be found in the followi * libasound2 * ffmpeg +Further indirect dependencies are needed but should be taken care of automatically when using a package manager to +install the direct dependencies. + ## Data setup A clean set of data won't work here. You need the decrypted data zip files and a patched executable that uses plain zip files instead of encrypted ones. diff --git a/doc/hook/x2hook.md b/doc/hook/x2hook.md index 2fad993..7799ffe 100644 --- a/doc/hook/x2hook.md +++ b/doc/hook/x2hook.md @@ -11,6 +11,8 @@ Any other version won't work, period. The hook has to memory patch a weird bug c Make sure to read the different methods of dependency resolution available in the [main hook readme file](../hook.md), first. +Note: Game is 32-bit, so you need to install the 32-bit versions of the dependencies! + The following **direct** dependencies (cmd: `readelf -d piu`) are required: * libGL.so.1 * libGLU.so.1 @@ -37,6 +39,9 @@ As for method 1, when using Ubuntu, the dependencies can be found in the followi * libusb-0.1-4 * libasound2 +Further indirect dependencies are needed but should be taken care of automatically when using a package manager to +install the direct dependencies. + ## Data setup In additional to the [general information applying to **all** hooks](../hook.md#data-setup), this game requires all files and folders in the `game` folder to be in **UPPERCASE** on a case-sensitive file system. diff --git a/doc/hook/zerohook.md b/doc/hook/zerohook.md index b31f20b..f813746 100644 --- a/doc/hook/zerohook.md +++ b/doc/hook/zerohook.md @@ -9,6 +9,8 @@ All known versions supported. Make sure to read the different methods of dependency resolution available in the [main hook readme file](../hook.md), first. +Note: Game is 32-bit, so you need to install the 32-bit versions of the dependencies! + The following **direct** dependencies (cmd: `readelf -d piu`) are required: * libGL.so.1 * libGLU.so.1 @@ -32,6 +34,9 @@ As for method 1, when using Ubuntu, the dependencies can be found in the followi * libusb-0.1-4 * libasound2 +Further indirect dependencies are needed but should be taken care of automatically when using a package manager to +install the direct dependencies. + ## Data setup In additional to the [general information applying to **all** hooks](../hook.md#data-setup), this game requires all files and folders in the `game` folder to be in **UPPERCASE** on a case-sensitive file system.