Bitencola Museum Tracker

A tracker for the Museum% speedrun category of Lethal Company: collect every scrap item in the game, counting each look variant, and bring them all to the ship. The mod shows on screen which entries are already in the ship and which are still missing, tells you when the scrap in your hands is new, and writes text files for OBS. It follows the category rules, so the number it shows is the number that counts.

The mod's texts come in English or Portuguese, following your computer's language, unless you choose one in the "Language" option. Em português: veja mais abaixo.

It is client-side: it sends and receives nothing over the network, changes nothing in the game (no spawns, values, saves, physics or item looks), and works alone, even in a lobby where nobody else has the mod. Each player who has it sees their own board. For a run, the host should have it, because the host's recording is the one that counts.

What counts

Every scrap item in the game counts, and every look variant of an item (model or texture) counts as its own entry. For example, the 5 mugs are 5 entries and the 5 Easter eggs are 5 entries. Player bodies never count. Items that are not scrap, like keys and ammo, don't count either.

The list comes from the game itself when the match loads, so it follows each game version. It has 80 entries in v73 and in the current version, the same as the community spreadsheet. The BepInEx log prints the total when the match loads, so you can check it.

When an item counts

An item counts when it is inside the ship and not in anyone's hands. It counts when you drop it inside the ship, not while you carry it in. The official "collected!" pop-up of the game appears at the same moment. An item leaves the count when someone picks it up, takes it out of the ship, sells it at the Company, or loses it (for example, when the whole crew dies). The board always shows what is in the ship right now.

The board

The board is on the left side of the screen, so it never covers the bottom right corner, where the "collected!" pop-up appears. The header shows your progress, like "Museum 37/80".

Missing mode (the default) lists only what is still missing, in alphabetical order. An item with variants shows how many are already in the ship, like "Mug 2/5". All mode lists every entry and marks the ones in the ship with [x]. Long lists are split in pages, shown as "Page 1/3".

Keys (you can change them or turn them off in the config):

• M shows and hides the board.
• N turns the page.

They do nothing while you type in the chat, use the terminal or have a menu open. The board is hidden in the terminal and in the pause menu, and stays visible when you are dead, so you can keep watching.

Held item hint: when you hold a scrap item whose look is still missing, the top of the board says "In your hands: Mug 3 (new!)".

Completion banner: when the museum becomes complete, "MUSEUM COMPLETE" appears in the middle of the screen for a few seconds, and the BepInEx log writes the game day and the time.

OBS files

The mod writes three text files in the folder BepInEx/MuseumTracker of your profile. They are only rewritten when something changes, and safely, so OBS never reads half a file.

• museum-count.txt has the progress, like 37/80.
• museum-missing.txt has what is missing, one line per item, in the same format as the board.
• museum-all.txt has every entry, marked with [x] or [ ].

To show one in OBS: add a source of type "Text (GDI+)" (on Linux, "Text (FreeType 2)"), tick "Read from file" and choose the file. You can turn the files off in the config.

The game does not save look variants

The game does not save which look each item has. After you load a save, every mug in the ship shows the same default look, and the board counts what the game shows. So play a Museum% run in one single session, without quitting and loading again. A player who joins in the middle of a session sees the default look on the items that already existed, and may also see a lower count, because the game does not mark the older ship items as in the ship on their machine. The host's board is the one that counts for a run.

Config

The file is BepInEx/config/Bitencola.MuseumTracker.cfg.

Section	Option	Default	What it does
0. General	Language	Auto	Language of the texts (Auto follows the computer)
1. Museum	Count variants	true	Each look variant is its own entry (the Museum% rule). Off, each item counts once
1. Museum	Include modded items	false	Includes scrap added by other mods
1. Museum	Excluded items	empty	Names of items that don't count, separated by commas
2. Board	Show board	true	Shows the board when you enter the game
2. Board	Board mode	Missing	Missing or All
2. Board	Toggle key	M	Shows and hides the board (None turns it off)
2. Board	Page key	N	Turns the page (None turns it off)
2. Board	Board scale (%)	100	Size of the board, from 50 to 200
2. Board	Held item hint	true	Tells you when the scrap in your hands is new
2. Board	Completion banner	true	Shows "museum complete" in the middle of the screen
3. Files	Write OBS files	true	Writes the text files for OBS

