README (#456)

* First draft of README. * Update README.md * Transfer old README to BUILDING.md * Update README.md * Update README.md * Added keyboard bindings table * Update BUILDING.md * Update README.md * update readme credits * Add LICENSE * Update README.md * Rename LICENSE to COPYING * Update Flatpak summary and description * Update README.md. * On * Update README.md Added spacing between sections * Update README.md * Update credits.h * Update README.md * Update README.md * Update README.md * Update README.md * Specifically note Xbox 360 for original hardware Xbox One/Series back compat has some weird bugs specific to it (https://youtu.be/_zDUmg791Qk) so it's best to specifically mention the original Xbox 360 hardware * Added Extended Controller Features section * Update README.md * Update README.md * Update README.md * Added English dumping guide This may need some images to go along with the steps, as well as verification. * S * Move building to docs * Update README.md * Update README.md * Create BUILDING-ALT.md * Finalise building instructions * Upload logo * Added logo and logo credits * Update README.md * Update README.md * Update README.md * Update README.md * Upload issue template for bug reports * Update README.md --------- Co-authored-by: Michael <15317421+ActualMandM@users.noreply.github.com> Co-authored-by: Hyper <34012267+hyperbx@users.noreply.github.com> Co-authored-by: DeaTh-G <hatvongeorge@gmail.com> Co-authored-by: Skyth <19259897+blueskythlikesclouds@users.noreply.github.com> Co-authored-by: RadiantDerg <9061202+RadiantDerg@users.noreply.github.com> Co-authored-by: ĐeäTh <55578911+DeaTh-G@users.noreply.github.com>
2026-01-06 03:29:55 -06:00 · 2025-02-27 16:48:19 -03:00
parent 716200e7df
commit 076732c4b5
7 changed files with 1299 additions and 18 deletions
--- a/docs/BUILDING.md
+++ b/docs/BUILDING.md
@@ -0,0 +1,78 @@
+# Building
+
+## 1. Clone the Repository
+
+Clone **UnleashedRecomp** with submodules using [Git](https://git-scm.com/).
+```
+git clone --recurse-submodules https://github.com/hedge-dev/UnleashedRecomp.git
+```
+
+### Windows
+If you skipped the `--recurse-submodules` argument during cloning, you can run `update_submodules.bat` to ensure the submodules are pulled.
+
+## 2. Add the Required Game Files
+
+Copy the following files from the game and place them inside `./UnleashedRecompLib/private/`:
+- `default.xex`
+- `default.xexp`
+- `shader.ar`
+
+These files are located in the game's root directory, apart from `default.xexp`, which must be obtained via the title update package.
+
+> [!TIP]
+> It is recommended that you install the game using [an existing Unleashed Recompiled release](https://github.com/hedge-dev/UnleashedRecomp/releases/latest) to acquire these files, otherwise you'll need to rely on third-party tools to extract them.
+>
+> Using the Unleashed Recompiled installation wizard will also ensure that these files are compatible with each other so that they can be used with the build environment.
+>
+> When sourcing these files from an Unleashed Recompiled installation, they will be stored under `game` and `update` subdirectories.
+
+## 3. Install Dependencies
+
+### Windows
+You will need to install [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/).
+
+In the installer, you must select the following **Workloads** and **Individual components** for installation:
+- Desktop development with C++
+- C++ Clang Compiler for Windows
+- C++ CMake tools for Windows
+
+### Linux
+The following command will install the required dependencies on a distro that uses `apt` (such as Ubuntu), but you can find the equivalent packages for your preferred distro.
+```bash
+sudo apt install autoconf automake libtool pkg-config curl cmake ninja-build clang clang-tools libgtk-3-dev
+```
+
+> [!NOTE]
+> This list may not be comprehensive for your particular distro and you may be required to install additional packages, should an error occur during configuration.
+
+## 4. Build the Project
+
+### Windows
+1. Open the repository directory in Visual Studio and wait for CMake generation to complete. If you don't plan to debug, switch to the `Release` configuration.
+
+> [!TIP]
+> If you need a Release-performant build and want to iterate on development without debugging, **it is highly recommended** that you use the `RelWithDebInfo` configuration for faster compile times.
+
+2. Under **Solution Explorer**, right-click and choose **Switch to CMake Targets View**.
+3. Right-click the **UnleashedRecomp** project and choose **Set as Startup Item**, then choose **Add Debug Configuration**.
+4. Add a `currentDir` property to the first element under `configurations` in the generated JSON and set its value to the path to your game directory (where root is the directory containing `dlc`, `game`, `update`, etc).
+5. Start **UnleashedRecomp**. The initial compilation may take a while to complete due to code and shader recompilation.
+
+### Linux
+1. Configure the project using CMake by navigating to the repository and running the following command.
+```bash
+cmake . --preset linux-release
+```
+
+> [!NOTE]
+> The available presets are `linux-debug`, `linux-relwithdebinfo` and `linux-release`.
+
+2. Build the project using the selected configuration.
+```bash
+cmake --build ./out/build/linux-release --target UnleashedRecomp
+```
+
+3. Navigate to the directory that was specified as the output in the previous step and run the game.
+```bash
+./UnleashedRecomp
+```
--- a/docs/DUMPING-en.md
+++ b/docs/DUMPING-en.md
@@ -0,0 +1,61 @@
+# Dumping
+
+### Pre-requisites
+- Xbox 360 (modifications not necessary)
+- Xbox 360 Hard Drive (20 GB minimum)
+- Xbox 360 Hard Drive Transfer Kit (or a compatible SATA to USB adapter)
+- 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)
+
+### Instructions
+
+> [!NOTE]
+> If you have a digital copy of Sonic Unleashed, skip to step 4.
+
+1. Insert your retail disc copy of Sonic Unleashed into the Xbox 360 disc tray.
+2. At the Xbox Dashboard, go over to the disc tile under the **home** tab and press X to view **Game Details**.
+3. Under the **overview** tab, select the **Install** tile and choose to install to the primary hard drive.
+4. Once installed, 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)
+
+5. Using the Xbox 360 Hard Drive Transfer Kit (or compatible SATA to USB adapter), connect your Xbox 360 hard drive to your PC.
+
+> [!CAUTION]
+> If you're using an unofficial SATA to USB adapter, you may need to remove the hard drive from its enclosure in order to connect it.
+>
+> For original Xbox 360 hard drives, this process is as simple as [removing some screws and cracking open the enclosure](https://www.ifixit.com/Guide/Xbox+360+HDD+Replacement/3430).
+>
+> For Xbox 360 S|E hard drives, this enclosure is glued shut and removing the hard drive may be an irreversible process!
+>
+> **It is highly recommended** that you obtain the official Xbox 360 Hard Drive Transfer Kit in order to proceed.
+
+6. 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.
+7. Create a new folder anywhere that's convenient to you for storing the game files.
+
+> [!NOTE]
+> If you're using Linux, skip to step 9.
+
+8. 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 hard drive. You can now launch `Velocity.exe`.
+9. You should see a **Device Detected** message appear on launch asking if you would like to open the **Device Content Viewer**. Click **Yes**.
+10. You should now see a tree view of your hard drive's contents. Expand the tree nodes for `/Shared Items/Games/` (and optionally `/Shared Items/DLC/`, if you have the DLC installed).
+11. 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.
+12. Right-click any of the selected items and click **Copy Selected to Local Disk**, then navigate to the folder you created in step 7 and select it. Velocity will now begin copying the game files to your PC.
+13. Once the transfer is complete, close the **Device Content Viewer** window and navigate to **Tools > Device Tools > Raw Device Viewer**.
+14. Navigate to `/Content/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.
+
+15. 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 7 and select it. Velocity will now begin copying the title update to your PC.
+16. Once the transfer is complete, you should now have all of the necessary files for installation. [Return to the readme and proceed to the next step](/README.md#how-to-install).