LCGoldScrapMod

COMPANY-MANDATED MESSAGE:

Listen up, employees! The Company has very important news to share!

Due to a recent series of earthquakes across all moons, remnants of mining activities have shaken loose and revealed scrap items covered in a golden coating. The Company suspects excavators had found gold in the region, and celebrated the occasion by turning their wares into golden versions.

These golden variants are EXTREMELY VALUABLE, effectively doubling the selling value of the original item. So, needless to say, the Company expects ALL employees to return with as many of these golden items as possible. However, as an aside, our risk analysis team does stubbornly keep saying these golden items are also more dangerous, because the gold coating would make the items at least 1.5 times heavier, and due to gold being a conductive metal, but do NOT let this deter you from your scrap-collecting contract!!

That is all for this message. We hope you stay a great asset to the Company.

The Mod

Introduction:

Ready to dive back into the facility to push for even higher quotas?

This mod adds 30 rare gold versions of scrap that greatly reward you for managing to bring them back to the ship. Sell them at the first next deadline to get a ton of extra spending cash, or save them up for later once the quotas get tough to stay in the game and earn your keep for the Company.

But don't expect the journey to be easy, as the added weight and lightning-prone nature of gold scrap will add an extra layer of challenge...

Creation:

• Previous versions of this mod were a little more convoluted than your average LethalLib scrap mod. I'll try to add a technical explanation to the Thunderstore page, under 'Wiki'. But the current version should be stable and flexible, void of major bugs.
• This mod first released as a v0.9.0 Test Release, to get feedback and fix final bugs. Patch notes can be found in the Changelog.
  • Thank you so so so much to everyone who already downloaded the Test Release! Seeing that download count soar up was absolutely unreal. And I recommend upgrading to v1.5.0, as there are some very cool additions and very important fixes.
  • I still have more ideas for this mod, so please stay tuned to see what more this mod will have to offer.
• Personally speaking, the creation of this mod was a giant 2-month rollercoaster of a journey with ups and downs and thrills and fears and joys and long evenings, but I'm super happy with the result, and I hope you'll enjoy it too!

Known issues:

• Gold scrap that originated from scrap with special animations does not use the animations of the original item. I do not think I'll be able to solve this, as animations seem to store their data in such a way that it'll be very difficult to use them on the separate gold version.
• Large two-handed gold scrap sometimes spawns in small closets and shelves meant for one-handed gold scrap. I have not been able to find a satisfying solution to this, but it should theoretically not make a gameplay difference.
• Jacob's Ladder sometimes casts shadow of itself or the player holding it. I have tried to minimize the chance of this happening, but this is simply inevitable. I attempted to strike a balance between it looking logical while not casting a shadow of itself, but I don't think I can circumvent the problem entirely.
• Golden Throne sometimes can't be placed by non-lobby hosts. If this is the case, have the lobby host put the item in storage and return it from storage again.
• GoldStore unlockables are sometimes already unlocked when loading into a lobby with the mod for the first time. This happens because mods from a previous save file might have unlocked specific items in a specific order, but I don't think I can feasibly fix this due to the way mods are loaded in alphabetical order.

My apologies if you encounter any other bugs still, but I believe the major bugs should have been stamped out by now.

Credits:

• Big props to Zeekerss, seriously. After having to dissect Lethal Company and how it works so much for this mod, I have come to greatly respect what he has delivered with this game, and it's taught me more programming than my college ever has over the past 4 years.
• Massive, massive, MASSIVE thank-you to poprev-3d for answering a question on the Unity Forums, providing a ready-to-go method to copy models during runtime. Without it, the first version of this mod would likely never have happened.
  • Link to the thread: https://forum.unity.com/threads/reading-meshes-at-runtime-that-are-not-enabled-for-read-write.950170/
• Also a huge thank-you to iwillbenice on the Unity Forums, as they provided a method that made saving and loading audio clips possible. Again, without it, this mod likely would not have gotten released at all.
  • Link to the thread: https://forum.unity.com/threads/create-audioclip-from-byte-in-unity.1205572/
• And despite having gotten rid of the dependency on LethalLib, I also want to thank Evaisa for creating LethalLib and UnityNetcodePatcher as, again, this mod would have never gotten off the ground had these tools not been available.
  • Link to Evaisa's GitHub: https://github.com/EvaisaDev
• Once again thank you to the Lethal Company Modding Wiki and HarmonyLib for all the guides, tools, and all their other work that made developing this mod possible for someone as new to programming as me.
• A big thank-you too to all my friends who supported me in the making of this mod, helped test it, and have given feedback about what they liked and hoped for with this mod. A few key features were modeled after things they enjoyed, or things I thought they would enjoy, so I simply wouldn't be as proud to present this mod had it not been for all their support! <3
• And I would like to give a special thanks to the people who have reached out to me over Discord to share bugs, error logs, and other problems such as balancing. Some things wouldn't have been found, had it not been for them bringing these issues to my attention. So, again, thank you.
• And thank you for checking out or even downloading this mod!

