Change all instances of "volume" in JSONs to be a metric string

[ampersand55]

Summary

SUMMARY: Infrastructure "Change all instances of 'volume' in JSONs to be a metric string"

Purpose of change

Metric units in string format ("L" or "ml") is preferred to units of 250ml.

See this exchange #33347 (comment) I had with @anothersimulacrum.

Describe the solution

Made a simple Node.js script that walks the data\json directory and replaces all instances of volume, max_volume and min_volume using integers with a metric string using a regexp. See:

https://github.com/ampersand55/CddaTools/blob/master/cddaUpdateJsonVolume.js

It's not pretty, but it works for now. Some problems:

• Identifies and skips sound volume of a musical_instrument purely based on formatting which is not a robust way of doing it.
• Does only change volume that's on a separate row, not inline-volume, e.g. { "volume": 2, "othervalue": "something"}. This is because that's used for proportional volume changes.

Describe alternatives you've considered

Making a proper JSON parser that converts it to a js object so you can check the depth and name of parent keys.

Additional context

[ymber]

This is almost exactly what I wrote adjust_values.py for. It parses json so you might want to adapt it for whatever json change automation you want.

[ampersand55]

This is almost exactly what I wrote adjust_values.py for. It parses json so you might want to adapt it for whatever json change automation you want.

That was mentioned, but I couldn't get it to work. Now I know it was because I was on python 3.6 which didn't support f-strings. I still have problems with the linter though.

[ymber]

Python 3.6 was the version that introduced fstrings. That script should work with 3.6. If you're on windows your problem with the part where it lints stuff is probably that the formatter executable name is different on windows and I don't know if what I used there is a valid command for the windows shell.

[ampersand55]

Updating to 3.7 fixed the error anyway.

I have some trouble with the linting in adjust_values.py, it seems to be referencing ../format/json_formatter.cgi which does not exist.

[anothersimulacrum]

I've reviewed the first 100 files, up to data/json/items/book/unarmed.json. I've noticed no discrepancies, but a large number of items with zero volume, which I initially suggested fixes for, but have decided is out of the scope of this PR, minus the few I found a good answer for.

[ampersand55]

Should I just skip updating the lines with "volume": 0 and leave them as is?

[anothersimulacrum]

Yeah, there's a lot, and doing so would hold this up.
This will make it much easier to find them and fix them in the future.

[ampersand55]

Someone should update doc/JSON_INFO.md with the use of integer units of 250ml being deprecated.

[ampersand55]

I tested that metric units could be used with integral_volume using a gyroscopic stabilizer installed on an mp5.

[ZhilkinSerg]

storage should also probably be updated.

[int-ua]

I've just updated to the latest build and furniture that had > 1000L storage now has only 1000L. Display rack, bookshelf, dresser. Can you confirm?

[ZhilkinSerg]

I can see that locker going up from 500 to 1000:

[ampersand55]

I've just updated to the latest build and furniture that had > 1000L storage now has only 1000L. Display rack, bookshelf, dresser. Can you confirm?

Can confirm. Every furniture max_storage seem to be 1000 L, even mail boxes.

They have correct string metric units (e.g. f_bookcase went from max_volume: 8000 to max_volume: "2000 L"), but the game might not be able to handle max_volume in string metric units for furniture.

Here is a revert branch:

• https://github.com/ampersand55/Cataclysm-DDA/tree/revert_furniture_max_storage

But I think making furniture able to handle metric units for max_volume would be a better solution.

[ampersand55]

Btw, I have a working proper robust json parser now that can change change keys based on type, category, depth, parent nodes, file name etc. But it outputs raw json and I can't get the json linter working. I can make it use the web linter, but that's not practical when changing hundreds of files in bulk.