Skip to content
This repository has been archived by the owner on Jan 10, 2021. It is now read-only.

Commit

Permalink
More verbose directions
Browse files Browse the repository at this point in the history
  • Loading branch information
Southbird committed Jul 8, 2017
1 parent a7b8d9e commit 95d10fc
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,35 @@
# SMB3Utilties
NoDice level editor and MusConv utility supporting my specific disassemblies. If you are running Windows, and you have no specific reason to build from source, you probably just want to use a prebuilt release version.

Windows users: You MUST install the GTK+ 2.24 runtime, available here: https://sourceforge.net/projects/gtk-win/

THIS IS ONLY FOR THE SOUTHBIRD SMB3 DISASSEMBLY IN ITS STANDARD DIRECTORY STRUCTURE. It will not work for general ROM hacks, nor will it work if you deviate the directory structure too much. (Without editing the editor's source anyway.)

To use NoDice, you will need to modify the config.xml to point to both where your game resides and the NESASM assembler resides. You can use relative or absolute paths depending on whatever makes the most sense for your environment. NOTE if you are using relative paths that the editor internally changes to the directory you specify for your SMB3 project, so remember to form your paths relative to that location. (Or just use aboslute paths.)

The following lines in config.xml are what you are most interested in:

------

Windows specific notes:
"<game />" should point to where your project lives. Remember that the editor will internally change to this directory!

<game value="C:\Users\Whatever\Documents\smb3" />

------

"<filebase />" represents the root assembler file (that is, the file to be passed to NESASM) without any 3 letter extension (i.e. "smb3" means to use "smb3.asm" and generate "smb3.nes")

You MUST install the GTK+ 2.24 runtime, available here: https://sourceforge.net/projects/gtk-win/
<filebase value="smb3" />

------

"<build />" represents the path to the NESASM executable.

<build value="C:\Users\Whatever\Documents\NoDice\nesasm" />

------

Windows specific notes:

... whether you intend to build NoDice from source or run the release version!!

Expand Down

0 comments on commit 95d10fc

Please sign in to comment.