SellMyScrap
Adds a few terminal commands to sell your scrap from the ship. Compatible with the ShipInventory mod. Highly Configurable. SellFromTerminal +
This mod will sell scrap as close to the requested value as possible.
This mod is compatible with the ShipInventory mod.
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 ` | Will sell scrap for a total of the requested amount. | `-se`, `-se:`, `-o` |
| `sell quota` | Will sell scrap to reach the profit quota. | `-se`, `-se:` |
| `sell all` | Will sell all of your scrap. | `-se`, `-se:` |
| `sell item ` | Will sell scrap by their item name. | `-se`, `-se:` |
| `sell list` | Will sell all the scrap from the `sellList` config setting. | `-se`, `-se:` |
* Using the `-se` flag will spawn a random scrap eater.
* Usage: ` -se`
* Using the `-se:` 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: ` -se:`
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 -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 `sellList` config setting.
* This command will bypass the `dontSellList` 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.
| General Settings | Setting type | Default value | Description |
| ----------- | ----------- | ----------- | ----------- |
| `ExtendedLogging` | `Boolean` | `false` | Enable extended logging. |
| 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? |
| `DontSellList` | `String` | ` ` | Array of item names to not sell. |
| `SellList` | `String` | `Whoopie cushion, Easter egg, Tragedy, Comedy` | Array of item names to sell when using the `sell list` command. |
Additional info for the dontSellList
config setting.
* Use the `edit config` command to easily edit the `dontSellList` config setting from the terminal.
* Use the `view scrap` or `view all scrap` command to see the correct item names to use.
* Each entry should be separated by a comma.
* Item names are not case-sensitive but, spaces do matter.
* Example value: `Maxwell, Cookie Fumo, Octolar Plush, Smol Takey, Blahaj`
Additional info for the sellList
config setting.
* Use the `edit config` command to easily edit the `sellList` config setting from the terminal.
* Use the `view scrap` or `view all scrap` command to see the correct item names to use.
* Each entry should be separated by a comma.
* Item names are not case-sensitive but, spaces do matter.
* Example value: `Whoopie cushion, Easter egg, Tragedy, Comedy`
| 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. |
| `ShowQuotaWarning` | `Boolean` | `true` | If enabled, will show a warning when you try to pull the ship's lever when the quota hasn't been fulfilled at the Company building with 0 days left. |
| 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](https://www.twitch.tv/thorlar) will spawn?! (scrap eater) |
| `TakeySpawnWeight` | `Int32` | `1` | The spawn chance weight [Takey](https://www.twitch.tv/takerst) 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](https://www.twitch.tv/psychohypnotic) will spawn?! (scrap eater) |
| `ZombiesSpawnWeight` | `Int32` | `1` | The spawn chance weight [Zombies](https://www.twitch.tv/zombiesatemychannel) will spawn?! (scrap eater) |
ShipInventory Compatibility
This mod is compatible with the ShipInventory mod.
If you use the command flag -inv
when writing sell commands, you can make the command only target the ShipInventory storage.
Want more Scrap Eaters?
Developer Contact
Report bugs or give suggestions here:
https://github.com/ZehsTeam/Lethal-Company-SellMyScrap/issues
Credits
Takey (scrap eater)
Maxwell (scrap eater) and Cookie Fumo (scrap eater)
Zombies (scrap eater)
Screenshots
Expand
sell <amount>
sell quota
sell all
sell item <name>
view overtime
view scrap
view all scrap
view config
edit config