Skip to content

Commit 6127d4d

Browse files
committed
Update docs for Marathon Recompiled
Signed-off-by: Isaac Marovitz <isaacryu@icloud.com>
1 parent d292c7a commit 6127d4d

2 files changed

Lines changed: 27 additions & 30 deletions

File tree

docs/BUILDING.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,29 @@
22

33
## 1. Clone the Repository
44

5-
Clone **UnleashedRecomp** with submodules using [Git](https://git-scm.com/).
5+
Clone **MarathonRecomp** with submodules using [Git](https://git-scm.com/).
66
```
7-
git clone --recurse-submodules https://github.com/hedge-dev/UnleashedRecomp.git
7+
git clone --recurse-submodules https://github.com/ga2mer/MarathonRecomp.git
88
```
99

1010
### Windows
1111
If you skipped the `--recurse-submodules` argument during cloning, you can run `update_submodules.bat` to ensure the submodules are pulled.
1212

1313
## 2. Add the Required Game Files
1414

15-
Copy the following files from the game and place them inside `./UnleashedRecompLib/private/`:
15+
Copy the following files from the game and place them inside `./MarathonRecompLib/private/`:
1616
- `default.xex`
17-
- `default.xexp`
18-
- `shader.ar`
17+
- `shader.arc`
18+
- `shader_lt.arc`
1919

20-
These files are located in the game's root directory, apart from `default.xexp`, which must be obtained via the title update package.
20+
`default.xex` is located in the game's root directory, while the others are located in `/xenon/archives`.
2121

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.
22+
[//]: # (> [!TIP])
23+
[//]: # (> It is recommended that you install the game using [an existing Marathon Recompiled release]&#40;https://github.com/ga2mer/MarathonRecomp/releases/latest&#41; to acquire these files, otherwise you'll need to rely on third-party tools to extract them.)
24+
[//]: # (>)
25+
[//]: # (> Using the Marathon 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 Marathon Recompiled installation, they will be stored under `game` and `update` subdirectories.)
2828

2929
## 3. Install Dependencies
3030

@@ -74,9 +74,9 @@ sudo port install cmake ninja pkg-config
7474
> 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.
7575
7676
2. Under **Solution Explorer**, right-click and choose **Switch to CMake Targets View**.
77-
3. Right-click the **UnleashedRecomp** project and choose **Set as Startup Item**, then choose **Add Debug Configuration**.
78-
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).
79-
5. Start **UnleashedRecomp**. The initial compilation may take a while to complete due to code and shader recompilation.
77+
3. Right-click the **MarathonRecomp** project and choose **Set as Startup Item**, then choose **Add Debug Configuration**.
78+
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`, etc).
79+
5. Start **MarathonRecomp**. The initial compilation may take a while to complete due to code and shader recompilation.
8080

8181
### Linux
8282
1. Configure the project using CMake by navigating to the repository and running the following command.
@@ -89,12 +89,12 @@ cmake . --preset linux-release
8989
9090
2. Build the project using the selected configuration.
9191
```bash
92-
cmake --build ./out/build/linux-release --target UnleashedRecomp
92+
cmake --build ./out/build/linux-release --target MarathonRecomp
9393
```
9494

9595
3. Navigate to the directory that was specified as the output in the previous step and run the game.
9696
```bash
97-
./UnleashedRecomp
97+
./MarathonRecomp
9898
```
9999

100100
### macOS
@@ -108,10 +108,10 @@ cmake . --preset macos-release
108108
109109
2. Build the project using the selected configuration.
110110
```bash
111-
cmake --build ./out/build/macos-release --target UnleashedRecomp
111+
cmake --build ./out/build/macos-release --target MarathonRecomp
112112
```
113113

114114
3. Navigate to the directory that was specified as the output in the previous step and run the game.
115115
```bash
116-
open -a UnleashedRecomp.app
116+
open -a MarathonRecomp.app
117117
```

docs/DUMPING-en.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@
44
- Xbox 360 (modifications not necessary)
55
- Xbox 360 Hard Drive (20 GB minimum)
66
- Xbox 360 Hard Drive Transfer Cable (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**.
7+
- Sonic the Hedgehog (2006) for Xbox 360
8+
- Retail Disc or Digital Copy.
9+
- All available DLC are optional.
1110
- [7-Zip](https://7-zip.org/download.html) (for extracting Velocity)
1211
- [Velocity](https://github.com/Gualdimar/Velocity/releases/download/xex%2Biso-branch/Velocity-XEXISO.rar) (Gualdimar's fork)
1312

@@ -21,9 +20,9 @@
2120
### Instructions
2221

2322
> [!NOTE]
24-
> If you have a digital copy of Sonic Unleashed, skip to step 4.
23+
> If you have a digital copy of Sonic the Hedgehog, skip to step 4.
2524
26-
1. Insert your retail disc copy of Sonic Unleashed into the Xbox 360 disc tray.
25+
1. Insert your retail disc copy of Sonic the Hedgehog into the Xbox 360 disc tray.
2726
2. At the Xbox Dashboard, go over to the disc tile under the **home** tab and press X to view **Game Details**.
2827
3. Under the **overview** tab, select the **Install** tile and choose to install to the primary hard drive.
2928
4. Once installed, turn off your Xbox 360 and remove the hard drive from your console.
@@ -54,15 +53,13 @@
5453
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`.
5554
9. You should see a **Device Detected** message appear on launch asking if you would like to open the **Device Content Viewer**. Click **Yes**.
5655
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).
57-
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.
56+
11. Hold the CTRL key and click on **SONIC THE HEDGEHOG** under the `Games` node, as well as the **DLC** under the `DLC` node, if you have the DLC installed. Ensure all are selected before the next step.
5857
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.
5958
13. Once the transfer is complete, close the **Device Content Viewer** window and navigate to **Tools > Device Tools > Raw Device Viewer**.
60-
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.
6159

6260
> [!TIP]
63-
> 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`.
61+
> 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.xex` exists inside, along with a folder called `work`.
6462
>
6563
> Once you've verified it, close the **Package Viewer** window and proceed to the next step.
6664
67-
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.
68-
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).
65+
14. 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).

0 commit comments

Comments
 (0)