tModLoader icon indicating copy to clipboard operation
tModLoader copied to clipboard

SymLink ExampleMod to Mod Sources as part of setup

Open KryptonIon opened this issue 4 years ago • 5 comments

Description

Give ExampleMod it's own repository. This will make forking the repository much easier, by just forking the mod itself instead of the entire repository containing other components of TModLoader.

KryptonIon avatar Nov 08 '19 14:11 KryptonIon

This has been brought up before, and I personally don't agree. My feeling is that the very nature of tModLoader and ExampleMod is that they have to move in tandem whenever new functionality is added.

Managing pull requests for new features across both repos would be a major pain as well, since each hook with an example would have to be merged and discussed separately.

One thing I think we should do is prominently display instructions on how to make a symbolic link for easy iteration of ExampleMod (in readme.md). I imagine the most common issue contributors wouldn't know how to do is actually push their ExampleMod changes to the repo without resorting to copy and paste shenanigans.

JavidPack avatar Nov 08 '19 20:11 JavidPack

+1 on symlink, works like a charm. Only downside is that if you use the github VS extension in your ExampleMod solution, it doesn't recognize the linked repo for it, so you still need to switch to the tModLoader one for push/pull. Maybe there is a way to figure that out aswell though

EDIT 3 years later: ExampleMod resides inside the tModLoader.sln, so this is not necessary

direwolf420 avatar Nov 08 '19 20:11 direwolf420

Leaving this open as a setup todo task to automatically symlink ExampleMod to Mod Sources

Chicken-Bones avatar Dec 24 '19 03:12 Chicken-Bones

Leaving this open as a setup todo task to automatically symlink ExampleMod to Mod Sources

wait thats possible?

Metacinnabar avatar Jan 23 '20 08:01 Metacinnabar

In addition to this, I'd like to have a button in the Mod Sources menu that downloads the examplemod that corresponds to the release the user is running. We'll have to think about these 2 situations together since we share the ModSources folder among all BuildPurpose.

JavidPack avatar Sep 19 '22 17:09 JavidPack