Skip to content

Commit 076732c

Browse files
DarioSamoRagdollClashhyperbxDeaTh-Gblueskythlikesclouds
authored
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>
1 parent 716200e commit 076732c

7 files changed

Lines changed: 1299 additions & 18 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: 'Bug Report'
3+
description: 'Report a bug in Unleashed Recompiled.'
4+
type: 'Bug'
5+
---
6+
7+
### Validation
8+
- [ ] I have checked the [Issues](https://github.com/hedge-dev/UnleashedRecomp/issues) page to see if my problem has already been reported
9+
- [ ] I have confirmed that this bug does not occur in the original game running on original Xbox 360 hardware
10+
11+
### Describe the Bug
12+
A clear and concise description of what the bug is.
13+
14+
### Steps to Reproduce
15+
Steps to reproduce the bug:
16+
1. Go to '...'
17+
2. etc.
18+
19+
### Expected Behavior
20+
A clear and concise description of what you expected to happen.
21+
22+
### Footage
23+
Attach a screenshot or video of the bug. If possible, please also provide footage of the expected behaviour on original Xbox 360 hardware.
24+
25+
### Specifications
26+
Fill out the following details:
27+
- CPU: (e.g. Intel Core [...], AMD Ryzen [...], etc.)
28+
- GPU: (e.g. NVIDIA GeForce [...], Radeon HD [...], Intel HD [...], etc.)
29+
- GPU Driver: (e.g NVIDIA driver 545.XX, AMD driver 24.X.X, etc.)
30+
- OS: (e.g. Windows 10, Windows 11, Linux distro)
31+
- Version: (e.g. 1.0.0)
32+
33+
### Additional Context
34+
Provide any other context about the problem here.

‎COPYING‎

Lines changed: 674 additions & 0 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 447 additions & 13 deletions
Large diffs are not rendered by default.

‎UnleashedRecomp/res/credits.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
inline std::array<const char*, 17> g_credits =
44
{
55
"Skyth",
6+
"Sajid",
67
"Hyper",
78
"Darío",
8-
"Sajid",
99
"DeaThProj",
1010
"RadiantDerg",
1111
"PTKay",
1212
"SuperSonic16",
1313
"NextinHKRY",
14-
"saguinee",
1514
"LadyLunanova",
1615
"LJSTAR",
16+
"saguinee",
1717
"Goalringmod27",
1818
"M&M",
1919
"DaGuAr",

‎docs/BUILDING.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Building
2+
3+
## 1. Clone the Repository
4+
5+
Clone **UnleashedRecomp** with submodules using [Git](https://git-scm.com/).
6+
```
7+
git clone --recurse-submodules https://github.com/hedge-dev/UnleashedRecomp.git
8+
```
9+
10+
### Windows
11+
If you skipped the `--recurse-submodules` argument during cloning, you can run `update_submodules.bat` to ensure the submodules are pulled.
12+
13+
## 2. Add the Required Game Files
14+
15+
Copy the following files from the game and place them inside `./UnleashedRecompLib/private/`:
16+
- `default.xex`
17+
- `default.xexp`
18+
- `shader.ar`
19+
20+
These files are located in the game's root directory, apart from `default.xexp`, which must be obtained via the title update package.
21+
22+
> [!TIP]
23+
> 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.
24+
>
25+
> 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.
26+
>
27+
> When sourcing these files from an Unleashed Recompiled installation, they will be stored under `game` and `update` subdirectories.
28+
29+
## 3. Install Dependencies
30+
31+
### Windows
32+
You will need to install [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/).
33+
34+
In the installer, you must select the following **Workloads** and **Individual components** for installation:
35+
- Desktop development with C++
36+
- C++ Clang Compiler for Windows
37+
- C++ CMake tools for Windows
38+
39+
### Linux
40+
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.
41+
```bash
42+
sudo apt install autoconf automake libtool pkg-config curl cmake ninja-build clang clang-tools libgtk-3-dev
43+
```
44+
45+
> [!NOTE]
46+
> 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.
47+
48+
## 4. Build the Project
49+
50+
### Windows
51+
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.
52+
53+
> [!TIP]
54+
> 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.
55+
56+
2. Under **Solution Explorer**, right-click and choose **Switch to CMake Targets View**.
57+
3. Right-click the **UnleashedRecomp** project and choose **Set as Startup Item**, then choose **Add Debug Configuration**.
58+
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).
59+
5. Start **UnleashedRecomp**. The initial compilation may take a while to complete due to code and shader recompilation.
60+
61+
### Linux
62+
1. Configure the project using CMake by navigating to the repository and running the following command.
63+
```bash
64+
cmake . --preset linux-release
65+
```
66+
67+
> [!NOTE]
68+
> The available presets are `linux-debug`, `linux-relwithdebinfo` and `linux-release`.
69+
70+
2. Build the project using the selected configuration.
71+
```bash
72+
cmake --build ./out/build/linux-release --target UnleashedRecomp
73+
```
74+
75+
3. Navigate to the directory that was specified as the output in the previous step and run the game.
76+
```bash
77+
./UnleashedRecomp
78+
```

‎docs/DUMPING-en.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Dumping
2+
3+
### Pre-requisites
4+
- Xbox 360 (modifications not necessary)
5+
- Xbox 360 Hard Drive (20 GB minimum)
6+
- Xbox 360 Hard Drive Transfer Kit (or a compatible SATA to USB adapter)
7+
- Sonic Unleashed for Xbox 360 (US or EU, **JP is not supported**)
8+
- 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)).
9+
- Title Update required.
10+
- All available DLC (Adventure Packs) are optional, but **highly recommended**. **The DLC includes high quality lighting for the entire game**.
11+
- [7-Zip](https://7-zip.org/download.html) (for extracting Velocity)
12+
- [Velocity](https://github.com/Gualdimar/Velocity/releases/download/xex%2Biso-branch/Velocity-XEXISO.rar) (Gualdimar's fork)
13+
14+
### Instructions
15+
16+
> [!NOTE]
17+
> If you have a digital copy of Sonic Unleashed, skip to step 4.
18+
19+
1. Insert your retail disc copy of Sonic Unleashed into the Xbox 360 disc tray.
20+
2. At the Xbox Dashboard, go over to the disc tile under the **home** tab and press X to view **Game Details**.
21+
3. Under the **overview** tab, select the **Install** tile and choose to install to the primary hard drive.
22+
4. Once installed, turn off your Xbox 360 and remove the hard drive from your console.
23+
24+
> [!TIP]
25+
> You may consult the following guides if you're unsure on how to do this:
26+
> - [Xbox 360](https://www.ifixit.com/Guide/Xbox+360+Hard+Drive+Replacement/3326)
27+
> - [Xbox 360 S](https://www.ifixit.com/Guide/Xbox+360+S+Hard+Drive+Replacement/3184)
28+
> - [Xbox 360 E](https://www.ifixit.com/Guide/Xbox+360+E+Hard+Drive+Replacement/22179)
29+
30+
5. Using the Xbox 360 Hard Drive Transfer Kit (or compatible SATA to USB adapter), connect your Xbox 360 hard drive to your PC.
31+
32+
> [!CAUTION]
33+
> 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.
34+
>
35+
> 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).
36+
>
37+
> For Xbox 360 S|E hard drives, this enclosure is glued shut and removing the hard drive may be an irreversible process!
38+
>
39+
> **It is highly recommended** that you obtain the official Xbox 360 Hard Drive Transfer Kit in order to proceed.
40+
41+
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.
42+
7. Create a new folder anywhere that's convenient to you for storing the game files.
43+
44+
> [!NOTE]
45+
> If you're using Linux, skip to step 9.
46+
47+
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`.
48+
9. You should see a **Device Detected** message appear on launch asking if you would like to open the **Device Content Viewer**. Click **Yes**.
49+
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).
50+
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.
51+
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.
52+
13. Once the transfer is complete, close the **Device Content Viewer** window and navigate to **Tools > Device Tools > Raw Device Viewer**.
53+
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.
54+
55+
> [!TIP]
56+
> 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`.
57+
>
58+
> Once you've verified it, close the **Package Viewer** window and proceed to the next step.
59+
60+
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.
61+
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).

‎flatpak/io.github.hedge_dev.unleashedrecomp.metainfo.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<id>io.github.hedge_dev.unleashedrecomp</id>
44

55
<name>Unleashed Recompiled</name>
6-
<summary>Static recompilation of Sonic Unleashed.</summary>
6+
<summary>An unofficial PC port of Sonic Unleashed.</summary>
77

88
<metadata_license>CC0-1.0</metadata_license>
99
<project_license>GPL-3.0+</project_license>
@@ -16,11 +16,11 @@
1616

1717
<description>
1818
<p>
19-
A native PC port of Sonic Unleashed for Xbox 360 achieved through static recompilation.
19+
An unofficial PC port of the Xbox 360 version of Sonic Unleashed created through the process of static recompilation.
2020

2121
https://github.com/hedge-dev/UnleashedRecomp
2222
</p>
2323
</description>
2424

2525
<launchable type="desktop-id">io.github.hedge_dev.unleashedrecomp.desktop</launchable>
26-
</component>
26+
</component>

0 commit comments

Comments
 (0)