A cool little tool to help track Lethal Company HQ runs
Project description
sheet-company
it's the sheet
BUT IT'S NOT. This is a Lethal Company run tracking program for discerning spreadsheet haters.
Installation
pip install --user sheet-company # or omit the --user if you hate yourself.
sheet --install-completion # For tab completion
sheet --help
Better installation methods will come later maybe, or maybe not. If you don't know how to pip, this probably isn't for you.
Usage
❯ sheet --help
Usage: sheet [OPTIONS] COMMAND [ARGS]...
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ set-current-run Lets you pick a previous run to be your current run │
│ start-run Starts a new run │
│ update-run Updates the currently selected run │
│ add-day Adds a new day │
│ update-day Updates the current day │
│ add-quota Adds a new quota │
│ update-quota Updates the current quota │
│ quota-roll Shows how good a quota roll was │
│ quota-roll-revq Shows the percentage of the last sold │
│ average Shows the average collected value │
│ show-current-run Shows the currently selected run │
│ average-efficiency Shows the average collection efficiency │
│ on-ship Shows how much loot is currently on ship │
│ pace Shows the pace the run is projected to be on │
│ total-collected Shows how much loot has been collected in total │
│ needed-average Shows the average needed to meet the target quota │
│ target-quota Shows the desired target quota │
│ sell-amount Show the amount we need to sell, accounting for early sells │
│ calculate-overtime Shows how much loot has been collected in total │
│ chance Shows the chance of reaching a given quota amount │
│ store Shows a store interface for quickly calculating sell │
│ overlay Prints a stream overlay to stdout │
│ watch Run stats tracker watcher │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Typical usage
Start a run:
sheet start-run --run-title 'this is a really cool run we are gonna comp this shit' --players GregBadabinski --players NotARobot --version v81
Add each day:
sheet add-day --moon Assurance --weather stormy --layout mansion --item-count 14 --bee-count 2 --top-line 214 --bottom-line 550 --indoor-fog --meteor-shower --fire-close-to-main --infestation nutcracker
sheet add-day --moon Assurance --weather clear --layout facility --item-count 15 --bee-count 4 --top-line 914 --bottom-line 396
sheet add-day --moon Assurance --weather flooded --layout facility --item-count 15 --bee-count 2 --top-line 790 --bottom-line 600
Use the store interface to plan your buys:
sheet store
If you didn't confirm your sell amount using C in the store, update your quota with what you sold:
sheet update-quota --sold 1614
Add your next quota:
sheet add-quota --amount 214
Switch your run when your squad goes AFK for an hour and you rage quit to solos:
sheet set-current-run
When you inevitably wipe your solo run, mark it as wiped:
sheet update-run --wiped
A note on the store interface
Look at the bottom of the screen. Look at it. There are your settings. It's case sensitive. To enter a checklist view, press D. To exit that view, press d. To increase a sale of an item, press S. s will reduce the sale. If you want to just quit without saving anything, press ctrl+q.
I know it's terse and bad and annoying to use. I like command line interfaces. I suck at designing TUIs. Be glad I didn't try to make a GUI.
Maku is really cool and so is LCStatsTracker
If you're using the excellent LCStatsTracker mod, you can avoid manually updating any of the shit I mentioned above. Just do this once Lethal Company is up and running:
sheet watch
You'll see the weather, moon, and the true top and bottom lines. A whole shitload of other information is also tracked, but I haven't gotten around to making use of it yet.
Extra settings
You can configure some additional settings in "$XDG_CONFIG_HOME"/sheet-company/settings.yaml. Here's where that'd be by default on the relevant operating systems:
- Linux:
"$HOME"/.config/sheet-company/settings.yaml - MacOS:
"$HOME"/.config/sheet-company/settings.yaml - Windows: Why are you on Windows? I have no idea where this would end up. Probably in the same place, but under
C:\Users\WhoeverYouAre
Here's what you can set:
default_version: v81
default_target_quota: 24
default_quota_chance_amount: 30000
should_write_overlay: true
overlay_output_path: /home/greg/.cache/sheet-company/overlay
push_to_influxdb: false
influx_db_url: "http://localhost:8086"
influx_db_bucket: sheet-company
And speaking of the overlay...
The overlay
It looks like this:
Q1/Q2+ avg: 119/nan
On ship: 224
Needed avg for Q20: 0
Q2 roll percentage: 53%
Clear efficiency: 18.86%
Pace: Q1/130
17K chance: nan%
Add it as a text source in OBS. Congratulations, you have run information that doesn't require obnoxious chroma keying.
Made by a human for humans. Do Not The Clanker™
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sheet_company-1.1.0.tar.gz.
File metadata
- Download URL: sheet_company-1.1.0.tar.gz
- Upload date:
- Size: 65.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
87ef93be72789a187306590ad12dd79fc722db3a39fe48d2c043b85137879416
|
|
| MD5 |
8d9ba57eb35b152b6a6e78c42cd221f4
|
|
| BLAKE2b-256 |
449b099944010e4050180076acbdfdbde45d93bb56e2bd957c8ca9a932abe9bf
|
File details
Details for the file sheet_company-1.1.0-py3-none-any.whl.
File metadata
- Download URL: sheet_company-1.1.0-py3-none-any.whl
- Upload date:
- Size: 132.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d4b867e89b7efb66d9631d0b3a9775af4487f9c65de7d353f3fcbbe163c070be
|
|
| MD5 |
aaf4ed3a193de4c32fdf5f9d47bc7e6d
|
|
| BLAKE2b-256 |
006ecec402fbcd8ea45f73975b81fdc9f28a676d15deefd601bb838e311a1962
|
