don't click here

[TUTORIAL] Editing Sprites with SonMapED

Discussion in 'Engineering & Reverse Engineering' started by CupcakeLove67, Mar 14, 2025.

  1. CupcakeLove67

    CupcakeLove67

    More known as PeanutNoceda Member
    [This is a repost of SSRG tutorial]
    First of all, if you want to download the tool, here is.
    So, what is SonMapED?
    SonMapED is a sprite mappings editor for Sonic 1, Sonic 2, Sonic 3, Sonic & Knuckles and Sonic Crackers made by Xenowhirl for Windows. It supports dynamic reloading cues, and features image importing/exporting, palette editing, tile viewing, extracting-from-ROM, and compressed art loading/saving.

    Already saying this, time to go to action!
    when you enter to the program you need to select a game format
    [​IMG]
    For this tutorial, we are going to use Sonic 1.
    To load the Sonic Art (or any art file) go to file and click on "load Uncompressed Tile Graphics"
    [​IMG]
    I want to say that the Uncompressed Art its located in the Artunc folder in your disasm.
    If you loaded them right, the result should be something like this:
    [​IMG]
    Now, maybe you are asking how you can load Mappings and DPLCs... Dont worry! go to file again and you will find this, "Load Sprite Mappings" is for load Mappings, "Load Sprite Pattern Cues" are for DPLCs.
    [​IMG]
    You can change the sprite with SHIFT + }
    Now, in the part that says "Load Primary or Full palette" you can load the colors, the palettes are in the "Palette" folder in your disasm, and after that... Tadaaa~, you loaded the colors!
    [​IMG]
    Now, to edit the sprite, save is as an image, use the "save to image" option:
    [​IMG]
    To load an image, select "Load form image" to be specific, this option:
    [​IMG]
    And now, the last part, saving the file, go to File and select the option "Save Data File"
    [​IMG]
    There you can save the Sprites.
    Thats all for now, thanks!

    Credits:
    Guide creator: PeanutNoceda
    SonMapED: Xenowhirl
     
    Last edited: Mar 19, 2025
  2. Kilo

    Kilo

    The Scatterbrained Hacker Tech Member
    1,307
    1,239
    93
    Canada
    Sonic 1 Source Code Recration
    I would not recommend using SonMapED (And neither does Sonic Retro's wiki) in this day and age. The UI is archaic, highly dependent on shortcut keys that can take a long time to memorize for beginners, and centring and shifting sprites is a nightmare when all the sprites are visible in a single, black viewport. And it's fixed to only support 4 games, and only partially. Flex 2 is the new standard, with a more user-friendly UI and the capability to define any game's sprite format via Javascript. And even supports community made compression formats like Kosinski+ and Comper.
    This tutorial also fails to teach you how to actually edit sprites, all you've done is import an image on top of existing sprites. How do I insert new sprite pieces? Position them? What about creating new frames and tiles?
    Don't let these criticisms dissuade you from tutorials. I'm just asking you to do more research on what the current standards are, and making sure you include other important information. A comprehensive Flex 2 manual would be great.
     
  3. Clownacy

    Clownacy

    Tech Member
    1,149
    827
    93
    I maintain an improved clone of SonMapEd that addresses some of its shortcomings, like its lack of Kosinski+ and Comper support. It might worth considering over the original SonMapEd.
     
  4. Selbi

    Selbi

    The Euphonic Mess Member
    1,530
    145
    43
    Northern Germany
    Sonic ERaZor
    @Kilo Why is it that every time someone tries to post something helpful here, one or more Tech Members have the nerve to go "uhm actually"? You aren't encouraging, you're doing the exact opposite. No wonder this subforum is dead; you always gotta worry about someone trying to one-up you without asking.

    And for the record, claiming that Flex 2 is the only worthwhile standard to use is just plain ignorant. I've been using SonMapEd for years and only switched away from it after ClownMapEd got released. I couldn't get used to Flex's UI, much like you apparently can't get used to SonMapEd's UI.

    In a nutshell, holy fuck, let newcomers shine without immediately trying to piss in their shoes.

    @PeanutNoceda Great tutorial!
     
    • Agree Agree x 4
    • Like Like x 1
    • List
  5. DeltaW

    DeltaW

    Originally a Wooloo Member
    Couldn't agree more with what Selbi said. I do appreciate a newbie giving a tutorial and making a shot at trying to help others, and while it is a bit empty lacking some extra steps like adding additional sprites for example, at least they're giving it a go and aren't doing anything wrong from what I see. However, I agree that ClownMapED is still worth using over the original as it supports those modern decompressors one might use.

    There are still people out there who may be comfortable using older tools like SonED2 or disassemblies from the mid-2000s, much like those who are willing to stick to older OSes, which is perfectly fine. Not everyone is willing to jump to newer stuff and probably learn various new things. I also used SonMapED for the first couple of years of ROM hacking and had no issues with the features it provides. We all need to work in our comfort zone, and if one feels comfortable working with older tools, as long as it benefits them, you shouldn't have to worry and just let them enjoy themselves.
     
    Last edited: Mar 15, 2025
    • Like Like x 1
    • Agree Agree x 1
    • List
  6. saxman

    saxman

    Oldbie Tech Member
    People should use what they personally are comfortable with at the end of the day. There's no right or wrong if you can get the desired job done either way.

    I don't think there's a problem pointing to other tools as potential alternatives, but we should also be a bit more encouraging when people put their time and energy into something.

    Take it from someone who's personally felt discouraged by the community at times. I won't bring up past examples, but they're there. My approach: be honest in your opinions, but refrain from discouragement too.
     
  7. Kilo

    Kilo

    The Scatterbrained Hacker Tech Member
    1,307
    1,239
    93
    Canada
    Sonic 1 Source Code Recration
    I have nothing to gain by "one-upping" a tutorial, I just want to provide better solutions when they are available. I tried wording it as nicely as I saw fit, and I encouraged PeanutNoceda to write a manual for Flex 2. And while I overlooked ClownMapED, it doesn't change the fact that SonMapED is incomplete, outdated, and shouldn't be used by newcomers wanting to get into the scene.
    Blaming tech members trying to be helpful as the reason for the forum being dead is not productive, though. And we need to look at other factors. What I notice is a lack of modern resources on how to even begin with ROM hacking. Like, there's a 17-year-old guide titled "So, you want to start hacking Sonic?" currently pinned to the board which suggests manually hex editing a ROM and using even older tools like ESE. This is not a good resource in 2025, and it's one of the first guides someone wanting to get into hacking will see when they enter this board.
     
  8. Jayextee

    Jayextee

    Unpopular Opinions™ Member
    3,283
    80
    28
    Atro City
    I DONE MAKED GAMES.
    Yeah, that's my topic. I started it with good intentions but sorta fazed away from it all and, okay, my attention span has never been good. I just know that now. But it should absolutely be unpinned/unstickied because, yeah, it's outdated as all hell and there are WAY better hacking methods and tools now.
     
  9. CupcakeLove67

    CupcakeLove67

    More known as PeanutNoceda Member
    Thanks!
     
  10. Cooljerk

    Cooljerk

    Professional Electromancer Oldbie
    5,092
    734
    93
    While I don't find anything wrong with steering someone in a different direction, I'd just like to address the specific word "outdatred" and the part about how it shouldn't be used: I use outdated software all the time. Sometimes it's logistics -- I can't afford to upgrade something. Sometimes it's skill -- I'm more used to an older program. Sometimes it's just pure preference -- I use nano frequently as my text editor for no other reason than I like it and it's small. If something is still useful to someone, it's not outdated, and people shouldn't use newer stuff just because it's newer. Who knows, maybe this person finds the layout and workflow of SonED better than the alternatives. Not being snarky, but it feels weird to talk about stuff being outdated, when we're talking about hacking a 30 year old game.
     
    • Like Like x 3
    • Agree Agree x 1
    • List
  11. Selbi

    Selbi

    The Euphonic Mess Member
    1,530
    145
    43
    Northern Germany
    Sonic ERaZor
    Exactly what makes you think starting your response with "I would not recommend using the very tool you have just spent a considerable amount of time writing a tutorial on" is helpful?
     
  12. qwertysonic

    qwertysonic

    Member
    1,068
    395
    63
    creating the biggest sonic collection
    Wait SonMapED is outdated? Now I feel really old. I remember using ESE back in the day.
     
  13. CupcakeLove67

    CupcakeLove67

    More known as PeanutNoceda Member
    Yes lol, but some people (Like me) still uses SonMapED.
     
  14. DaBigJ

    DaBigJ

    The Bubsy fan of all time Member
    19
    10
    3
    Flex 2 does not work with HiveBrain 2005, though, which is what a decent amount of Sonic rom hackers still use. I tried, but it just doesn't. I'm also still struggling with SonMapEd despite the tutorials because for some reason it crashes when I try to replace the life icon and displays half of the sprites with garbled stuff even after loading the mappings.
     
  15. CupcakeLove67

    CupcakeLove67

    More known as PeanutNoceda Member
    I think i will reply to this.
    Yeah, now Flex2 is the best to edit art, but what about the users that still uses SonMapED?
    Or if some people doesnt like to use Flex2, or use both (like me), thats why i did the guide.
    I want to show to the people how to use SonMapED if they doesnt want to use Flex2.
     
  16. Devon

    Devon

    Please do not contact me, overwhelmed with stuff Tech Member
    1,530
    1,892
    93
    your mom
    It should be worth noting that the original SonMapEd will not work with the very latest version of the Sonic 1 and 2 (and 3K, I think?) disassembles, because the sprite data was changed to use macros, which SonMapEd doesn't support. I forget if Flex 2 supported these macros, but ClownMapEd does for sure.

    Regarding the usefulness/obsolescence of SonMapEd, maybe it's because I have used it for years, but I prefer the simpler interface of it and how I can use keyboard shortcuts to arrange sprite pieces and organize sprite order and stuff like that. Flex 2 is a bit cumbersome for my liking, though its sprite importer is far superior to SonMapEd's, which is the only reason why I have ever used it. I just stick to what I know best and what personally allows me to work most effeciently.

    SonMapEd is old and has its share of jank, but I still think it is useful... at least for stuff that doesn't use macros for sprite data. I haven't really worked on any real Sonic hacking projects since GameTap 32X, but I should probably fully move on to ClownMapEd if I ever get the itch to do something. Hell, the fact that exists and is designed to work very similarly to SonMapEd should mean that this guide can easily be applied to it, which means that this very much has purpose in 2025.
     
    Last edited: Mar 18, 2025
  17. CupcakeLove67

    CupcakeLove67

    More known as PeanutNoceda Member
    About this, I recommend load just the art, withouth mappings to avoid these types of problems.