Game-Decompilation/sly1
1
0
Fork 0
mirror of https://github.com/TheOnlyZac/sly1.git synced 2024-11-22 21:29:55 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update readme and setup scripts

Browse Source
This commit is contained in:
TheOnlyZac 2024-08-03 00:25:56 -04:00
parent 0f59651d43
commit 53b2a2d1d5
3 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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:
@ -71,9 +73,9 @@ 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
@ -81,8 +83,6 @@ 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:
@ -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
@ -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
@ -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:
@ -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?
@ -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">

2
scripts/setup_build_environment.sh
View File

@ -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."

4
scripts/setup_progd_linux.sh
View File

@ -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)/..
@ -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..."