Language…
17 users online:  Ahrion,  AmperSam,  Ayami, bucketofwetsocks, Darolac, Dispace, Green, Guido_Keller, Hayashi Neru, JezJitzu, Metal-Yoshi94, pnaha, ShadowMistressYuko, signature_steve, Sweetdude, Tomi P, Znes.609 - Guests: 248 - Bots: 272
Users: 64,795 (2,377 active)
Latest user: mathew

How to use Romi's SpriteTool / How to insert custom sprites

So, here is a tutorial on how to use Romi's SpriteTool.
Let's begin!

In this example, I will use the Boomerang Bro. and the Boss Bass.

You will need:
- Romi's SpriteTool
- Your ROM Hack
- Notepad
- Lunar Magic
- Windows XP/Vista/7

Preparing
1. Backup you ROM
2. Move it to SpriteTool's directory.
3. Create a new text file.
4. Type HEX numbers, then a space and the sprite's *.CFG file. In our case, we will type in:
Code
01 bass.cfg
02 boomerang_bro.cfg
03 boomerang.cfg

See how I set this up? If a sprite uses a sprite that's not in the game, then you need to put it DIRECTLY after the sprite. In our case, we will use the Boomerang Bro., so we put the boomerang RIGHT AFTER the sprite's *.CFG. Here is how does the list look in my Rom hack:
Code
01 albatoss.cfg
02 classic_goomba.cfg
03 boomerang_bro.cfg
04 boomerang.cfg

5. Save the text file.

Note: Sprites that are normal go into the "sprites" folder. Sprites, that are shoooters go into the "shooters" folder and sprites, which are generators go into the "generators" folder.

Note 2: If you're using a sprite, then its number must be between 01 and BF. If you're using a shooter, the its number must be between C0 and CF. Generators can only use numbers between D0 and DF.

Note 3: The sprites CANNOT have spaces in their names, so beware.

How to insert the sprites
1. Open "sprite_tool.exe".
2. Enter your Rom's filename and hit <ENTER>. If SpriteTool accepts the name, you can continue.
3. Enter the Sprite List's filename (In my case, sprites.txt). It cannot have spaces in it. Hit <ENETER>.

If there are no errors in the process, your sprites are semi-ready to use.

Graphics!
Almost forgot about that! Go to the "tilemaps" folder, and copy the ExGFX file in your Rom's "ExGraphics" folder. The filename should tell you what slot to use. See another tutorial, if you don't know how to use ExGFX.

Using the sprites
Now our sprites are set up correctly! But, how do we use them? Well, here is how:
1. Open the level you want to put the sprites into.
2. Use the Super GFX Bypass dialog, to load the sprites in the corresponding slot.
3. Switch to Sprite Editing Mode.
4. Press <INSERT>.
5. In the "Sprite Command" textbox, type in the sprite number. If your sprite uses an extra bit, then type 3 in the corresponding textbox. If it doesn't use extra bit, then type 2 in the textbox.
6. Hit <ENTER>, and should get a "null" sprite on creen 00. Don't panic! You sprite is working properly. Lunar Magic can't display the custom sprites correctly.

Huge and fat note: Do NOT place any sprites in slots E0-FF! Doing so may will freeze your game!

Test you ROM and your sprite(s) should be working!

EDIT: Disabled my layout, for better reading.
You're missing a few important things. First off, sprite .asm and .cfg files go in the /sprites folder in the SpriteTool directory. If they're generators, they go into /generators; and if they're shooters, they go into /shooters.

You also need to mention standard sprites that go in /sprites should only use sprite numbers 00 - BF; shooters can only use sprite numbers C0 - CF; and generators can only use D0 - DF , as they will overwrite existing sprites.
Originally posted by TMI
You're missing a few important things. First off, sprite .asm and .cfg files go in the /sprites folder in the SpriteTool directory. If they're generators, they go into /generators; and if they're shooters, they go into /shooters.

You also need to mention standard sprites that go in /sprites should only use sprite numbers 00 - BF; shooters can only use sprite numbers C0 - CF; and generators can only use D0 - DF , as they will overwrite existing sprites.

I know it, but I forgot the numbers and forgot to point out the folders. I will update the tutorial. Thanks!

EDIT: Grammar fixed!


telinc1: you should have warned us that we cannot put sprites in zone E0-FF as they will freeze the game. And:

Originally posted by "telinc1"
6. Hit <ENTER>, and should get a "null" sprite on creen 00. Don't panic! You sprite is working properly. Lunar Magic can't display the custom sprites correctly.


