mirror/oot
1
0
Fork 0
mirror of https://github.com/zeldaret/oot.git synced 2025-08-06 22:30:15 +00:00
Code Issues Projects Releases Wiki Activity

Use virtualenv in Makefile for python dependencies (#1619)

Browse source 
* Use virtualenv in Makefile for python dependencies

* Create separate targets for venv creation and installation

* Fix install-python-deps prerequisite

* Try simplifying Jenkinsfile

* Simplify venv targets

* Fix merge

* Update README.md

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
This commit is contained in:
cadmic 2024-01-24 16:39:13 -08:00 • committed by GitHub
parent 584e61a849
commit 5dd19e4862
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 40 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -100,37 +100,13 @@ This will copy the GitHub repository contents into a new folder in the current d
cd oot
```
#### 3. Install python dependencies
The build process has a few python packages required that are located in `requirements.txt`.
It is recommended to set up a virtual environment for python to contain all dependencies. To create a virtual environment:
```bash
python3 -m venv .venv
```
To start using the virtual environment in your current terminal run:
```bash
. .venv/bin/activate
```
Keep in mind that for each new terminal session, you will need to **activate** the Python virtual environment again. That is, run the above `. .venv/bin/activate` command.
Now you can install the Python dependencies, to do so run:
```bash
pip install -U -r requirements.txt
```
#### 4. Prepare a base ROM
#### 3. Prepare a base ROM
Place a copy of the Master Quest (Debug) ROM inside the `baseroms/gc-eu-mq-dbg/` folder.
Rename the file to `baserom.z64`, `baserom.n64` or `baserom.v64`, depending on the original extension.
#### 5. Setup the ROM and build process
#### 4. Setup the ROM and build process
Setup and extract everything from your ROM with the following command:
@ -138,10 +114,11 @@ Setup and extract everything from your ROM with the following command:
make setup
```
This will generate a new ROM "baseroms/gc-eu-mq-dbg/baserom-decompressed.z64" that will have the overdump removed and the header patched.
This downloads some dependencies (from pip), and compiles tools for the build process.
Then it generates a new ROM "baseroms/gc-eu-mq-dbg/baserom-decompressed.z64" that will have the overdump removed and the header patched.
It will also extract the individual assets from the ROM.
#### 6. Build the ROM
#### 5. Build the ROM
Run make to build the ROM.
Make sure your path to the project is not too long, otherwise this process may error.