Proposal for the Standardization of Mod Packaging

[Circuitous]

In order to subvert the occurrence of fifty-thousand screenshots, readmes, and assorted files and folders littering the /Data/ directories of countless - potentially clueless - end-users, I'm proposing this standard for modification packaging, in hopes that current and future mod-makers will make everyone's lives just a little easier during these hard, Construction Set-less times where modding is still a wild art.

 

When packaging a mod that is multiple files, I hereby propose the following - focusing on ease of navigation and installation.

1. Package your mod so that it can be extracted directly to the /Data/ folder. I've opened up so many mods to find /ModName/ as the first directory, it's outrageous.
    
   
2. If you're including readmes or screenshots, put them in appropriate folders, as described below:
   
   • Place screenshots in /Mod Screenshots/<Mod Name>/<screenshots go here>
     
   • Place readmes in /Mod Readmes/<Mod Name>.txt - do NOT use "readme.txt"!
     

[*]Avoid generic names for things (readme.txt, screenshot1.jpg, etc.) - give your files unique and consistent names to make finding pieces easier.

So, to give an example, let's say you're making a mod called Bingo's Bongos. It adds bongos to the game.

 

BingosBongos.7z

|

|-/Meshes/ (No /Data/, just cut right to the chase. This makes extraction/installation easy.)

|--/bongos/

|---bongos.mesh

|

|-/Textures/

|--/bongos/

|---bongos.texture

|

|-/Mod Readmes/ (Rather than having a dozen readmes, which are often all named the same, you have one readme folder.)

|--BingosBongos.txt

|

|-/Mod Screenshots/ (No more screenshots cluttering /Data/!)

|--/BingosBongos/ (And no more inter-mingling of screenshots from various mods, either!)

|---bongos-front.jpg

|---bongos-side.jpg

|

|-BingosBongos.esp

 

I'm hoping that if we get this out there while Fallout modding is still new, we can keep up a healthy standard as advancements continue.

 

If you have any concerns, complaints, or really any thoughts on this setup at all, please post them. This is a community issue.

[illyism]

Genius! A very good idea. :thanks:

 

I hope every modder follows this etiquette.

[mikekearn]

This is nice, but it's also a lot to ask of people. Okay, not a lot, but given that they're already spending time and effort to create something to be given away for free, it can seem like a lot. Really, I would settle for a Readme file that actually makes sense, and has more than, "Made by *mod maker's name*, please don't steal my textures!" Something which is far too common.

[windexglow]

Mike; I think there is a problem when someone can't take 5 minutes before uploading to put the files into the correct folders. Even than, 5 minutes is not much.

[myrmaad]

This is nice, but it's also a lot to ask of people. Okay, not a lot, but given that they're already spending time and effort to create something to be given away for free, it can seem like a lot. Really, I would settle for a Readme file that actually makes sense, and has more than, "Made by *mod maker's name*, please don't steal my textures!" Something which is far too common.

 

 

However, a lot of beginning modders, especially don't really know how best to package their mods, so they just do the best they can. But lots of people use LHammonds Readme generator, so why not keep this example of file structure with that resource or linked to it.

 

Understand though, that some modders use different file structures because their mods require a different approach.

 

 

And really there's no real problem with a structure that reads:

 

bongos/data

/meshes

/textures

 

Terming that "outrageous" is a bit outrageous.

 

 

I personally prefer a meshes and textures substructure as well so instead of

Oblivion/data/meshes/bongo.nif

I much prefer

Oblivion/data/meshes/bongos/bongo.nif

Oblivion/data/meshes/bongos/bongo_black.nif

&

Oblivion/data/textures/bongos/bongo_brown.dds

Oblivion/data/textures/bongos/bongo_black.dds

for example.

 

It would be easy and intuitive to standardize "SS" for the Screenshot directory:

Oblivion/data/SS/bongos/bongo_screen.jpg

 

 

But for readmes, less so.

I do hate generically named "readme.txt" readmes, which means that I either have to skip unpacking them or rename them myself.

[mikekearn]

Well it's never really been an issue for me, as I don't just extract anything into my data folder, because I don't want my data folder cluttered. I extract every mod into its own folder, then copy what I need for the mod to work into my data folder, and nothing else. Readmes, secondary ESPs for those mods who offer the choice, ditto for separate texture or model versions, all stay in their own folder separate from my main data folder.

 

That is why I simply believe a well written Readme is all that should be required. If, after all, it only takes a few minutes for them to organize the files before uploading, why then can you not simply take a few minutes to organize after downloading? Yes, it would be nice to not have to do for the dozens of mods many download, but as I said originally, you're asking even more from someone who is already giving their work away for free.

[throttlekitty]

