Is there a consensus on mod archive file format?

Post » Sun Apr 18, 2010 2:55 pm

I'm interested in people's preferences in relation to the formatting of mod archive files. Specifically, which of the following formats do most people prefer?

A. Flat

Example:

BookArt
Icons
Meshes
Textures

B. One-level

Example:

Data Files
... BookArt
... Icons
... Meshes
... Textures

C. Two-level

MyModName
... Data Files
...... BookArt
...... Icons
...... Meshes
...... Textures

Also, where do most people like the README file?
1. At the same level as the Data Files folder
2. Inside the Data Files folder
3. Inside a specific folder (e.g. Docs) under the Data Files folder

Personally, when I install mods, I use a very organized method that works great for me no matter how the archive file is formatted; but I might as well make my mods as easy to install as possible for other people.

Please, share your thoughts. I enjoy the company. ;)

EDIT: Third question --

README file name format?

a. modname.txt
b. readme_modname.txt
c. modname_readme.txt

readme, Readme, or README?
User avatar
Stephanie Valentine
 
Posts: 3281
Joined: Wed Jun 28, 2006 2:09 pm

Post » Sun Apr 18, 2010 6:20 pm

I'm interested in people's preferences in relation to the formatting of mod archive files. Specifically, which of the following formats do most people prefer?

Data Files... BookArt... Icons... Meshes... Textures

Also, where do most people like the README file?

Inside a specific Docs folder under the Data Files folder. This should be a standard encouraged by Wrye's Mash, usually modders naming their readme as "readme.txt" instead of "mymodname.txt" don't care about it though...
User avatar
rebecca moody
 
Posts: 3430
Joined: Mon Mar 05, 2007 3:01 pm

Post » Mon Apr 19, 2010 12:29 am

I use the B style for the layout and put my readmes in the main archive. If I include any other documents from mods I use, I put them into a docs folder outside of the data files one. As for the readme name, I name it modname readme.txt.
User avatar
Isabel Ruiz
 
Posts: 3447
Joined: Sat Nov 04, 2006 4:39 am

Post » Sun Apr 18, 2010 6:12 pm

I'm with Jac and abot about the folder structure, except that I'm with abot on the readme. The mod readme(s) (named as Jac suggested) should be in a Docs folder inside the Data Files Folder. This is what Wryemash expects and I think it's a great tool for installing mods. One caveat: if there are specific instructions pertaining to installing/updating the mod, *that* readme should be outside of the Data Files Folder with a name like 'Installation Instructions'.

As far as archivers go, 7-zip is on the top of my list and Winace (.ace) is in the sub-basemant. Executable self-installers are above winace on the bottom of my list, with .zip and .rar sharing the middle slot. This is from the installation side. Those who pack archives may have good reasons why one may be better than another.
User avatar
Andrea Pratt
 
Posts: 3396
Joined: Mon Jul 31, 2006 4:49 am

Post » Mon Apr 19, 2010 2:05 am

I like option B, although A would be a fine second choice. Both work perfectly with the Installers feature of Wrye Mash. Even before I used Wrye Installers, the first folder with the mod name meant I couldn't install directly from the archive programs I used to extract them, at least that I could figure out.

For the readme I like it when the mod name is first, but that's less important. The reason being that all my readmes go into one folder and it makes it just a little easier to find.
User avatar
Justin
 
Posts: 3409
Joined: Sun Sep 23, 2007 12:32 am

Post » Sun Apr 18, 2010 4:23 pm

I like option B, although A would be a fine second choice. Both work perfectly with the Installers feature of Wrye Mash.

Yup. I'd go with A or B so that the Mash Installers (BAIN) has an easier job of it.
User avatar
leni
 
Posts: 3461
Joined: Tue Jul 17, 2007 3:58 pm

Post » Sun Apr 18, 2010 3:36 pm

