Make Bug Report issue template use separate required fields for specs (#1539 )

Add a guide for dumping the game using a USB storage device (#1471 )
* Update README dumping requirements and instructions Include the option of using a USB storage device for dumping game files in the README. * Add note to hard drive dumping instructions Clarify that the instructions for dumping game files directly from the Xbox 360 hard drive differ from those for using a USB storage device by adding a note to the hard drive dumping guide. * Add dumping guide for USB storage devices Add a comprehensive guide for dumping the game using a USB storage device instead of a Hard Drive Transfer Cable. * Apply suggestions from the review Co-authored-by: Hyper <34012267+hyperbx@users.noreply.github.com> * Implement additional suggestions from the review - Rename the file to ```DUMPING-USB-en.md```. - Add Xbox 360 E to the note about incompatible consoles. - Move the note under the Pre-requisites section. --------- Co-authored-by: Hyper <34012267+hyperbx@users.noreply.github.com>
2025-04-28 21:37:58 +03:00 · 2025-04-12 14:38:04 +01:00 · 2025-04-12 14:27:17 +01:00
4 changed files with 139 additions and 13 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@ -73,19 +73,48 @@ body:
    attributes:
      label: Footage
      description: Attach a screenshot or video of the bug. If possible, please also provide footage of the expected behaviour on original Xbox 360 hardware.
-  - id: system-specifications
-    type: textarea
+  - id: specs-version
+    type: input
    validations:
      required: true
    attributes:
-      label: System Specifications
-      description: Fill out the following details.
-      placeholder: |
-       - CPU: (e.g. Intel Core [...], AMD Ryzen [...], etc.)
-       - GPU: (e.g. NVIDIA GeForce [...], Radeon HD [...], Intel HD [...], etc.)
-       - GPU Driver: (e.g NVIDIA driver 545.XX, AMD driver 24.X.X, etc.)
-       - OS: (e.g. Windows 10, Windows 11, Linux distro)
-       - Version: (e.g. 1.0.0)
+      label: Version
+      description: The version of Unleashed Recompiled you are running (e.g. **v1.0.0**). This can be found at the bottom right corner of the installer wizard, options menu, or in the application metadata.
+  - id: specs-cpu
+    type: input
+    validations:
+      required: true
+    attributes:
+      label: CPU
+      description: The name of your CPU (e.g. **Intel Core [...]**, **AMD Ryzen [...]**, etc.).
+  - id: specs-gpu
+    type: input
+    validations:
+      required: true
+    attributes:
+      label: GPU
+      description: The name of your GPU (e.g. **NVIDIA GeForce [...]**, **AMD Radeon [...]**, **Intel [...]**, etc.).
+  - id: specs-gpu-driver
+    type: input
+    validations:
+      required: true
+    attributes:
+      label: GPU Driver
+      description: The version of your GPU driver (e.g. **NVIDIA Driver 572.XX**, **AMD Driver 25.X.X**, **Intel Driver 32.X.XXX.XXXX** etc.).
+  - id: specs-ram
+    type: input
+    validations:
+      required: true
+    attributes:
+      label: Memory
+      description: The amount of system memory you have (e.g. **8 GB**, **16 GB**, etc.).
+  - id: specs-os
+    type: input
+    validations:
+      required: true
+    attributes:
+      label: Operating System
+      description: The name of the operating system you are running (e.g. **Windows 10**, **Windows 11**, **Linux distro**).
  - id: additional-context
    type: textarea
    validations:
--- a/README.md
+++ b/README.md
@ -49,8 +49,8 @@ Unleashed Recompiled is an unofficial PC port of the Xbox 360 version of Sonic U
 1) You must have access to the following:

    - Xbox 360 (modifications not necessary)
-    - Xbox 360 Hard Drive (20 GB minimum)
-    - Xbox 360 Hard Drive Transfer Cable (or a compatible SATA to USB adapter)
+    - Xbox 360 Storage Device (either an Xbox 360 hard drive or an external USB storage device)
+    - Xbox 360 Hard Drive Transfer Cable or a compatible SATA to USB adapter (only required for dumping from an Xbox 360 hard drive)
    - Sonic Unleashed for Xbox 360 (US or EU, **JP is not supported**)
        - Retail Disc or Digital Copy (can be purchased and downloaded from the [Xbox Store](https://www.xbox.com/en-US/games/store/sonic-unleashed/c098fgnmts8f)).
        - Title Update required.
@ -65,7 +65,10 @@ Unleashed Recompiled is an unofficial PC port of the Xbox 360 version of Sonic U

 2) **Before proceeding with the installation**, make sure to follow the guide on how to acquire the game files from your Xbox 360.

-    - [English Dumping Guide](/docs/DUMPING-en.md)
+    - Xbox 360 Hard Drive Dumping Guide
+        - [English](/docs/DUMPING-en.md)
+    - Xbox 360 USB Dumping Guide
+        - [English](/docs/DUMPING-USB-en.md)

 3) Download [the latest release](https://github.com/hedge-dev/UnleashedRecomp/releases/latest) of Unleashed Recompiled and extract it to where you'd like the game to be installed.

--- a/docs/DUMPING-USB-en.md
+++ b/docs/DUMPING-USB-en.md
@ -0,0 +1,89 @@
+# Dumping
+
+> [!NOTE]
+> The following guide is for dumping the game using a USB storage device.
+>
+> If you wish to dump the game from your Xbox 360 hard drive, use [this guide](DUMPING-en.md) instead.
+
+### Pre-requisites
+- Xbox 360 (modifications not necessary)
+- USB Storage Device (16 GB minimum)
+- Sonic Unleashed for Xbox 360 (US or EU, **JP is not supported**)
+    - Retail Disc or Digital Copy (can be purchased and downloaded from the [Xbox Store](https://www.xbox.com/en-US/games/store/sonic-unleashed/c098fgnmts8f)).
+    - Title Update required.
+    - All available DLC (Adventure Packs) are optional, but **highly recommended**. **The DLC includes high quality lighting for the entire game**.
+- [7-Zip](https://7-zip.org/download.html) (for extracting Velocity)
+- [Velocity](https://github.com/Gualdimar/Velocity/releases/download/xex%2Biso-branch/Velocity-XEXISO.rar) (Gualdimar's fork)
+
+> [!NOTE]
+> Some Xbox 360 S|E consoles come with 4 GB of internal flash storage. These are **not compatible** with this method since you cannot set a USB storage device as a system drive on them.
+>
+> An exception is for versions with the Trinity motherboard, where the storage module is located on a separate daughterboard and can be disconnected (not recommended for inexperienced users). On other models, this module is soldered directly onto the motherboard and cannot be disconnected.
+
+### Instructions
+
+1. Turn off your Xbox 360 and remove the hard drive from your console.
+
+> [!TIP]
+> You may consult the following guides if you're unsure on how to do this:
+> - [Xbox 360](https://www.ifixit.com/Guide/Xbox+360+Hard+Drive+Replacement/3326)
+> - [Xbox 360 S](https://www.ifixit.com/Guide/Xbox+360+S+Hard+Drive+Replacement/3184)
+> - [Xbox 360 E](https://www.ifixit.com/Guide/Xbox+360+E+Hard+Drive+Replacement/22179)
+
+2. Connect a USB storage device to the console and turn it on.
+3. At the Xbox Dashboard, navigate to the **settings** tab, select **System**, then **Storage**.
+4. On the **Storage Devices** screen, select your USB storage device and press Y to open **Device Options**.
+5. Select **Make System Drive**, then **Configure Now** and confirm by selecting **Yes**.
+
+> [!CAUTION]
+> This operation will erase all content on the USB storage device. Before continuing, make sure that you have backed up its contents. **This action is irreversible!**
+
+6. After successfully configuring the USB storage device as a system drive, turn off your console and reconnect the hard drive.
+7. Turn on your console, then navigate to the **settings** tab, select **System**, then **Storage**.
+8. Select the original hard drive, then navigate to the **Profiles** directory and move an Xbox Live profile that owns the game and its DLC to the USB storage device.
+9. Turn off the console and remove the hard drive.
+10. Turn on the console, **install the system update if prompted**, then sign in to your Xbox Live profile.
+
+> [!NOTE]
+> If you have a digital copy of Sonic Unleashed, skip to step 14.
+
+11. Insert your retail disc copy of Sonic Unleashed into the Xbox 360 disc tray.
+12. At the Xbox Dashboard, go over to the disc tile under the **home** tab and press X to view **Game Details**.
+13. Under the **overview** tab, select the **Install** tile and choose to install to the USB drive.
+14. For downloadable content, return to the Xbox Dashboard and navigate to the **settings** tab, select **Account**, then **Download History**. Look for the game (if you own it digitally) and its DLC. Select them and choose **Download Again**. Repeat this step for all of the DLC that you own.
+
+> [!TIP]
+> If the game or its DLC do not appear in **Download History**, ensure that you have moved the account that owns them and are currently signed into it.
+
+15. Once installed, launch the game to ensure that the title update is installed. If it isn't, you should be prompted to install it.
+
+> [!TIP]
+> If the DLC functions correctly, the title update is already installed.
+>
+> To confirm this, you should see a message in yellow text that reads "You can play downloaded action stages [...]" upon loading a save file, which indicates that the DLC is working.
+>
+> Otherwise, you may need to reach the world map in order to see the DLC globe indicator on any of the countries that you have DLC installed for.
+>
+> If you're still unsure, you may force the title update to reinstall by clearing the system cache (available in **Storage > Device Options**) and relaunching the game whilst connected to Xbox Live.
+
+16. Turn off the console and connect the USB storage device to your PC.
+17. Download [the latest release of Velocity](https://github.com/Gualdimar/Velocity/releases/download/xex%2Biso-branch/Velocity-XEXISO.rar) and open the `*.rar` file using [7-Zip](https://7-zip.org/download.html), then extract its contents anywhere that's convenient to you.
+18. Create a new folder anywhere that's convenient to you for storing the game files.
+> [!NOTE]
+> If you're using Linux, skip to step 20.
+
+19. Right-click `Velocity.exe` and click **Properties**, then under the **Compatibility** tab, tick **Run this program as an administrator** and click **OK**. This is required in order for the program to recognize the storage device.
+20. Launch `Velocity.exe`. You should see a **Device Detected** message appear on launch asking if you would like to open the **Device Content Viewer**. Click **Yes**.
+21. You should now see a tree view of your storage device's contents. Expand the tree nodes for `/Shared Items/Games/` (and optionally `/Shared Items/DLC/`, if you have the DLC installed).
+22. Hold the CTRL key and click on **SONIC UNLEASHED** under the `Games` node, as well as the **Adventure Pack(s)** under the `DLC` node, if you have the DLC installed. Ensure all are selected before the next step.
+23. Right-click any of the selected items and click **Copy Selected to Local Disk**, then navigate to the folder you created in step 18 and select it. Velocity will now begin copying the game files to your PC.
+24. Once the transfer is complete, close the **Device Content Viewer** window and navigate to **Tools > Device Tools > Raw Device Viewer**.
+25. Navigate to `/System Cache/Cache/` and click the **Name** column to sort by name. Look for a file that begins with `TU_19KA20I`, this is the title update which is required for installation.
+
+> [!TIP]
+> If you wish to verify that the contents of this file are correct, you may double-click on it to open it in **Package Viewer** and confirm that `default.xexp` exists inside, along with a folder called `work`.
+>
+> Once you've verified it, close the **Package Viewer** window and proceed to the next step.
+
+26. Right-click on the file that begins with `TU_19KA20I` and click **Copy Selected to Local Disk**, then navigate to the folder you created in step 18 and select it. Velocity will now begin copying the title update to your PC.
+27. Once the transfer is complete, you should have all the necessary files for installation. You may now reconnect your hard drive to your console and restore your Xbox Live profile from the USB storage device. After that, [return to the readme and proceed to the next step](/README.md#how-to-install).
--- a/docs/DUMPING-en.md
+++ b/docs/DUMPING-en.md
@ -1,5 +1,10 @@
 # Dumping

+> [!NOTE]
+> The following guide is for dumping the game from an Xbox 360 hard drive.
+>
+> If you wish to use a USB storage device, use [this guide](DUMPING-USB-en.md) instead.
+
 ### Pre-requisites
 - Xbox 360 (modifications not necessary)
 - Xbox 360 Hard Drive (20 GB minimum)