Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #103

Merged
merged 3 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,26 @@ New contributors are welcome and encouraged to make a pull request! If you would

## Quickstart

**1. Setup build environment.**

Copy and paste this into your terminal:

```bash
git clone https://github.com/theonlyzac/sly1 && \
cd sly1 && \
pip install -U -r requirements.txt && \
sudo ./scripts/setup_build_environment.sh
```

Copy the `SCUS_971.98` file from your game disc to the `disc` directory of the project. Then build with:
**2. Extract your original ELF file.**

```
Copy the file `SCUS_971.98` from your Sly 1 game disc to the `disc` directory of the project.

**3. Build the project.**

Run the build script with this command:

```bash
./scripts/build.sh
```

Expand All @@ -62,17 +72,21 @@ If you have any issues, or you prefer to set up the project manually, follow the

## Manual Setup

The project can be built on Linux, or Windows using WSL. Follow the instructions below to set up the build environment.
The project can be built on Linux (or Windows using WSL). Follow the instructions below to set up the build environment.

### Clone the repo
### Clone the repository

Clone the repository to your local machine:
Clone the repo to your local machine:

```bash
git clone https://github.com/TheOnlyZac/sly1
cd sly1
```

### Extract your original ELF file

To build the project, you will need to extract the original ELF file from your own legally obtained copy of the game. Mount the disc on your PC and copy the file `SCUS_971.98` from your disc to the `disc` directory of this project.

### Install python packages

You will need Python 3.8 or higher.
Expand Down Expand Up @@ -117,10 +131,6 @@ choco install 7zip
.\scripts\setup-progd-windows.bat
```-->

### Setup binary splitting

To build the project you will need to extract the original ELF file from your own legally obtained copy of the game. Mount the disc on your PC and copy the file `SCUS_971.98` from your disc to the `disc` directory of this project.


### Build the project

Expand All @@ -131,7 +141,7 @@ python configure.py
ninja
```

If you update the config files, you will need run a clean reconfigure:
If you update any config files or add any source files, you will need run a clean reconfigure:

```bash
python configure.py --clean
Expand All @@ -158,10 +168,10 @@ The `run.sh` script in the `scripts` dir will automatically rebuild the executab
To boot the elf in PCSX2 from the command line, use the following command:

```bash
pcsx2-1.7.exe -elf ".../sly1/bin/debug/SCUS_971.98" "/path/to/game/backup.iso"
pcsx2.exe -elf ".../sly1/bin/debug/SCUS_971.98" "/path/to/game/backup.iso"
```

Replace `pcsx2-1.7.exe` with the path to your PCSX2 v1.7 executable (for Linux it will be an **.appimage** file).
Replace `pcsx2.exe` with the path to your PCSX2 v2.0 executable (for Linux it will be an **.appimage** file).
- The `-elf` parameter specifies the path to the SCUS_971.98 you built from this project. Replace `...` with the path to this repository. The emulator will use this ELF to boot the game.
- The last argument is the path to your game ISO. Replace `/path/to/game/backup.iso` with the path to a backup of your own game disc. This is where the game will load the assets from.

Expand Down
2 changes: 1 addition & 1 deletion config/sly1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ segments:
- [0x6f0b8, c, P2/joy]

- [0x70608, c, P2/jt1]
- [0x74888, asm, P2/jt_UpdateJtActive]
- [0x74888, asm, P2/jt_UpdateJtActive] # should be in P2/jt but doesn't match when split
- [0x75808, c, P2/jt2]

- [0x79008, asm, P2/jp]
Expand Down
Loading