Giter VIP home page Giter VIP logo

lethal-company-sellmyscrap's Introduction

SellMyScrap

Adds a few terminal commands to sell your scrap from the ship. Highly Configurable. SellFromTerminal +

This mod will sell scrap as close to the requested value as possible.

THIS MOD IS FOR ALL CLIENTS!


  • You must be landed at The Company building to use sell commands.

  • This mod will NOT sell Gifts, Shotguns, or Ammo by default.
    • See Sell Settings for more info.

  • This mod supports excluding custom / modded scrap items from the sell algorithm.
    • See Advanced Sell Settings for more info.

  • This mod will show how much overtime bonus you will receive on the sell confirmation screen.

Download

Download SellMyScrap on Thunderstore.

Terminal Commands

Expand
  • You must be landed at The Company building to use sell commands.
  • Each sell command will sell items based on your config settings.
  • Each sell command requires confirmation before selling your scrap.
    • Additional information is given on the confirmation screen.
Command Description Optional flags
sell <amount> Will sell scrap for a total of the requested amount. -se, -se:<number>, -o
sell quota Will sell scrap to reach the profit quota. -se, -se:<number>
sell all Will sell all of your scrap. -se, -se:<number>
sell item <name> Will sell scrap by their item name. -se, -se:<number>
sell list Will sell all the scrap from the sellListJson config setting. -se, -se:<number>
  • Using the -se flag will spawn a random scrap eater.
    • Usage: <sell-command> -se
  • Using the -se:<number> flag will spawn a scrap eater by their index (Starts at 1).
    • 1 = Octolar, 2 = Takey, 3 = Maxwell, 4 = Yippee, 5 = Cookie Fumo, 6 = Psycho, 7 = Zombies
    • Usage: <sell-command> -se:<number>

Additional info for the sell <amount> command.

  • This command supports math expressions as the input for .
    • Usage example: sell 500 + 50
  • Using the -o flag will sell for a less amount so (less amount + overtime bonus) = initial amount.
    • Usage: sell <amount> -o

Additional info for the sell item <name> command.

  • Item names are not case-sensitive but, spaces do matter.
  • Usage examples:
    • sell item Whoopie cushion
    • sell item Whoopie
    • sell item Whoo

Additional info for the sell list command.

  • This command will sell all the items from the sellListJson config setting.
  • This command will bypass the dontSellListJson config setting.
Command Description
sell Shows a help message for this mod.
view overtime Shows your current overtime bonus.
view scrap Shows a list of all the scrap in the ship.
view all scrap Shows a list of all the registered scrap.
view config Shows your config settings.
edit config Edit config settings from the terminal.

Config Settings

Expand
  • Use the edit config command to edit config settings from the terminal.
  • Only the host can edit Sell Settings and Advanced Sell Settings using the config editor.
  • Sell Settings and Advanced Sell Settings will be synced with the host.
Sell Settings Setting type Default value Description
SellGifts Boolean false Do you want to sell Gifts?
SellShotguns Boolean false Do you want to sell Shotguns?
SellAmmo Boolean false Do you want to sell Ammo?
SellKnives Boolean false Do you want to sell Kitchen knives?
SellPickles Boolean true Do you want to sell Jar of pickles?
Advanced Sell Settings Setting type Default value Description
SellScrapWorthZero Boolean false Do you want to sell scrap worth zero?
OnlySellScrapOnFloor Boolean false Do you want to sell scrap that is only on the floor?
DontSellListJson String [] JSON array of item names to not sell.
SellListJson String ["Whoopie cushion", "Easter egg", "Tragedy", "Comedy"] JSON array of item names to sell when using the sell list command.

Additional info for the dontSellListJson config setting.

  • Use the edit config command to easily edit the dontSellListJson config setting from the terminal.
  • Use the view scrap or view all scrap command to see the correct item names to use.
  • Item names are not case-sensitive but, spaces do matter.
  • Example value: ["Maxwell", "Cookie Fumo", "Octolar Plush", "Smol Takey"]

Additional info for the sellListJson config setting.

  • Use the edit config command to easily edit the sellListJson config setting from the terminal.
  • Use the view scrap or view all scrap command to see the correct item names to use.
  • Item names are not case-sensitive but, spaces do matter.
