UnlimitedHugs / RimworldHugsLib

A lightweight shared library for Rimworld modding.
Other
245 stars 59 forks source link

Expose AssemblyFileVersion in log #44

Closed FluffierThanThou closed 5 years ago

FluffierThanThou commented 5 years ago

See FluffierThanThou/Pharmacist#11 for more info on why this matters, although you're probably aware already given the version override you're using yourself.

I've stopped updating AssemblyVersion for non-major releases to make life easier for others referencing my dll's, but unfortunately that means that my dlls are now also reported with the wrong (or at least incomplete) version information in hugslib logs. I'd rather not add a version override file, given that there's a perfectly reasonable alternative (AssemblyFileVersion) available.

It would be nice if HugsLib could either report whichever version is higher, or just report both.

UnlimitedHugs commented 5 years ago

TIL about AssemblyFileVersion. I'll implement that sometime soon- if it's not urgent.

FluffierThanThou commented 5 years ago

no rush, just a QoL thing for me and possible other modders that do this.

alextd commented 5 years ago

So, the root problem here is that people are updating AssemblyVersion. Once HugsLib gets this update, the update news should make people aware to use AssemblyFileVersion for little version updates, TL;DR from https://support.microsoft.com/en-us/help/556041

Now, I may be the only one adding other mod's DLL references in my mods for compatibility purposes so who knows if this is a real problem - but if anyone else is, a change to AssemblyVersion often means compatibility is silently disabled and a re-build mysteriously fixes it.

UnlimitedHugs commented 5 years ago

Update news are for advertising new mod features to players- if used for other things, the player will likely click the X next time they see the window, because they will associate it with being bored. You might simply ask the modder in question to switch to AssemblyFileVersion if your mod is has a dependency on their assembly.

FluffierThanThou commented 5 years ago

Yeah, I agree this is not something that warrants a ping to all players. It's going to be much more efficient to just message the creator of the mod.

That said, i would still like hugslib to report both versions, or the higher of the two.

On Fri, 26 Oct 2018, 1:29 pm UnlimitedHugs, notifications@github.com wrote:

Update news are for advertising new mod features to players- if used for other things, the player will likely click the X next time they see the window, because they will associate it with being bored. You might simply ask the modder in question to switch to AssemblyFileVersion if your mod is has a dependency on their assembly.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/UnlimitedHugs/RimworldHugsLib/issues/44#issuecomment-433377409, or mute the thread https://github.com/notifications/unsubscribe-auth/ARq4Mjt-roEHzWkdETHgSQy11VnJqEQkks5uovIUgaJpZM4XxzUp .

alextd commented 5 years ago

Oh, I wasn't talking about ingame "mod update news"

I was saying more like HugsLib documentation should mention it. People have been saying they update AssemblyVersion because HugsLib uses it, shows it in the logs. I don't know where that is exactly, but that should be AssemblyFileVersion as well.

FluffierThanThou commented 5 years ago

Yeah, that's what this issue is about 😎

On Fri, 26 Oct 2018, 1:46 pm Alex TD, notifications@github.com wrote:

Oh, I wasn't talking about ingame "mod update news"

I was saying more like HugsLib documentation should mention it. People have been saying they update AssemblyVersion because HugsLib uses it, shows it in the logs. I don't know where that is exactly, but that should be AssemblyFileVersion as well.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/UnlimitedHugs/RimworldHugsLib/issues/44#issuecomment-433381153, or mute the thread https://github.com/notifications/unsubscribe-auth/ARq4MoS58RaUrK58ur7hcCkPN2ID5KsHks5uovX-gaJpZM4XxzUp .

UnlimitedHugs commented 5 years ago

Done and done. Release and update notes.

FluffierThanThou commented 5 years ago

thank you!

alextd commented 5 years ago

Great this is a good step to mod compatibility,

(next step is now to teach everyone how to do transpilers)