Modding Discussion Material ID registration (To avoid mod incompatibility)

Discussion in 'Starbound Modding' started by RyuujinZERO, Mar 24, 2014.

  1. RyuujinZERO

    RyuujinZERO Supernova

    Unlike objects, races etc. Materials must have a unique ID, if two mods share the same material ID, then the mods cannot function together, they'll simply cause a hard crash. In order to help mitigate that, us over at the race crossover coalition have created our own open document for recording material IDs on.

    While the document is in no way binding, I'd encourage modders who are using custom materials to come and register a block of material IDs for your mod so that people know what to avoid to prevent compatibility issues.

    View/edit the material ID list here!



    Probable FAQ:

    Q: Do i need permission to claim material IDs?
    A: Nope! You don't even need to be signed up, just click the link and type away, your changes are saved automaticlly.

    Q: How many can I claim?
    A: Many as you need within reason. If my hunch is correct there's over 4 billion slots to use, even if you claim a block of a few hundred there's enough room for pretty much every mod that'll ever be made for Starbound.

    Q: Any advice on choosing numbers?
    A:
    Claiming a few seperate blocks is a good idea, objects with higher IDs are rendered below materials with smaller IDs, so you can delibratly choose the order in which materials are rendered if you space out the numbers (like the Avali mod). Oh and I recommend avoiding 9000 and 9001... because you know... it's over 9000. And every silly bugger is going to use that ID. Also obviously I wouldn't use numbers below 1000, since Starbound itself needs room to grow too, and they use the numbers from 0 onwards
     
    Last edited: Mar 24, 2014
  2. Starfoundry

    Starfoundry Space Penguin Leader

    Glad to see someone taking initiative on this! Here's a (brief) start we made on the wiki: http://starbounder.org/Modding:Materials:Mods

    Not sure where the best place to keep the document is, but we should definitely try to use a central location.
     
    The | Suit and Katzeus like this.
  3. RyuujinZERO

    RyuujinZERO Supernova

    Oh, even better! - I forget we have an official starbound wiki.
     
  4. ProkhorVLG

    ProkhorVLG Existential Complex

    It uses IDs for blocks only. Strange, huh? I don't really see the point of them.
     
  5. The | Suit

    The | Suit Agent S. Forum Moderator

    These are just for Material Files - the rest of starbound uses Name's as ID"s

    I really can't think of any other reason besides as a simple method of deciding order of dominance.; So some material id's appear on top of another. When placed in game. That way Roof tiles will always be above Wall tiles. Etc.
    ===========================

    Though creating a Material ID reference dictionary is a good start. I can see it getting really messy real fast.
    Though I honestly can't think of a good "alternative" solution either.
     
  6. RyuujinZERO

    RyuujinZERO Supernova

    I imagine it's an oversight. Materials have their own name tags too - originally races used numeric ID's too, but they moved it over to a name tag system. I expect we'll see a similar shift eventually
     
  7. ProkhorVLG

    ProkhorVLG Existential Complex

    I hope they do, using completely random massive numbers for IDs stops being fun quickly.
     
  8. Mackinz

    Mackinz The Waste of Time

    This thread semi-died before it became of much use...

    I come today to announce that I claim materialIDs 19900 through 20000 for my mods, which I collectively consider produced by the BetterMerchants Company. Currently, there is only two in use (Wicker Platform, id 19990, in my Rattan crop mod; Hydroponics Tech, id 19925, Gallavoir WIP mod) but I've got plans for more in my WIP Gallavoir mod, some thoughts for more Wicker-based materials, and such.

    This thread should be stickied.
     
  9. RyuujinZERO

    RyuujinZERO Supernova

    Thanks for the reminder.

    @Djinn do you happen to remember what the maximum ID number is since Omni changed the limit?
     
  10. Mackinz

    Mackinz The Waste of Time

    Why wait? :p
     
  11. RyuujinZERO

    RyuujinZERO Supernova

    Ah, thanks :D
     
  12. the420urchin

    the420urchin Pangalactic Porcupine

    Yeah, just use the wiki one as people have already been using it and there's another post just like this basically (well it explains the ids as well and the limits). The wiki is known and will show up first thing in searches; the google doc, well, doesn't have either of these going for it.
     
    The | Suit likes this.
  13. Mackinz

    Mackinz The Waste of Time

    We should use both, as not everyone uses a wiki, let alone for modding resources.
     
  14. Kawa

    Kawa Tiy's Beard

    Not gonna be the one keeping them in sync!
     

Share This Page