v0.9.0

• Test Release

Release

v1.0.0

• Full Release
• Changes and Fixes:
  • Added first version of GoldStore to terminal
  • Massive balance overhaul to spawn rate of gold scrap
    • Should be more common on later moons, less on earlier moons
  • Fixed lighting bug that made gold scrap appear pitch-black
  • Prevented bug that terminal would not scan for scrap
    • Apparently already an issue in the vanilla game? Works more reliably now
  • Implemented UnityNetcodePatcher to use on Netcoded GameObjects
  • Made various minor adjustments to fix bugs and improve performance

v1.0.1

• Made changes to Gold Nugget:
  • Lightning can now strike newly bought Gold Nuggets
  • Fixed bug that Gold Nugget would not be in terminal when entering lobby for second time
  • Gold Nuggets no longer count towards collected scrap and employee rank
  • Educated our Gold Nugget appraisers so they work slightly faster
• Added answer to terminal's LCGoldScrapMod Help Page explaining compatibility with beta releases

v1.1.0

• Added Bronze Suit and Silver Suit to the GoldStore
• Gold Nugget value has been rebalanced
• Made small changes in preparation for big optimization update in v1.3.0

v1.2.0

• Added option to Config file: Custom Terminal Scan
  • Lets you choose between this mod's custom terminal scan (which works decently), or the vanilla LC scan (which might sometimes break)
• Fixed various minor bugs

v1.3.0

• Updated mod to changes made in v50
• Slightly increased spawn rate of gold scrap
• Massive overhaul to code:
  • Removed dependency on custom LCGoldScrapMod SaveData
    • Figured out how to look for the models upon joining the lobby, meaning it will always load the assets straight from the vanilla game
    • Note: The Config option [Load and Save] is therefore also deprecated. If you go to Thunderstore's Edit Config > LCGoldScrapMod.cfg and still see [Load and Save] without any description, I suggest deleting LCGoldScrapMod.cfg, that will fix it
    • Might also save performance, as it does not need to reserve extra memory for this data
    • Updated terminal's LCGoldScrapMod Help Page to reflect this
  • Made references to terminal's data more flexible
    • Should hopefully make it more future-proof and prevent bugs, should things change in the original terminal

v1.4.0

• Gold scrap can now appear on all moons
  • Including new content added in v50
  • And the spawn rate of gold scrap on Offense and March is finally fixed. It appears LethalLib didn't register half the items on half the moons, meaning some items weren't in the list of scrap at all
• Removed dependency on LethalLib and HookGenPatcher as it caused the above issue, mod works fully independently now
• Fixed various minor bugs

v1.4.1

• Following its inspiration, I had a bit too much fun messing around with the bell...
  • But it is now actually a useful tool for communication!
  • However, because I now count it as a tool, rather than 'normal' scrap, I have lowered its spawn rate on free moons

v1.4.2

• Patch aimed at balancing and bugfixing where possible
  • Tweaked spawn chance of gold scrap:
    • Spawn chance on Experimentation has been brought down
    • Spawn chance on mid- to late-game moons is more evenly spread
  • Tweaked weight of some gold scrap:
    • Gold scrap that originated from scrap without any weight or very little weight is now about 10 lb heavier, to offer more challenge for the reward they give
    • The weight of some two-handed gold scrap has also been brought up, unless it was already significantly heavy
  • Tweaked GoldStore unlockables:
    • Fixed placement interactible of Golden Throne
    • Added silly version of Gold Nugget

v1.4.3

• Tweaked Jacob's Ladder
  • It should now finally display correctly, regardless of who is holding it or if it is pocketed
  • Bulb now turns light and dark depending on its power
  • Slightly decreased weight and increased range
• Tweaked Config option [Replace Sound Effects]
  • Added sounds for Gold Sign
  • Added jump audio to Bronze Suit, Silver Suit, and Gold Suit

v1.4.4

• Moved some code so gold scrap syncing happens on all players, not just the lobby host

v1.4.5

• Tweaked Jacob's Ladder
  • Battery life has been increased by 20 seconds
  • Mimimum value has been slightly increased
  • It can now cast shadows, and thus should no longer shine through walls
    • Unless you really push up against a wall, but since this is also an issue with flashlights in the vanilla game, I am choosing to let this slide