The format I always use is B, 2, C, ReadMe. (in order)
Straitforward, as well as easy to understand and install.
(You just drop it into your main "Data Files" folder, and you're good to go.)
User avatar
Ezekiel Macallister
 
Posts: 3493
Joined: Fri Jun 22, 2007 12:08 pm

Post » Mon Apr 19, 2010 1:22 am

Thanks for all the opinions! Keep them coming.

Myself, I like B 1 c Readme.

1 only because I have a completely separate mods directory where I keep all the archive files, each in its own folder. I unpack them there, read the readme, and then copy everything by hand into Data Files. This helps a lot when dealing with mod conflicts.

It looks like the location of the readme file has the largest variability in personal preference. I'll wait until I see some more comments before (arbitrarily) picking something. :)

I agree with Elaura about the ordering of archivers. 7-zip is great! That's what I'll be using.
User avatar
Jennie Skeletons
 
Posts: 3452
Joined: Wed Jun 21, 2006 8:21 am

Post » Sun Apr 18, 2010 10:11 pm

A or B for file structure.
3 for readme location - '...\Data Files\Docs'.
A for doc file name - no need to append 'readme', what else would it be? :rolleyes:

Wrye Mash is the most suggested tool for managing mods, so it would behoove you to match formats for what it expects. And that's still a superior organizational format for those using other managers (or just the MW Launcher).

You should consider making this into a poll... :lightbulb:
User avatar
kyle pinchen
 
Posts: 3475
Joined: Thu May 17, 2007 9:01 pm

Post » Mon Apr 19, 2010 12:21 am

Well, I added a poll, and it was there for a while, but now all the questions have disappeared. Did I do something wrong? Is there a trick to adding a poll to an existing topic?

EDIT: OK, I just entered it again. (Does not like apostrophes or backslashes!)
User avatar
Kristian Perez
 
Posts: 3365
Joined: Thu Aug 23, 2007 3:03 am

Post » Mon Apr 19, 2010 1:02 am

To chime in on the archive/compression format: be careful with 7zip. I think it's a wonderful utility, and love the compression level it provides. But I have seen it corrupt numerous esps for no apparent reason. That is why I stopped using it to distribute Fliggerty's Armor Project.
User avatar
Davorah Katz
 
Posts: 3468
Joined: Fri Dec 22, 2006 12:57 pm

Post » Mon Apr 19, 2010 1:51 am

Wow...I wasn't aware of that. :lmao:
User avatar
Skrapp Stephens
 
Posts: 3350
Joined: Mon Aug 06, 2007 5:04 am

Post » Sun Apr 18, 2010 7:57 pm

My favourite archive setup is:
- Flat
- Readme file called "modname Readme.txt" at the same level as "modname.esp"

If a mod isn't shipped in this manner, I usually extract, edit, and repack it. About 7zip corrupting esp files: I haven't heard of that either, and I have never experienced it so far. Basically, I'm fine with most any standard compression format. To me, "standard" currently means 7zip, rar, or obsolescently zip. Other formats are fine too, though (except for .ace since that took my previous anti-virus program ages to scan).
User avatar
Phillip Brunyee
 
Posts: 3510
Joined: Tue Jul 31, 2007 7:43 pm

Post » Mon Apr 19, 2010 1:39 am

I'd like the readme to say something more unique like Dontreadme :P Because that ought to work better haha.
User avatar
Alan Cutler
 
Posts: 3163
Joined: Sun Jul 01, 2007 9:59 am

Post » Sun Apr 18, 2010 7:26 pm

A or B, 1, C. I like to have the Readme in some way reflect what mod it's with so it can be found without having to read a hundred or readmes later on.

Also, I used to use 7zip, and I really liked it... but at that time (I don't know about now) it wouldn't handle ace files. Rather than have two compression utilities for different types of files, I went to tugzip, and I'm very happy with it.
User avatar
sam
 
Posts: 3386
Joined: Sat Jan 27, 2007 2:44 pm

Post » Sun Apr 18, 2010 7:37 pm

If I had a nickel for every mod file that I had to unpack and then repack so that Wrye Mash would recognize the file structure, I'd be a rich man. :) My biggest peeve is the files that are packed 4 layers deep with the mod name as a folder name. 8) I would love it if a standard were adopted, whichever it may be, so it wouldn't be so tricky getting things to work right.

And that's my two septims worth! :angel:
User avatar
Lilit Ager
 
Posts: 3444
Joined: Thu Nov 23, 2006 9:06 pm

Post » Sun Apr 18, 2010 7:19 pm

The polling results are very interesting. If you haven't voted yet, please do!

It sounds like Wrye Mash organization is pulling ahead as the preferred method, which is fine by me!
User avatar
Lovingly
 
Posts: 3414
Joined: Fri Sep 15, 2006 6:36 am

Post » Sun Apr 18, 2010 8:12 pm

Flat
At the same level
readme_modname
don't care
User avatar
Nancy RIP
 
Posts: 3519
Joined: Mon Jan 29, 2007 5:42 am

Post » Sun Apr 18, 2010 3:26 pm

My experience with MASH, flat for file order. Mash can also cover documentation, so it is ok to have in the same folder. Readme with mod name. I mean I don't really care but for MASH this is it.

I review any mods I downloaded, change/delete files, repack it for mash in above format and install it via MASH. I found it very easy to install so I don't have to click overwrite buttons every time. And I can review if it has gone good from MASH interface, conflicts and such. Only problem would be my duplicates have duplicates. :)
User avatar
Jonathan Windmon
 
Posts: 3410
Joined: Wed Oct 10, 2007 12:23 pm

Post » Sun Apr 18, 2010 11:17 pm

Another thing to consider is that the readme be in plain .txt format. Keep it simple. :sleep:
User avatar
Zach Hunter
 
Posts: 3444
Joined: Wed Aug 08, 2007 3:26 pm

Post » Sun Apr 18, 2010 8:17 pm

I don't tend to care about formats, but I like a flat organization, with the readme named the same as the .esp file.

Not that what modders package makes any difference. Every time I download a mod, I repackage the mod into an ultra-compressed .7z file like so:
.\Docs\Flora Glow 1.0.txt     <-- Same name as the .esp file..\Flora Glow.bsa.\Flora Glow 1.0.esp.\BSAReg.exe


This means that each time I want to install a series of mods, I select them, and { Right Click > 7-Zip > Extract Files... }. Once I put in my Morrowind Data files directory, all are installed. An "Extras" folder is also made for mods that have compatibility files.
User avatar
Chavala
 
Posts: 3355
Joined: Sun Jun 25, 2006 5:28 am

Post » Mon Apr 19, 2010 12:43 am

tetchy - Good point. I agree that simple txt files should be easily readable by anyone.

Lordrea - I'll keep the 'Extras' folder in mind in case I end up with any ... well, extra ... stuff that I want to include with my mods.
User avatar
Juliet
 
Posts: 3440
Joined: Fri Jun 23, 2006 12:49 pm

Post » Sun Apr 18, 2010 1:05 pm

It is absolutely critical that any new resources must be in a subdirectory of the appropriate directrory ( ../Data Files/Texture/NI/NItx_mytexture.dds ). There is little that is more annoying than to have to move the textures, .nif's, book arts and so-forth into appropriate directories and then rebuild the .esp's and .nifs to match the corrected file locations. Many if not most mod users download & install hundreds of mods. Trying to sort through a single directory of 734681 texture files is all but impossible when browsing for a particular texture.

As to the readme.txt file the only concern is that it is not named "readme.txt" I will be move this file into the ../Data Files/readmes/ directory and renam it modname.txt.
User avatar
Nathan Hunter
 
Posts: 3464
Joined: Sun Apr 29, 2007 9:58 am

Post » Sun Apr 18, 2010 8:17 pm

It is absolutely critical that any new resources must be in a subdirectory of the appropriate directrory ( ../Data Files/Texture/NI/NItx_mytexture.dds ). There is little that is more annoying than to have to move the textures, .nif's, book arts and so-forth into appropriate directories and then rebuild the .esp's and .nifs to match the corrected file locations. Many if not most mod users download & install hundreds of mods. Trying to sort through a single directory of 734681 texture files is all but impossible when browsing for a particular texture.

As to the readme.txt file the only concern is that it is not named "readme.txt" I will be move this file into the ../Data Files/readmes/ directory and renam it modname.txt.


I agree about the textures being hard to work with in one folder, for sure... but I (and I suspect more than a few others) have no idea how to make that work. I don't want to hijack the thread, but if anyone has a good tutorial or "how to" on putting textures in subdirectories, I for one would really appreciate it.
User avatar
Rachel Cafferty
 
Posts: 3442
Joined: Thu Jun 22, 2006 1:48 am

Post » Sun Apr 18, 2010 10:51 pm

I agree about the textures being hard to work with in one folder, for sure... but I (and I suspect more than a few others) have no idea how to make that work. I don't want to hijack the thread, but if anyone has a good tutorial or "how to" on putting textures in subdirectories, I for one would really appreciate it.



I was about to ask the same thing. I'd love to be able to do it this way. Any tips?
User avatar
XPidgex Jefferson
 
Posts: 3398
Joined: Fri Sep 08, 2006 4:39 pm

Next

Return to III - Morrowind