SMBX CNPC Codes

 ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
 Guide to Custom NPCs
 ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~

                      Written by Redigit and Blue, 2010


This guide is meant to give a comprehensive guide for
dealing with custom NPC codes.

While the feature is implemented in SMBX, it is not
part of the actual program's user interface. All custom
NPCs are set just like custom graphics and are done
manually by the user creating a file in the game
folders. In the folder for the level you wish to use a
custom NPC in, you will create a file with notepad (a
program that comes with your computer) that has the
same exact name as the graphic file of the NPC you wish
to alter.

For example: If you wish to make a goomba not able to
be stomped, you would do the following.

1. Create a new .txt file in the desired level's
   folder.
2. Name the file npc-1.txt
3. Open that file and then place the following text in
   it...

      playerblock = 1
      jumphurt    = 0

   ...and then save the file.

Now in the level in question, the goomba will no longer
be able to be stomped. You may also place it in your
episode folder (if you have one) and it will affect ALL
levels for it.

The following flags can be placed in the .txt file to
affect the NPC. If you want the flags to be set to yes,
put a 1 after the =. If you want them to be set to no,
put a 0.

NPC Player/World Interaction Flags:

grabtop          = Can Mario pick it up and carry it?
grabside         = Can Mario grab this from the side
                   and carry it?
jumphurt         = Will Mario get bounce if he jumps on
                   the top of this NPC?
playerblock      = Will the player treat this NPC like
                   a block?
playerblocktop   = Can the player stand on this NPC?
npcblock         = Will other NPCs treat this NPC as a
                   block?
npcblocktop      = Will other NPCs walk on this NPC's
                   head?
noblockcollision = Passes through blocks.
cliffturn        = Will it turn around when it comes to
                   an edge, rather than falling off?
nohurt           = Set to 1 and it won't hurt you.
noyoshi          = Set to 1 and Yoshi won't eat it.
nofireball       = Setting to 1 prevents fire from
                   harming this NPC.
noiceball        = Setting to 1 prevents ice from
                   freezing this NPC.
nogravity        = Not effected by gravity if set to 1.
speed            = How fast it moves (in percentage)
                   0=0% 1=100% 2=200%
score            = How many points the NPC should give
                   you upon its death/collection. Score
                   can be set to any number from 0-13.
                   Each gives a different amount of
                   points listed below.

                   0  gives 0 points
                   1  gives 10 points
                   2  gives 100 points
                   3  gives 200 points
                   4  gives 400 points
                   5  gives 800 points
                   6  gives 1000 points
                   7  gives 2000 points
                   8  gives 4000 points
                   9  gives 8000 points
                   10 gives a 1up
                   11 gives a 2up
                   12 gives a 3up
                   13 gives a 5up (anything higher than
                                  13 will produce a 5up
                                  as well.)

NPC Appearance Flags:

foreground = This will be drawn in front of other
             sprites if set to 1.
frames     = How many frames the sprites animation uses
             for a single direction.
framespeed = How fast the frames of the sprites
             animation change. 8 is Normal.
framestyle = 0=No Directional Sprites, 1=Left and Right
             movement, 2=Left and Right movement and
             inverted (upsidedown) if Held.
gfxoffsetx = Moves the graphic in a specific direction
             (X) -1 is up, 1 is down.
gfxoffsety = Moves the graphic in a specific direction
             (Y) -1 is left, 1 is right.
width      = The NPCs hitbox width (in pixels)
height     = The NPCs hitbox height (in pixels)
gfxheight  = Only set if sprite height is different
             than Hit box height.
gfxwidth   = Only set if sprite width is different
             than Hit box width.

Good luck with your NPCs!