When changes apply: "Count variants", "Include modded items" and "Excluded items" apply from the next match (or when the game's item list changes), and so does "Show board". "Language" applies the next time the game starts. The other options apply right away; after you turn "Write OBS files" on, the files are written at the next change.

Modded items: scrap from other mods only counts when "Include modded items" is on. Some of it may be impossible to find, so use "Excluded items" with the names to leave out. For example, for a run without the Zed Dog, write Zed Dog in "Excluded items". Names are the ones the game shows, and the comparison ignores upper and lower case.

Compatibility

It needs only BepInEx. Bitencola Hot Fixes works with it. Its monster remains boxes are modded items, so they only count with "Include modded items" on. Hot Fixes lets the belt bag hold scrap: scrap kept inside a belt bag in the ship starts counting after the day ends, when the game marks the bag contents as in the ship.

Português

Um contador para a categoria de speedrun Museum% de Lethal Company: pegar toda a sucata do jogo, contando cada variação de aparência, e levar tudo para a nave. O mod mostra na tela quais entradas já estão na nave e quais faltam, avisa quando a sucata na sua mão é nova e grava arquivos de texto para o OBS. Ele segue as regras da categoria, então o número que aparece é o número que vale.

Os textos do mod vêm em inglês ou português, seguindo o idioma do seu computador, a não ser que você escolha um na opção "Language".

Funciona só do lado do jogador: não manda nem recebe nada pela rede, não muda nada no jogo (nem sucata que nasce, valores, saves, física ou aparência dos itens) e funciona sozinho, mesmo numa sala em que ninguém mais tem o mod. Cada jogador que o tem vê o próprio quadro. Para uma partida valendo, quem hospeda deve ter o mod, porque a gravação do anfitrião é a que vale.

O que conta

Toda sucata do jogo conta, e cada variação de aparência de um item (modelo ou textura) conta como uma entrada. Por exemplo, as 5 canecas são 5 entradas e os 5 ovos de Páscoa são 5 entradas. Corpos de jogador nunca contam. Itens que não são sucata, como chaves e munição, também não.

A lista vem do próprio jogo quando a partida carrega, então acompanha cada versão. São 80 entradas na v73 e na versão atual, igual à planilha da comunidade. O log do BepInEx escreve o total quando a partida carrega, para você conferir.

Quando um item conta

Um item conta quando está dentro da nave e não está na mão de ninguém. Ele conta quando você o larga dentro da nave, não enquanto o carrega para dentro. O aviso oficial "collected!" do jogo aparece no mesmo momento. O item sai da conta quando alguém o pega, o leva para fora da nave, o vende na Companhia ou o perde (por exemplo, quando toda a tripulação morre). O quadro sempre mostra o que está na nave agora.

O quadro

O quadro fica no lado esquerdo da tela, então nunca cobre o canto inferior direito, onde aparece o aviso "collected!". O cabeçalho mostra o seu progresso, como "Museu 37/80".

O modo Missing (o padrão) lista só o que ainda falta, em ordem alfabética. Um item com variações mostra quantas já estão na nave, como "Mug 2/5". O modo All lista todas as entradas e marca com [x] as que estão na nave. Listas grandes são divididas em páginas, mostradas como "Página 1/3".

Teclas (dá para trocar ou desligar na config):

• M mostra e esconde o quadro.
• N passa a página.

Elas não fazem nada enquanto você digita no chat, usa o terminal ou está com um menu aberto. O quadro some no terminal e no menu de pausa, e continua visível quando você está morto, para você seguir assistindo.

Aviso do item na mão: quando você segura uma sucata cuja aparência ainda falta, o topo do quadro diz "Na sua mão: Mug 3 (nova!)".

Aviso de museu completo: quando o museu fica completo, aparece "MUSEU COMPLETO" no meio da tela por alguns segundos, e o log do BepInEx escreve o dia do jogo e a hora.

Arquivos para o OBS

O mod grava três arquivos de texto na pasta BepInEx/MuseumTracker do seu perfil. Eles só são regravados quando algo muda, e de forma segura, então o OBS nunca lê um arquivo pela metade.

• museum-count.txt tem o progresso, como 37/80.
• museum-missing.txt tem o que falta, uma linha por item, no mesmo formato do quadro.
• museum-all.txt tem todas as entradas, marcadas com [x] ou [ ].

Para mostrar um no OBS: adicione uma fonte do tipo "Texto (GDI+)" (no Linux, "Texto (FreeType 2)"), marque "Ler de arquivo" e escolha o arquivo. Dá para desligar os arquivos na config.

O jogo não salva as variações de aparência

O jogo não salva qual aparência cada item tem. Depois de carregar um save, todas as canecas da nave mostram a mesma aparência padrão, e o quadro conta o que o jogo mostra. Por isso, jogue uma partida de Museum% numa sessão só, sem sair e carregar de novo. Quem entra no meio da sessão vê a aparência padrão nos itens que já existiam, e também pode ver uma contagem menor, porque o jogo não marca os itens mais antigos da nave como estando na nave no computador dele. O quadro de quem hospeda é o que vale numa partida.

Config

O arquivo é BepInEx/config/Bitencola.MuseumTracker.cfg. As opções são as da tabela acima, com os nomes em inglês e as descrições no idioma escolhido.

Quando as mudanças valem: "Count variants", "Include modded items" e "Excluded items" valem a partir da próxima partida (ou quando a lista de itens do jogo muda), e "Show board" também. "Language" vale ao abrir o jogo de novo. As outras opções valem na hora; depois de ligar "Write OBS files", os arquivos são gravados na próxima mudança.

Itens de mods: a sucata de outros mods só conta com "Include modded items" ligada. Parte dela pode ser impossível de achar, então use "Excluded items" com os nomes que ficam de fora. Por exemplo, para uma partida sem o Zed Dog, escreva Zed Dog em "Excluded items". Os nomes são os que o jogo mostra, e a comparação ignora maiúsculas e minúsculas.

Compatibilidade

Precisa só do BepInEx. O Bitencola Hot Fixes funciona junto. As caixas de restos de monstro dele são itens de mod, então só contam com "Include modded items" ligada. O Hot Fixes deixa a pochete guardar sucata: a sucata guardada numa pochete dentro da nave passa a contar depois que o dia acaba, quando o jogo marca o conteúdo da pochete como estando na nave.