Well it's never really been an issue for me, as I don't just extract anything into my data folder, because I don't want my data folder cluttered. I extract every mod into its own folder, then copy what I need for the mod to work into my data folder, and nothing else. Readmes, secondary ESPs for those mods who offer the choice, ditto for separate texture or model versions, all stay in their own folder separate from my main data folder.

 

That is why I simply believe a well written Readme is all that should be required. If, after all, it only takes a few minutes for them to organize the files before uploading, why then can you not simply take a few minutes to organize after downloading? Yes, it would be nice to not have to do for the dozens of mods many download, but as I said originally, you're asking even more from someone who is already giving their work away for free.

 

But not every player reads the readmes, which may not make sense to them anyway. I've seen a few mods that say "unpack contents to the data folder" but if someone didn't catch it, they might end up with something like:

 

Oblivion\Data\ReallyNeatMod\meshes

Oblivion\Data\ReallyNeatMod\textures

(or fallout 3, whichever.) instead of:

Oblivion\Data\meshes

Oblivion\Data\textures

 

While I do think mod users should make effort to learn a bit about the structures here, that doesn't always happen, and the troubleshooting process can be difficult if they don't know what needs to go where.

[myrmaad]

Well it's never really been an issue for me, as I don't just extract anything into my data folder, because I don't want my data folder cluttered. I extract every mod into its own folder, then copy what I need for the mod to work into my data folder, and nothing else. Readmes, secondary ESPs for those mods who offer the choice, ditto for separate texture or model versions, all stay in their own folder separate from my main data folder.

 

That is why I simply believe a well written Readme is all that should be required. If, after all, it only takes a few minutes for them to organize the files before uploading, why then can you not simply take a few minutes to organize after downloading? Yes, it would be nice to not have to do for the dozens of mods many download, but as I said originally, you're asking even more from someone who is already giving their work away for free.

 

Oops I think I'm half asleep.

 

Mike, I understand what you're saying, but not the OP's use of the term "outrageous".

Throttlekitty, I enjoy your mods. People who don't read the readmes: I feel like them's the breaks.

 

And when they come along to dis your mod with a low rating, that rating should be tossed out, and it could be if they had to give a prefabbed reason for their dissatisfaction. So if they claim the mod doesn't work, but it's been tested and it does, that rating is tossed.

 

 

About organization, everyone's will be different.

 

I keep my Oblivion folders on a separate hard drive.

 

All the ones that have to do with the game itself, e.g. Oblivion/data etc

go into a directory called TES

 

Another completely unrelated directory houses all my compressed downloads in an organized substructure including a folder for mods I have downloaded but "do not install", "mods 4 later", and then a very detailed substructure of the installed mods based on what they are/do: Real Estate, Wardrobe, Weapons, Animations, Tools, Hair & Beauty, Characters, etc. A shared folder in this directory houses any current readmes I may want to refer to from a second PC while I'm in-game.

 

 

There are a few readmes allowed into my TES/Oblivion/data folder, and they go into a subdirectory I simply call "txt"

So extreme organization isn't unique to you, and it's a bit of a fantasy to expect that modders cater to the way you'd like it.

 

I'm happy for whatever I get, and it's people who sweat the little things that make me sigh with relief that I tend to mod only for my friends.

[Omnimmotus]

I strongly approve of this measure. I wish other things were done the same, especially when there are actual legal ramifications. Now THAT gets annoying.

 

As for the extra "data\" folder in the zip, I also find this annoying. I prefer to simply extract directly to the Data folder, excluding things like the readme. Having some people use the Data folder and others not means I have to have two locations in recent extraction and pick between them based on the circumstance, quite annoying. Outrageous might be a little far, but I do agree that we should pick a standard. (And NOT using the Data folder makes more sense as it eliminates an excess directory in the zip.)

 

The only issue with this setup is that it makes the zip more confusing to navigate. The readme and screenshots aren't as clearly available, and having them in separate directories means you would need to switch between directories to look at screenshots. It might be easier to have it set up as follows:

 

BingosBongos.7z

|

|-/Meshes/ (Like you said, no "/Data/". This standard is important.)

|--/bongos/

|---bongos.mesh

|

|-/Textures/

|--/bongos/

|---bongos.texture

|

|-/Mod Readmes/

|--/BingosBongos/ (Pack them together in one nice directory. Easier to deal with.)

|---readme.txt (Since its in a mod-specific directory, readme.txt can be used. But BingosBongos.txt could still be used too.)

|---bongos-front.jpg (Put the images with the readme. Easier to find that way.)

|---bongos-side.jpg

|

|-BingosBongos.esp

[AnthraxPants]

A set of standards is a good idea. If it only gets some people to stop and think a little about the structure they are going to use, then you could argue it has done its job.

 

Personally I organise everything from folder structure to my own start menu. It is a good habit to get into for your own convenience and to aid backing up/restoring files. I always keep packed files in folders with relevant labels and unpack files into a folder with the original archives name. It all makes life much simpler.