Easily count a configurable list of prefabs/items in a world, like walrus camps, amount of reeds, etc., to quickly check if a generated world is worth playing.
Just run PC:Count() in the remote console to show a fresh count of the items in the current shard.
The Prefab Counter mod is purely server-side, intended to be used by a server admin to get a quick overview over the generated Overworld and Caves to see at a glance if worlds have been generated with enough resources for the intended playstyle. Typically, one could be interested in the number of walrus camps, reeds, marble sources, or planted mandrakes, and if the world spawned with too little of a resource, a new chance is just a simple world regeneration away. Go ahead, whisk away the lives of every single soul inhabiting the constant, without a second thought.
To count the configured items/prefabs in the shard you're currently in, simply run PC:Count() in the Remote Console as an admin, and the results will be printed to the chat and server log as a system message. After the results fade out, you can open the chat again (default key: Y) to see the text for as long as you need to ponder bringing armageddon upon the world. You monster.
Certain items only ever spawn in the Caves, so if you're interested in those, you'll have to enter the Caves first and run the same command there to count again in that shard. The same applies to any other shards you may have set up in a multi-shard cluster.
The mod can count the following items, prefab names given for reference:
- Ancient Statues ("ruins_statue_head", "ruins_statue_mage")
- Ancient Statues, No Gems ("ruins_statue_head_nogem", "ruins_statue_mage_nogem")
- Anememies ("trap_starfish")
- Beefalos ("beefalo")
- Beehives ("beehive")
- Berry Bushes ("berrybush", "berrybush2")
- Broken Clockworks ("chessjunk1", "chessjunk2", "chessjunk3")
- Clockworks ("knight", "bishop", "rook", "knight_nightmare", "bishop_nightmare", "rook_nightmare")
- Juicy Berry Bushes ("berrybush_juicy")
- Killer Beehives ("wasphive")
- Lureplants ("lureplant")
- Mandrakes ("mandrake_planted")
- Marble Pillars ("marblepillar")
- Marble Statues ("statue_marble", "statue_marble_muse", "statue_marble_pawn")
- Marble Trees ("marbletree")
- Maxwell Statues ("statuemaxwell")
- Merm Houses ("mermhouse")
- Monkey Huts/Pods ("monkeyhut"/"monkeybarrel")
- Pig Houses ("pighouse")
- Rabbit Hutches ("rabbithouse")
- Reeds ("reeds", "reeds_water")
- Saplings ("sapling")
- Spider Den 1/2/3/Queen/Eggs ("spiderden"/"spiderden_2"/"spiderden_3"/"spiderqueen"/"spidereggsack")
- Stone Fruit Bushes ("rock_avocado_bush")
- Volt Goats ("lightninggoat")
- Walrus Camps ("walrus_camp")
- Wormholes ("wormhole")
Counting any of these items can be disabled in the configuration as required, all items are counted by default. You may also choose to not show any item with a zero count to reduce the amount of text to read. By default, however, all results will be shown.
The log level can safely be left alone on the default Info, but if you want detailed tracing or debug information printed in the server's logfile, feel free to lower the severity to Debug or even Trace, for example to verify your configuration settings being set correctly on a dedicated server.
Please follow generic installation instructions on how to install a mod on your dedicated or client-hosted server, this mod works exactly the same as any other mod in that regard.
Add this snippet to the file <dedicated_server_install>/mods/dedicated_server_mods_setup.lua to automatically let the server download the mod from the Steam Workshop on boot. This does not activate the mod, yet.
-- Prefab Counter by Gyroplast
-- https://steamcommunity.com/sharedfiles/filedetails/?id=2618765953
ServerModSetup("2618765953")Add configuration options and enable the mod in the server's modoverrides.lua file. Please note that this file is server specific! As Overworld and Caves are technically two independent servers, you will generally want to modify this file in at least two locations, most of the time identically, unless you want differing configuration for any mod from Caves to Overworld.
Below is a commented, comprehensive default configuration for this mod that can be copied into the file directly to configure the Steam Workshop installation of the mod.
-- Prefab Counter by Gyroplast
-- https://steamcommunity.com/sharedfiles/filedetails/?id=2618765953
["workshop-2618765953"]={
configuration_options={
log_level="INFO", -- server log level: TRACE, DEBUG, INFO, WARN, ERROR
show_zero_counts=true, -- when reporting item counts, also show items of which none are found
-- enable or disable counting of individual prefabs
count_beefalo=true, -- Beefalos ("beefalo")
count_beehive=true, -- Beehives ("beehive")
count_berrybush_juicy=true, -- Juicy Berry Bushes ("berrybush_juicy")
count_berrybushes=true, -- Berry Bushes ("berrybush", "berrybush2")
count_chessjunk=true, -- Broken Clockworks ("chessjunk1", "chessjunk2", "chessjunk3")
count_clockworks=true, -- Clockworks ("knight", "bishop", "rook", "knight_nightmare", "bishop_nightmare", "rook_nightmare")
count_lightninggoat=true, -- Volt Goats ("lightninggoat")
count_lureplant=true, -- Lureplant ("lureplant")
count_mandrake_planted=true, -- Mandrakes ("mandrake_planted")
count_marble_statues=true, -- Marble Statues ("statue_marble", "statue_marble_muse", "statue_marble_pawn")
count_marblepillar=true, -- Marble Pillars ("marblepillar")
count_marbletree=true, -- Marble Trees ("marbletree")
count_mermhouse=true, -- Merm Houses ("mermhouse")
multicount_monkeyhuts=true, -- Monkey Huts/Pods ("monkeyhut"/"monkeybarrel")
count_pighouse=true, -- Pig Houses ("pighouse")
count_rabbithouse=true, -- Rabbit Hutches ("rabbithouse")
count_reeds=true, -- Reeds ("reeds", "reeds_water")
count_rock_avocado_bush=true, -- Stone Fruit Bushes ("rock_avocado_bush")
count_ruins_statue=true, -- Ancient Statues with Gems ("ruins_statue_head", "ruins_statue_mage")
count_ruins_statue_nogem=true, -- Ancient Statues without Gems ("ruins_statue_head_nogem", "ruins_statue_mage_nogem")
count_sapling=true, -- Saplings ("sapling")
multicount_spiders=true, -- Spider Den 1/2/3/Queen/Eggs ("spiderden"/"spiderden_2"/"spiderden_3"/"spiderqueen"/"spidereggsack")
count_statuemaxwell=true, -- Maxwell Statues ("statuemaxwell")
count_trap_starfish=true, -- Anememies ("trap_starfish")
count_walrus_camp=true, -- Walrus Camps ("walrus_camp")
count_wasphive=true, -- Killer Beehives ("wasphive")
count_wormhole=true, -- Wormholes ("wormhole")
},
enabled=true
},If you prefer to install the mod without using the Steam Workshop, download the release you want as an archive, and extract it into the mods directory in the dedicated server installation directory, where the dedicated_server_mods_setup.lua file resides. After extraction, you should have a new directory for the mod in the mods directory, named Prefab_Counter-<version>, similar to this:
.../
Don't Starve Together Dedicated Server/
mods/
Prefab_Counter-1.0.4/
lib/
LICENSE
modicon.tex
modicon.xml
modinfo.lua
modmain.lua
README.md
INSTALLING_MODS.txt
MAKING_MODS.txt
dedicated_server_mods_setup.lua
modsettings.lua
Take note of the exact name of the mod directory, Prefab_Counter-1.0.4 in this example. The mod configuration must refer to this exact, case-sensitive directory name. The actual directory name is not important, but it must be consistent with the modoverrides.lua entry for the mod, otherwise the server will not be able to associate the configuration with the mod, and the mod will stay disabled entirely.
To achieve the required consistency, you may now either just rename the mod directory to workshop-2618765953, and edit the modoverrides.lua files exactly as described in the Steam Workshop Installation above,
OR
replace the workshop-2618765953 reference in the modoverrides.lua file with the exact, case-sensitive name of the mod, i. e. Prefab_Counter-1.0.4 in this case, like this:
-- Prefab Counter by Gyroplast
-- https://steamcommunity.com/sharedfiles/filedetails/?id=2618765953
["Prefab_Counter-1.0.4"]={
configuration_options={
[""]="",
...Do not edit the dedicated_server_mods_setup.lua file to include the ServerModSetup("2618765953") line.
The ServerModSetup's only job is to download the mod files from the Steam Workshop, which is unnecessary after downloading, extracting, and placing the mod files manually.
In fact, if you renamed the directory to workshop-2618765953, leaving the ServerModSetup line active would overwrite the manually installed mod with the Steam Workshop version on server start, so ensure there is no ServerModSetup("2618765953") line in the dedicated_server_mods_setup.lua file, or leave the mod directory name as-is.
This is a list of changes and features that are planned to be implemented, in no particular order.
- port to single-player Dont' Starve and DLCs
- check if and how set pieces and biomes can be counted
Please see the enclosed license file, applicable to the sources unless noted otherwise. Mod sources are hosted on GitHub.
New Features
-
add ancient statues and monkey huts counter. Closes #7.
Ancient Statues are counted separately for their variant with and without gem, to determine thulecite and gem availability in the ruins. Monkey Huts and Splumonkey Pods now are both counted as well.
New Features
- add lureplant counter Closes #4.
- add counter for spider dens, queen, and eggsacks Closes #5.
- add support for multi-count prefabs
- add
PrefabCounter:CountPrefab(prefab)to support spiderden tiers
Bugfixes
- server crash when run with Chat Announcements 1.2.0 Fixes #1.
- count correct prefab for saplings
Fixes #2.
- Initial Public Release, added Steam ID
- Initial Hidden Release