Problems building on Linux

[jojoharry16]

Describe your bug here. And how to reproduce it.

Followed the steps, except that the tables folder doesn't exist. The only folder with matching structure is the assets folder. Whenever I try running restool.py I get the following error:

Exception: Could not find any ROMs (zelda3.sfc, zelda3.smc) at the default location /home/[user]/Projects/zelda3/assets/...

Then when I manually adjust util.py to hardcode my Projects folder, a different error appears depending on if I use python or python3 to run the command:

python3

Traceback (most recent call last):
  File "/home/[user]/Projects/zelda3/assets/restool.py", line 48, in <module>
    import compile_resources
  File "/home/[user]/Projects/zelda3/assets/compile_resources.py", line 4, in <module>
    from PIL import Image
ModuleNotFoundError: No module named 'PIL'

python

Traceback (most recent call last):
  File "/home/[user]/Projects/zelda3/assets/restool.py", line 49, in <module>
    compile_resources.main(args)
    ~~~~~~~~~~~~~~~~~~~~~~^^^^^^
  File "/home/[user]/Projects/zelda3/assets/compile_resources.py", line 815, in main
    print_all(args)
    ~~~~~~~~~^^^^^^
  File "/home/[user]/Projects/zelda3/assets/compile_resources.py", line 757, in print_all
    print_sound_banks()
    ~~~~~~~~~~~~~~~~~^^
  File "/home/[user]/Projects/zelda3/assets/compile_resources.py", line 753, in print_sound_banks
    name, data = compile_music.print_song(song)
                 ~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^
  File "/home/[user]/Projects/zelda3/assets/compile_music.py", line 433, in print_song
    sorted_ents = process_file(open('sound_%s.txt' % song, 'r'))
                               ~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: 'sound_intro.txt'

Both python --version and python3 --version return 3.13.3.

Any and all help appreciated :)

What is your build target?

Linux

[jojoharry16]

Update: if I manually add the txt files to the assets folder, I then get an error TypeError: 'NoneType' object is not subscriptable

python restool.py 
Testing print
Traceback (most recent call last):
  File "/home/[user]/Projects/zelda3/assets/restool.py", line 49, in <module>
    compile_resources.main(args)
    ~~~~~~~~~~~~~~~~~~~~~~^^^^^^
  File "/home/[user]/Projects/zelda3/assets/compile_resources.py", line 815, in main
    print_all(args)
    ~~~~~~~~~^^^^^^
  File "/home/[user]/Projects/zelda3/assets/compile_resources.py", line 757, in print_all
    print_sound_banks()
    ~~~~~~~~~~~~~~~~~^^
  File "/home/[user]/Projects/zelda3/assets/compile_resources.py", line 753, in print_sound_banks
    name, data = compile_music.print_song(song)
                 ~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^
  File "/home/[user]/Projects/zelda3/assets/compile_music.py", line 438, in print_song
    serialize_song(serializer, song, sorted(sorted_ents, key = lambda x: x.ea))
    ~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/[user]/Projects/zelda3/assets/compile_music.py", line 338, in serialize_song
    for i, info in enumerate(music_info['samples']):
                             ~~~~~~~~~~^^^^^^^^^^^
TypeError: 'NoneType' object is not subscriptable

[JesseCoretta]

Hi @jojoharry16 , I am not the maintainer but I am a (Ubuntu/Debian) Linux user who just got this working on my first try today. I will share my commands with you, though admittedly aside from one detail, they're identical to those shown in the readme. Maybe they'll help, maybe not.

$ cd ~/Games ### adjust as needed
$ git clone https://github.com/snesrev/zelda3
$ cd zelda3

This next step is where things diverged slightly from the docs.

$ python3 -m ensurepip

This produced the following unexpected message:

ensurepip is disabled in Debian/Ubuntu for the system python.

Python modules for the system python are usually handled by dpkg and apt-get.

    apt install python3-<module name>

Install the python3-pip package to use pip itself.  Using pip together
with the system python might have unexpected results for any system installed
module, so use it on your own risk, or make sure to only use it in virtual
environments.

So, as a workaround I did the following (which worked):

$ sudo apt install python3-pip

Still in the zelda3 directory, I then did

$ python3 -m pip install -r requirements.txt

My pip output just for reference:

Defaulting to user installation because normal site-packages is not writeable
Collecting Pillow
  Downloading pillow-11.3.0-cp310-cp310-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (6.6 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.6/6.6 MB 11.3 MB/s eta 0:00:00
Requirement already satisfied: PyYAML in /usr/lib/python3/dist-packages (from -r requirements.txt (line 2)) (5.4.1)
Installing collected packages: Pillow
Successfully installed Pillow-11.3.0

... followed by

$ sudo apt install libsdl2-dev
<answered yes to pkg install confirmation, voluminous output omitted here>

I then copied my zelda3.smc ROM into the root of the cloned package directory, in my case that was ~/Games/zelda3:

$ cp [full path to orig zelda smc] ./zelda3.smc

Finally, we make (be sure you're still in the zelda3 folder):

$ make

Then I executed the freshly compiled binary via:

$ ./zelda3

Instantly launched, no issues, very fast, sound was good.

Specifically, at no point did I see any indication that any folders (e.g.: "tables") were missing. I guess I'd be surprised otherwise, considering the pkg is a fresh clone.

I hope this helps

Jesse