snesrev / zelda3

https://discord.gg/AJJbJAzNNJ
Other
4.24k stars 347 forks source link

Wiki pages corrections #275

Open impeeza opened 11 months ago

impeeza commented 11 months ago

Describe your bug here. And how to reproduce it.

Hello there,

With the latest change on the code, the Wiki pages get outdated, there are small things but could create confusion on the people trying to build the repo.

On the page https://github.com/snesrev/zelda3/wiki/1.-Getting-Started

On the section MSYS you are missing the next packages which are needed to build on that environment:

On page https://github.com/snesrev/zelda3/wiki/2.-Cloning-and-Setup

The paragraph

go into the zelda3 folder, then inside the tables folder place your zelda3.sfc rom

now should be

go into the zelda3 folder and place your zelda3.sfc rom there

below,

The text:

return to the Git Bash window (or MSYS2)

type: cd zelda3/tables type: python restool.py --extract-from-rom

Now should be changed to:

return to the Git Bash window (or MSYS2) type: cd zelda3/ type: python assets/restool.py --extract-from-rom

Also on Multi-Language Support

The text:

Rename your German Rom to German.sfc and place it in the tables folder, you should still have the separate zelda3.sfc also

run these two commands

python restool.py --extract-dialogue -r german.sfc

then

python restool.py --languages=de

you should now have dialogue_de.txt and font_de.png fils

now should be something like:

Rename your German Rom to German.sfc and place it in the root folder, you should still have the separate zelda3.sfc also

run these two commands

python assets/restool.py --extract-dialogue -r german.sfc

then

python assets/restool.py --extract-from-rom --languages=de

you should now have dialogue_de.txt and font_de.png files

the last line have a little typo, files is missing a «e»

By the way on the wiki there are no the Checksum of the supported ROMS for each language.

What is your build target?

Windows

impeeza commented 11 months ago

Hello there, I am pinning @snesrev on this issue in order to know if there is something to improve on the issue, and/or PR, thanks.