Skip to content

Commit

Permalink
Update readme and setup scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
TheOnlyZac committed Aug 3, 2024
1 parent 0f59651 commit 53b2a2d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 12 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ 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.

### Clone the repo

Clone the repository to your local machine:
Expand All @@ -71,18 +73,16 @@ git clone https://github.com/TheOnlyZac/sly1
cd sly1
```

### Install Python packages
### Install python packages

Splat is used for binary splitting, and Ninja is used for building the project. You will need Python 3. Install dependencies with pip:
You will need Python 3.8 or higher.

```bash
pip install -U -r requirements.txt
```

### Setup build environment

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

<!--#### Linux/WSL-->

1. Setup wine:
Expand Down Expand Up @@ -124,7 +124,7 @@ To build the project you will need to extract the original ELF file from your ow

### Build the project

The project can be built on Linux (or Windows using WSL). It builds the executable `SCUS_971.98`.
The project builds the executable `SCUS_971.98`.

```bash
python configure.py
Expand All @@ -143,12 +143,11 @@ To only clean without reconfiguring (i.e. delete build files) use:
python configure.py --only-clean
```


## Running

Running the executable requires [PCSX2 2.0](https://pcsx2.net/). You must have your own copy of the original game and the BIOS from your own PS2. They are not included in this repo and we cannot provide them for you.

Once you have those and you have built the executable, you can run it in one of these three ways:
Once you have those and you have built the executable, you can run it in one of three ways:

### 1. Autorun script

Expand All @@ -170,7 +169,6 @@ Replace `pcsx2-1.7.exe` with the path to your PCSX2 v1.7 executable (for Linux i

Copy `SCUS_971.98` from the `out` dir to your PCSX2 Games folder and rename it to `SCUS_971.98.elf`. Right click on the game in PCSX2 and click "Properties...". Go to "Disc Path", click "Browse", and select the ISO of your game backup. Then click "Close" and start the game as normal.


## Project Structure

The project is divided into the following directories:
Expand All @@ -192,7 +190,6 @@ When you build the executable, the following directories will be created:
* `obj` - Compiled object files.
* `out` - Compiled executables.


## FAQ

#### What is a decompilation?
Expand All @@ -215,7 +212,6 @@ Yes. This was the first PS2 decompilation project that targeted the PS2 and util

If you want to contribute, check out [CONTRIBUTING.md](/docs/CONTRIBUTING.md) and feel free to [join our discord server](https://discord.gg/gh5xwfj) if you have any questions!


## Star History

<a href="https://star-history.com/#theonlyzac/sly1&Date">
Expand Down
2 changes: 1 addition & 1 deletion scripts/setup_build_environment.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ sudo apt-get install wine32
sudo apt-get install binutils-mips-linux-gnu

# Setup compiler
./setup-progd-linux.sh
./setup_progd_linux.sh

popd > /dev/null
echo "Build environment setup complete."
Expand Down
4 changes: 3 additions & 1 deletion scripts/setup_progd_linux.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
# A simple script to set up the ProDG compilers + SCE Runtime Library
# to build the Sly 1 decompilation project.

set -e

WINE_ROOT=~/.wine/drive_c
TOP=$(cd "$(dirname "$0")"; pwd)/..

Expand Down Expand Up @@ -31,7 +33,7 @@ echo Starting ProDG setup script...
download "https://github.com/TheOnlyZac/compilers/releases/download/ee-gcc2.95.2-SN-v2.73a/ee-gcc2.95.2-SN-v2.73a.tar.gz"

# apply environment variables from the registry file
wine regedit prodg_env.reg
# wine regedit prodg_env.reg

# Extract the compiler into the tools dir
echo "Extracting compiler to $TOP/tools..."
Expand Down

0 comments on commit 53b2a2d

Please sign in to comment.