Introduction
Hello, and welcome to Reggie!
You are probably thinking - "I'm 12 years old and fail at life, and I can't figure out how to use such a simple editor as Reggie! Where can I go to ask people all of my stupid questions since I can't figure out jack squat myself?"
Fear not! You need not ask anyone, all your stupid, pathetic, worthless questions can be answered within this document. Continue to read and navigate through the red coloured links by clicking on them with the mouse pointer. If this proves too difficult, try operating Reggie! with your mom.
Extracting Game Files
To run Reggie, you'll need the "Stage" folder from NSMB Wii. We use the files in this folder to display the level graphics, and for access to the game's original levels (giving you some starting examples).
The recommended method for obtaining this folder is to use Reggie! Dumper (available at the Reggie! homepage). Other methods are available, but left to the user as an exercise.
Starting Reggie!
If you have a precompiled executable, simply double-click. Precompiled executables should be available as a Windows exe, a Mac app, or a Linux application via cx_Freeze (built on Ubuntu 9.04).
For those who cannot run one of the available executable files, or who simply desire not to do so, there is a source distribution available. The source distribution requires the following packages:
- Python 2.7 or higher (3.5 or higher recommended)
- PyQt 4.8 or higher if using Python 2.x, or PyQt 5.11 or higher if using Python 3.x (pip install PyQt5)
Windows users can get away with downloading and running the latest Windows binary installer for Python. Then run py -3 -m pip install PyQt5, which will hold your hand and install PyQt, Qt and SIP for you.
Mac OS X Snow Leopard users will need to build SIP and PyQt for both architectures (i386 and x86_64). PyQt will also require a change to the configure.py file - the i386 line should specify x86_64 as well. If you have an older version of Qt, you will need to upgrade to the newest one, and it is strongly recommended you build with the development versions of SIP and PyQt.
Linux users should note that at this time, some distributions may not have up-to-date packages for PyQt - Reggie! requires version 4.8 for Python 2.x and 5.11 for Python 3.x (it may run with older versions but has not been tested). We have tested the editor on Ubuntu - but note that the packages for Ubuntu 9.04 (Jaunty) and lower will not be up to date. Try using 9.10 (Karmic) or higher instead.
If you're on an older version of Ubuntu (or a distribution which doesn't provide the required PyQt) and you have the patience, you can build Qt, SIP and PyQt yourself. It's fairly straightforward - the normal configure/make/make install process will work for all three.
On all three systems, you can install the optional included NSMBLib package to speed up level loading. Extract the package, go into the directory and run python setup.py install - you will need an appropriate build setup (Visual Studio 2008 on Windows) in order for it to work.
Creating New Levels
Reggie! begins by opening Level 1-1 for you. To create a new level, simply select "New" from the file menu, or press the corresponding tab in the menu bar. A level must have at least one zone and one entrance (usually ID 0), otherwise the level will not work.
Opening Existing Files
Reggie! has two options for opening files.
"Open Level by Name" produces a list of all levels in NSMB Wii, and allows you to choose from the list. This option is useful for getting a feel as to how to design your levels, and for looking up references.
"Open Level by File" allows you to select a file from your hard drive and open it. This option will be used to select your works in progress, or to check out the creations of others.