Sheepdog2142 / VABOrganizer-Sheepdog

Config files for part mods to support VABOrganizer
Other
0 stars 5 forks source link

Naming suggestions #10

Open JadeOfMaar opened 2 months ago

JadeOfMaar commented 2 months ago

I had a conversation with @hebarusan (of the CKAN staff) and he suggested that (assuming this will appear on CKAN) its identifier be VABOrganizer-Sheepdog (and ideally the mod folder be named VABOrganizerSheepdog). This also helps the patches in this mod to run after VABO itself (in case that advantage is ever needed) and further reduces or prevents the need of the FOR command. The patches in this mod would then automatically run after any patches within VABOrganizer. If you're not inclined to rename your mod folder to "VABOrganizerSheepdog," at least please fix the typo "VBA" in the current folder name "SDVBAO." It will be very much appreciated.

I'll soon be releasing my own config work separately and that'll have the identifier VABOrganizer-Jade and similar mod folder name. The reason I'm doing my own release is that the mods I'm covering (not just my own) are still advancing/growing and their subcategories may change. This case doesn't prevent me from contributing to this project.

HebaruSan commented 2 months ago

For reference, I was thinking of other mods that have this main-mod–supplemental-mod pattern, where we have historically used the main mod as a prefix, then a hyphen, then the supplemental mod:

image

This way it is easy to remember the tightly coupled relationship between the mods, and it also helps humans to find all of the supplemental mods by visually scanning the identifiers.

I have tentatively used this pattern in KSP-CKAN/NetKAN#10184.

Sheepdog2142 commented 2 months ago

Im fine with the Rename No issues here.

Sheepdog2142 commented 2 months ago

@HebaruSan I like that as well as I plan on doing a few more mods and moving everything under SheepDog Institute.

If You or Jade is cool with it then: SheepDog Institute - VABOrganizer or SheepDog Institute - VABO Support

If not I dont mind using his suggestion.

Adventurer13 commented 2 months ago

@Sheepdog2142 To reiterate and clarify what @HebaruSan and @JadeOfMaar are saying, I think the renaming suggestion is for the VABOrganizer mods to appear after VABOrganizer and next to each other (when sorted by Name) in the GameData folder rather than spread throughout or nested in other folders. It also helps when finding supplemental mods in CKAN when they appear next to each other in the list.

So for example: A-U named mods VABOrganizer VABOrganizer-ModA VABOrganizerModZ W-Z named mods

or how it is currently in my GameDate folder: VABOrganizer_FolderExample

Your suggestions of

SheepDog Institute - VABOrganizer or SheepDog Institute - VABO Support

would cause this mod to appear separately (and earlier in the load order) from the mod you are coupled with. This makes it easier for someone to forget to uninstall this mod when they uninstall VABOrganizer, which may potentially cause problems later on.