Talk:Cargo Request Computer: Difference between revisions
Adding "documentation" - github links to the relevant pages and short explanations (perhaps unnecessary, but seems useful to me); Still unfinished, just saving partway; |
More editing & documentation; still not done; |
||
Line 7: | Line 7: | ||
15/05 - right now, the minimum 'viable product' is to a have a table with all the in game orders, and a very basic description of the computer and its use. Once that's up, the page should be moved to be visible on search engines, and instances of it elsewhere in the wiki should link back here. | 15/05 - right now, the minimum 'viable product' is to a have a table with all the in game orders, and a very basic description of the computer and its use. Once that's up, the page should be moved to be visible on search engines, and instances of it elsewhere in the wiki should link back here. | ||
'''Relevant GitHub pages:''' | == '''Relevant GitHub pages:''' == | ||
(take my rough documentation here with a grain of salt, this is what I can tell from the documents + my in-game experience. I am no experience with actually working on the game's code) | (take my rough documentation here with a grain of salt, this is what I can tell from the documents + my in-game experience. I am no experience with actually working on the game's code) | ||
=== orders === | |||
[https://github.com/space-wizards/space-station-14/tree/master/Resources/Prototypes/Catalog/Cargo space-station-14/Resources/Prototypes/Catalog /Cargo/] | [https://github.com/space-wizards/space-station-14/tree/master/Resources/Prototypes/Catalog/Cargo space-station-14/Resources/Prototypes/Catalog /Cargo/] | ||
Contains all orders. Everything that is "type: cargoProduct" is an order that shows up on the computer | Contains all orders. Everything that is "type: cargoProduct" is an order that shows up on the computer. | ||
''' | * '''id''' - id of the order (but not ''what is ordered'') | ||
* '''product''' - the id of what is being ordered (the id of the crate/thing that will be teleported) | |||
* '''cost''' - price of the order | |||
* '''category''' - under what filter does the order appear (that is determined by ''this'' field, not by the .yml the block is saved in. Noticeably, under "cargo_vending.yml" there are items that in-game appear under "service", not to mention that there is no "vending" tab to begin with | |||
=== crates === | |||
[https://github.com/space-wizards/space-station-14/tree/master/Resources/Prototypes/Catalog/Fills/Crates space-station-14/Resources/Prototypes/Catalog/Fills/Crates/] | |||
''' | Contains all ''crates'', every "entity block" is a crate (often, one that has holds specific things). Do note: not every crate here can be ordered (like the few syndicate crates), and there are orders that '''aren't''' taken from here (there are a few orders that aren't crates, such as atmospheric canisters and artifacts). | ||
''' | * '''id''' - id of the custom crate (this is the id used in the prev block's "category" field) | ||
* '''parent''' - the type of crate that is used (basically, the id of the empty version of this crate). not sure what it means when the field contains a list, I think the 2nd entry can be used to modify the access the crate normally has (crates also have default access on top of that, so even just having "ChemCrate" will still have the order spawn with its access restricted to chem) | |||
== low priority - infobox == | == low priority - infobox == |
Latest revision as of 15:45, 16 May 2025
Page for the cargo request computer
Very, very, work in progress at the moment.
First page I made from scratch on this wiki, if you think something is formatted wrong / confusingly, there's a good chance that it is, please do feel free to help and fix.
15/05 - right now, the minimum 'viable product' is to a have a table with all the in game orders, and a very basic description of the computer and its use. Once that's up, the page should be moved to be visible on search engines, and instances of it elsewhere in the wiki should link back here.
Relevant GitHub pages:
(take my rough documentation here with a grain of salt, this is what I can tell from the documents + my in-game experience. I am no experience with actually working on the game's code)
orders
space-station-14/Resources/Prototypes/Catalog /Cargo/
Contains all orders. Everything that is "type: cargoProduct" is an order that shows up on the computer.
- id - id of the order (but not what is ordered)
- product - the id of what is being ordered (the id of the crate/thing that will be teleported)
- cost - price of the order
- category - under what filter does the order appear (that is determined by this field, not by the .yml the block is saved in. Noticeably, under "cargo_vending.yml" there are items that in-game appear under "service", not to mention that there is no "vending" tab to begin with
crates
space-station-14/Resources/Prototypes/Catalog/Fills/Crates/
Contains all crates, every "entity block" is a crate (often, one that has holds specific things). Do note: not every crate here can be ordered (like the few syndicate crates), and there are orders that aren't taken from here (there are a few orders that aren't crates, such as atmospheric canisters and artifacts).
- id - id of the custom crate (this is the id used in the prev block's "category" field)
- parent - the type of crate that is used (basically, the id of the empty version of this crate). not sure what it means when the field contains a list, I think the 2nd entry can be used to modify the access the crate normally has (crates also have default access on top of that, so even just having "ChemCrate" will still have the order spawn with its access restricted to chem)
low priority - infobox
right now, i dont think any infobox template is designed / designated to be used for consoles/computers/machines or even constructs in general
I definitely think there should be one for consoles/computers/machines, seeing as its an entire category of items / structures in it of itself, there are a lot of them, they are probably here to stay, and they are very formulaic
with all that said - overall, low priority; the already existing infoboxs (right now, mostly the item infobox) should probably be worked on and refined beofre hand, seeing as there arent many pages that need a "console infobox" at the moment
Just something to consider for the future
- Makes sense. Something like a "structure" infobox for machines and stuff (think fax machines, PA, airlocks or smth). If you could compile a list of fields for these, I can quickly throw an infobox together. Aliser (talk) 02:06, 15 May 2025 (UTC)
High(est for this page) priority - orders table
considering the all the data for the table is available via the github, the entire table can just be automated by having a format/script pull the info from there. This would basically solve all formatting discussion because it we can just have the table display things in how they are presented in the code and in game 1 to 1.
With the massive benefit of "only needing to do this once": if a script can do it, only a single line needs to be formatted, the rest should be automatic, and then even the massive-er benefit of having the page basically maintain itself! (as long as large changes aren't done to the data format, which will damage or straight up brick the script, which is totally a possibility)
There is more to this specific discussion - I will continue this page tomorrow (hopefully)
- Thats the plan! I'm currently reworking my "script" that does automatic updated on items and item recipes and I plan to add stuff like this to it (and many more!). Of course if you want to automate this - feel free to, because who knows when Im gonna finish my thing. Aliser (talk) 02:06, 15 May 2025 (UTC)
- seeing as I currently don't know how to do this, for now I will just copy/write the information by hand, not all of it (description is really unimportant, if I don't find where to copy if from the git, I am not going to waste time typing it manually). The most important information at the moment is to have the orders name, category, price, and actual content (which the description isn't always correct about...)
- however, in general, making the script is definitely worth it in the long term. Even in the event it breaks, the text/table itself that will be generated (or will be available at the last version of the git before the bricking) will still be useable as text until the script can be fixed/replaced. The only way it won't is if, not only the repository format is changed, but also the content of the orders themselves are significantly altered, in which case, both text and code will need to be altered anyway, so more work will have to be done regardless of what path we take.
- also, I forgot that the "cargo" page has most of the orders already written down, so a lot of the manual typing is already done... Just needs to be moved and updated a bit. NonEuclideanHead 11:34, 15 May 2025 (UTC)