Actually, Lunar Magic can show custom sprites since the 1.65 version. Check LM's Help File -> "Custom Tooltips of Sprites".
Sorry for being crazy with your tutorials, telinc1, but I find some mistakes in them.





Dream team (feed them, please):






Originally posted by Fierce Deity Manuz OW Hacker
telinc1: you should have warned us that we cannot put sprites in zone E0-FF as they will freeze the game. And:

Originally posted by "telinc1"
6. Hit <ENTER>, and should get a "null" sprite on creen 00. Don't panic! You sprite is working properly. Lunar Magic can't display the custom sprites correctly.


Actually, Lunar Magic can show custom sprites since the 1.65 version. Check LM's Help File -> "Custom Tooltips of Sprites".
Sorry for being crazy with your tutorials, telinc1, but I find some mistakes in them.

Thank you very much! I didn't even knew that! Also, I know about the custom tooltips, but if you haven't noticed, this is a tutorial on how to insert custom sprites, not on how to make them look right.


Yes, I know this, but you can't say this either:
Originally posted by "telinc1"
Lunar Magic can't display the custom sprites correctly.

As I just pointed you out, Lunar Magic actually can display custom sprites since version 1.65 . I just told you that.





Dream team (feed them, please):






Originally posted by Fierce Deity Manuz OW Hacker
Yes, I know this, but you can't say this either:
Originally posted by "telinc1"
Lunar Magic can't display the custom sprites correctly.

As I just pointed you out, Lunar Magic actually can display custom sprites since version 1.65 . I just told you that.

Under this, I mean that Lunar Magic can't read the tiles that the sprite draws, so you must do it yourself. And yes, I know that very well. I'm even using it in my hack, so it's easier to see the sprites. Thank you.
It keeps saying "could not open /sprite.txt"
1. It should be in the same folder.
2. It doesn't necessarily have to be sprite.txt, by the way.
LINKS Twitter | YouTube | SoundCloud | Fortaleza Reznor
to hear birds and see none.
It keeps saying "couldn't open cfg file". Why?
This is temporary
Originally posted by Mario3andU
It keeps saying "couldn't open cfg file". Why?

I hate to be rude, but you kind of bumped a thread which had no replies for around 3 years.. #smw{¬_¬} At least telinc1's still around.
Anyways, the .cfg file needs to be in sprites/shooters/generators, and remember that you need to type it right.
I have a DeviantArt, if you do want to see my art on there. I don't really visit it much now, though.
Originally posted by cheeyev
I hate to be rude, but you kind of bumped a thread which had no replies for around 3 years.. #smw{¬_¬} At least telinc1's still around.


There's nothing wrong with bumping tutorials if you stay on topic. If someone has a quick question about something said in the tutorial, another person might also be able to answer, just like you did.

I used to know how to do this, but it won't work now.
#smw{T_T}
LOADING... 26% 68% 99% 100%
This beautiful Layout is by Technius!
------------------------------------------------------

I SUPPORT


Tag (div) was not closed.
Tag (div) was not closed.
Well, that's a shame.
Seeing as you don't seem to be asking for help I guess that's all you wanted to tell us.
If not, please provide some information on what isn't working or what problem you have.
Anime statistic on MyAnimeList:
400 animes completed ✓
6000 episodes completed ✓
100 Days completed ✓
... what even am I doing with my life?

Nvm. It works.
LOADING... 26% 68% 99% 100%
This beautiful Layout is by Technius!
------------------------------------------------------

I SUPPORT


Tag (div) was not closed.
Tag (div) was not closed.
Whenever I try and insert the custom sprite in the level, it just makes the game freeze. #smw{x_x} Anything we can do about this? And no, I'm not using the values you told me to not use. #smw{-_-2}
*insert random removed layout here*
Originally posted by Hedgemaster
Whenever I try and insert the custom sprite in the level, it just makes the game freeze. #smw{x_x} Anything we can do about this? And no, I'm not using the values you told me to not use. #smw{-_-2}

I honestly can't help you. It's been ages since I've touched Super Mario World and I have no idea what could be causing your issues.
I'm not sure why I haven't added a deprecation notice to the top of the tutorial like I did with all of my other ones, however, keep this in mind: there's a chance the tutorial itself isn't correct (it could be fine too, I don't know). I advise you to restore to a backup (Lunar Magic should make them automatically) and try again.
Sorry for any inconveniences I've caused.
Every time I try to insert custom sprites, theres an error that says the Main label cannot be found. How can I fix that?
What do you want to insert?