Terminal Settings Setting type Default value Description
OverrideWelcomeMessage Boolean true Overrides the terminal welcome message to add additional info.
OverrideHelpMessage Boolean true Overrides the terminal help message to add additional info.
ShowFoundItems Boolean true Show found items on the confirmation screen.
SortFoundItemsPrice Boolean true Sorts found items from most to least expensive.
AlignFoundItemsPrice Boolean true Aligns all prices of found items.
Misc Settings Setting type Default value Description
SpeakInShip Boolean true The Company will speak inside your ship after selling from the terminal.
RareVoiceLineChance Single 5 The percent chance the Company will say a rare microphone voice line after selling.
Scrap Eater Settings Setting type Default value Description
ScrapEaterChance Int32 75 The percent chance a scrap eater will spawn?!
OctolarSpawnWeight Int32 1 The spawn chance weight Octolar will spawn?! (scrap eater)
TakeySpawnWeight Int32 1 The spawn chance weight Takey will spawn?! (scrap eater)
MaxwellSpawnWeight Int32 1 The spawn chance weight Maxwell will spawn?! (scrap eater)
YippeeSpawnWeight Int32 1 The spawn chance weight Yippee will spawn?! (scrap eater)
CookieFumoSpawnWeight Int32 1 The spawn chance weight Cookie Fumo will spawn?! (scrap eater)
PsychoSpawnWeight Int32 1 The spawn chance weight Psycho will spawn?! (scrap eater)
ZombiesSpawnWeight Int32 1 The spawn chance weight Zombies will spawn?! (scrap eater)

Want more Scrap Eaters?

Developer Contact

Report bugs or give suggestions here:

https://github.com/ZehsTeam/Lethal-Company-SellMyScrap/issues

Discord server Forum Post
Lethal Company modding Discord #mod-releases SellMyScrap
Unofficial Lethal Company Community #mod-releases SellMyScrap

Twitch: CritHaxXoG - YouTube: Zehs

Credits

Maxwell (scrap eater) and Cookie Fumo (scrap eater)

Zombies (scrap eater)

  • Model by MissSuperE.

Takey (scrap eater)

Screenshots

Expand

sell <amount>

sell quota

sell all

sell item <name>

view overtime

view scrap

view all scrap

view config

edit config

lethal-company-sellmyscrap's People

Contributors

zehsteam avatar

Stargazers

avatar avatar

Watchers

avatar

lethal-company-sellmyscrap's Issues

[Request] Config option to disable "edit config" terminal command

I'm generally concerned about client desyncs, and this seems like a potential issue in lobbies. Moreover, it's not something I would expect our group to use during a game.

Is it possible to get a config option to disable this command?

Thanks for the consideration

[Bug] Overtime bonus calculation

Hey there,

Encountered a bug with the displayed value of the Overtime Bonus while playing tonight and figured I'd report it. No issues thrown in the log, or anything wonky going on as far as I could tell.

image

Cheers

Cannot Confirm Sell Command with version 1.3

I updated the mod through r2modman to version 1.3 and suddenly I cannot confirm selling anymore. I even created a profile with only this mod and its dependencies, and the same behavior happens.

image
image

Even if I try just "c" or in all caps, etc., you are unable to confirm selling anymore.

v1.4.1 broke GeneralImprovements's quota rollover

v1.4.1 introduced a change that broke the quota rollover option of GeneralImprovements.

If the quota is reached, SellMyScrap will force it to be finished which resets the profit.

[Debug  :GeneralImprovements] Updated time display.
[Info   :GeneralImprovements] Updated days since death display.
[Info   :GeneralImprovements] Updated profit quota and deadline monitors
[Info   :com.github.zehsteam.SellMyScrap] 

GetOvertimeBonus();
daysUntilDeadline: 5
overtimeBonus: 110

[Info   :com.github.zehsteam.SellMyScrap] 

SyncNewProfitQuotaClientRpc();
daysUntilDeadline: 5
overtimeBonus: 110

[Info   :com.github.zehsteam.SellMyScrap] 

SyncNewProfitQuotaClientRpc();
daysUntilDeadline: 5
overtimeBonus: 110

[Debug  :me.loaforc.soundapi] Audios:UIAudio:ReachedQuotaSFX == *:UIAudio:ReachedQuotaSFX?
[Info   :GeneralImprovements] Applying surplus quota to fulfilled: $0
[Info   :GeneralImprovements] Applying surplus quota to fulfilled: $0

[Request] config option to ignore scrap worth 0

There's at least one way to get scrap worth 0 (LethalCasino), and by default SellMyScrap will add them to every sale. If possible, it would be great to get a config option to prevent selling 0 credit scrap (leaving the players to sell it manually or leave it behind if they don't want it)

Thanks for the consideration

Conflict with Quota Rollover

I'm not sure what specifically is the issue is on the coding side but it's a replicable issue with both mods (Quota Rollover by boxofbiscuits97 and this one) enabled. The issue is that, regardless of how many days are left, as long as the rollover quantity is greater than the quota, it would proceeded to the next quota.

Quota Rollover boxofbiscuits97

[Request] alias for "View Scrap"

hi there, would it be possible to get "View All" as an alias for "View Scrap"? "View" alone as an alias for "View Scrap" would also be welcome if that doesn't present problems.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.