Loading Unzipped Map From In-Game Download

Panther

@Cernel I weakly remember that the "-master" addition is needed for the automated procedures at GitHub. However the issue we are discussing here is a side effect and yes, it would be a good idea to hear a developer's comment. After we know more about the background, I will be happy to add a 'how to guide' as you suggested, @prastle .

prastle

@cernel cor but you have left out two things they also need to know. For example Iron war with fuel download from the forum here and Installing a new pre-release engine. In order to run the new maps that use the new features that will not run on current stable they also need to install a pre-release. this should all be covered in one stickied topic in help was my thought to benefit the entire community.

Cernel

@panther Correct, that is just the name of the repository in GitHub, with "-master" added at the end. This is just what GitHub does when you choose to download an entire repository; so the new way was taylored around it.

prastle

@prastle yes the downloader pulls from the master thus why it is needed. As do the bots when updating.

Cernel

@prastle I see those 2 as different matters / topics.

A topic for:

"Where and how to download and install the latest prerelease"
(to test it or play maps using unreleased features)

and another one for:

"How to unzip, and run unzipped, a map downloaded from the official TripleA repository"
(to possibly modify or anyways work on it unzipped)

I actually suggest having the first one in "Help & Questions" and the second one in "Mapmaking".

prastle

@cernel good point but one spot probably best up to you guys. Either way this would allow all to acess easily for example @RogerCooper 's site as well.

Cernel

@prastle I'd just wait what a developer have to say, as I can't believe this thing of needing different paths zipped vs unzipped may be intended; at most accepted (the fact that you need not having the "-master" in the name when unzipped).
Probably here we need @LaFayette , if he will read this post, since the new "master" thing was his creation.

General_Zod

This didn't change when "-master" was added. It happened somewhere afterwards for no apparent reason. Because I recall not requiring to zip files even with that suffix.

Another point to add is that it used to always read and loaded the unzipped version before the zipped version if both were present. However this only applied to the xml itself, the rest of the files still had to be zipped.

It would be best if it read/loaded all the files (not just xml) from a unzipped folder always. This would save a lot of time when mapmaking and testing small changes. ( in 1.8 days it might have done so, don't recall)

redrum

So I think this is probably a side effect of all the map rework. Probably would be best to allow unzipped maps to have *-master so its easier to unzip downloaded map and tweak them.

Cernel

@redrum said in Open unzipped map:

So I think this is probably a side effect of all the map rework. Probably would be best to allow unzipped maps to have *-master so its easier to unzip downloaded map and tweak them.

Definitely. This thing of having different names zipped and unzipped doesn't make sense at all.

prastle

@redrum it occurs for the pulls from the downloader and the bots
they both pull from the master only. You can have 20 versions of a map in the repo. The updater only pulls the master. I know this from updating the bots.

Cernel

@redrum I always wondered if this "-master" addition would create any conflicts with the fact that "-" also identifies mapskins. So maybe keep an eye open on that (might be not relevant, idk).

prastle

@redrum yes if all had master would be easier just make sure all unzipped have master added now If ya want to go that route every map would have to be rewritten. it is much easier to remove the master. Since it is only needed for maps to be updated to the downloader or bots not every map we have ever created.

redrum

PR: https://github.com/triplea-game/triplea/pull/3339

Map name is always found from the XML property
<property name="mapName" value="total_world_war" editable="false">
<string/>
</property>

Unzipped Map Directory Examples (in downloadedMaps)

total_world_war
total_world_war/map
total_world_war-master
total_world_war-master/map

Zipped Map Examples

total_world_war.zip
total_world_war-master.zip

** If for some reason the XML mapName isn't in the format of using underscores, then the checks that use "-master" will convert it to have underscores while the other checks will use the mapName as is. So for example if the mapName was TotalWorldWar the following are valid:

TotalWorldWar
TotalWorldWar/map
total_world_war-master
total_world_war-master/map
TotalWorldWar.zip
total_world_war.zip
total_world_war-master.zip

Cernel

@redrum For the unzipped, I suggest keeping only

total_world_war
total_world_war-master/map

and making not working:

total_world_war/map
total_world_war-master

This way we keep only 2 standards, the basic / old and the GitHub one, instead of 4 different ways.

redrum

@cernel I don't think having support for those other 2 hurts anything. We can always just advertise in the map making guides the 2 which are most commonly used.

Cernel

@redrum Ok. It sounds a bit contradictory just mostly the "total_world_war/map" case, since the map is "total_world_war"; so having inside something called "map" makes sense if the other is the master of the map.

Also, I think that conversion thing is just confusing, and I suggest getting over it, by now. Meaning, not supporting conversion of "TotalWorldWar" to "total_world_war", but just going with it having to be exactly what is written in mapName (so, only "TotalWorldWar", for the master too, if that is the mapName). That looks just like 1 more thing to remember that is not necessary.

Cernel

@cernel Also, if possible, make the game never work if the mapName has any spaces, since you are supposed not having thoses, and it has been an issue, at times. Something like a crash with something telling "you must have no spaces in the mapName: use underscores, instead". Tho I'm not sure if this might be an issue for @RogerCooper ?

redrum

@cernel In general, the XML mapName should always just match the folder name and use underscores so "total_world_war". The only reason I think we left the conversion logic was in case some old maps that aren't in the official repo didn't follow that and had Proper case or used spaces.

Cernel

@redrum Correct and, as I said, I would get over that, and just force it being exactly the same; let people convert their maps properly. Would @RogerCooper have issues with this? I cannot think about any other problem really.
Also that really sounds like something that may bury inconsistent mapNames in the future, perpetuating them.