• Tweaked Bronze Suit, Silver Suit, and Gold Suit so they are extra visible to the person wearing them
• Made final minuscule tweaks to spawn chance of gold scrap

v1.5.0

• Further decreased spawn chance of gold scrap on earlier moons, and further increased spawn chance on later moons
• Fixed compatibility issues that would occur in combination with specific BepInEx configurations
  • One of the BepInEx options, if left on its default value, would clash with a method I was using to make certain actions happen on a delay.
    To circumvent the issue, I no longer use that method, but just change the moment my own actions are called.
  • Sorry for this problem, I was completely unaware that this was even happening behind the scenes. Since I have reorganized the order of code that caused the problem, it might mean you could see very small discrepancies with v1.4.5, but everything else should function the same after going to any level for the first time.
  • And I am counting this as a minor update, rather than a patch, as this should hopefully resolve problems large amounts of people might have been facing, given that BepInEx is a dependency for this mod. Again, my apologies.

v1.6.0

• Implemented adjustable settings and compatibility with custom moons
  • Added 8 Config options across 2 categories
    • All the options listed below use the lobby host's selected values
    • Adjustments:
      • [Selected Moons]
        • Will determine which vanilla Lethal Company moons gold scrap can spawn on, simply by typing their names, All, or None.
        • By default set to All
      • [Minimum Value Multiplier]
        • Will determine the lowest random value of gold scrap, by multiplying the original item's minimum value by this amount.
        • By default set to 2.5
      • [Maximum Value Multiplier]
        • Will determine the highest random value of gold scrap, by multiplying the original item's maximum value by this amount.
        • By default set to 2
      • [Rarity Multiplier]
        • Will determine the spawn chance of gold scrap on vanilla Lethal Company moons.
        • By default set to 3
      • [Weight Multiplier]
        • Will determine how heavy gold scrap is by multiplying the original item's weight, or custom-made weights, by this amount.
        • By default set to 1.5
    • Modded Moons:
      • [Modded Spawn Enabled]
        • If true, gold scrap can spawn on moons added through mods.
        • By default set to true
      • [Modded Spawn Rarity]
        • Will determine the spawn chance of all gold scrap on modded moons.
        • By default set to 1
      • [Modded Minimum Cost]
        • Will determine the minimum value that a modded moon needs to cost to travel to for gold scrap to be able to spawn there.
          • For example, setting this to 500 will spawn gold scrap on modded moons that cost 500, 700, 1000 etcetera, but not on moons that cost 499, 250, 100, or are free.
        • By default set to 0
• Completely reworked layout of Edit config's LCGoldScrapMod.cfg
  • This will undoubtedly look weird in the mod manager, so I recommend deleting LCGoldScrapMod.cfg under Edit config and opening the game again with the mod active. This will fix it and use all the new Config options.
• Other bugfixes and changes:
  • Added backwards compatability with pre-v50 versions of Lethal Company
  • Slightly tweaked the default values of gold scrap now that they can be changed through the config options above
  • Gold scrap can no longer be grabbed before the game has started, as the weight-syncing would otherwise introduce bugs
  • Updated the terminal's LCGoldScrapMod Help Page with this update's new information
  • The terminal won't scan for gold scrap if the current moon cannot spawn gold scrap, based on the config options above
  • Added Customization paragraph to readme, introducing config options listed above
  • Fixed tiny discrepancy with GoldStore suits that could happen at the very start of the game, introduced by the previous update
  • Gold scrap gets registered slightly earlier, to hopefully fix a bug of them not being found, without breaking existing references
  • Got rid of some redundant code and cleaned up loose ends to prepare for compatibility with future mods of mine

v1.6.1

• Fixed bug of that Gold Nugget did not have corresponding sales value, which would halt gameplay if the game tried to put it on sale

v1.6.2

• Fixed bugs that would pop up in larger modpacks:
  • Checks for item assets are now more flexible, so gold scrap should more consistently use the original item's models
  • Fixed Gold Nugget item sales values conflicting with other mod's item sales values, by moving the moment they're registered into the store
• Set default value of config [Other Scan Command] to false
  • Again, I recommend deleting this file if it looks weird, so it will fix itself the next time you play

v1.6.3

• Fixed bug of GoldStore unlockables not being loaded upon joining the lobby

Okayyyyy, I hope those are really the last of the major and minor bugs and tweaks, so I want this to be the final update of v1.
Thank you to everyone who downloaded, liked, and shared this mod, I still can't quite believe this got as much attention as it did. For now, I am going to get some much-needed rest, work on some smaller mods, and focus on college a bit more. But I'll keep cooking up ideas for the future of this mod, and I am very, very, very excited to work on some of those ideas, so I hope you look forward to it too, and I'll see you on the other side!
~ Simon