(Documentation) - Wiki

[Sn1p3rr3c0n]

Our Documentation should be Updated.

New Documentation

• Getting Started / Basics Guide
  • Color Scheme
  • Input & Output mechanics
  • ...
• (Maybe) some sample builds (maybe with save files)

Overhaul of existing Documentation

Currently most of the Documentation is Autogenerated by a tool @Steague made. I Think it gives a great first overview of each building. Sample: I Have already Created a fork of it for the purpose of Updating and expanding on it: https://github.com/Sn1p3rr3c0n/prf-xml-to-md

In addition to the output generated by that tool I think it would be helpful to provide additional Information for each building. That may include but is not limited to:

• Usage of the Thing
• Documentation of maybe more unknown Features
• Documentation of limitations
• some Pointers
• Special Things to be aware about
• ...

---

Regarding https://github.com/Sn1p3rr3c0n/prf-xml-to-md it need needs a Updated Recourse List (Links to Wiki(s) & Image(s)) It also might be worth to expand it to support different mods as well

[Sn1p3rr3c0n]

it might also be useful to create seperate pages for each Building (the symbols would be an exception)

I started to write a Page for the Archival Storage Unit

[Sn1p3rr3c0n]

Some progress on the tooling side. Can generate now for all XML Files and the Images are Updated.

There is still much to to such as:

• remove Power Column for stuff that does not use it
• Add Support for Item Crafting recipes (Resource Cost is not displayed correctly)
• Updating Links to internal Items
• Add Support to Patched Stuff

[Sn1p3rr3c0n]

First Update to https://github.com/zymex22/Project-RimFactory-Revived/wiki/Construction-and-Crafting-Resources TODO (tooling or manual):

• [ ] Remaining Crafting recipes
• [ ] (Tooling) remove Power Column
• [ ] Update Research Prerequisites
• [ ] Add info where they can be built

---

Fully Updated: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Batteries I think those should Stay together on the Page

---

Updated: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Animal-stations TODO (tooling or manual):

• [ ] (Tooling) Nicer display of Multiple Research Prerequisites
• [ ] I Think the Advanced Slaughterhouse should get its own Page (Its different enough to warrant extra explanations)
• [ ] Rename Page to Animal Harvesters (or something alike)

---

Updated: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Archival-Storage-Unit TODO (tooling or manual):

• [ ] (Tooling) Maybe at the + 10W Per item automatically

---

Updated: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Assemblers-and-Recipe-Database TODO (tooling or manual):

• [ ] (Tooling) Show actual Item Name in Resource Cost
• [ ] I left Assembler / Recipe Database Usage Untouched for now but that needs to be Updated
• [ ] Maybe Move Learning variants and DB to separate Page

---

Needs Update: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Cookers-and-food-equipment TODO (tooling or manual):

• [ ] no Skill column in Tooling. Should it be there?
• [ ] Size and Texture Issues for some
• [ ] Should probably split off Meat Grinder, Fermenting Tank and Industrial Food Processor to Separate Pages

---

Uncertain maybe remove: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Creators The Page itself is Outdated, most of the Content is also shown elsewhere.

• [ ] Do we need this Page
• [ ] If yes Needs manual Update

---

Check: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Developer Page appears to document some XML Features added by Rimfactory. Could be useful for modder's creating Addons. Probably needs an Update / Extension.

---

Updated: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Farming Removed Animal Station Duplicates. TODO (tooling or manual):

• [ ] Maybe separate Drone and Nano Cultivator as well as the Sprinklers

---

No content Change: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Floor-Signage Honestly no idea what that is part of Rimfactory

---

[Sn1p3rr3c0n]

One General Point for the Wiki that I have noticed is that the Pictures of the Buildings don't render correctly on Mobile.

Preliminary test show that alt least 1300 px (i think its px) width are required for them to draw correctly / at all.

[Sn1p3rr3c0n]

Updated: https://github.com/zymex22/Project-RimFactory-Revived/wiki/I-O-Port TODO (tooling or manual):

• [ ] Add IO Pusher as a Sub Type

---

Check: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Industry TODO (tooling or manual):

• [ ] Separate pages for Industrial Automatic Mason, Smart Recycler, Thornsworths Art Machine, Metal Refinery, Basic Assembler
• [ ] All Furnace on one Page

---

Check https://github.com/zymex22/Project-RimFactory-Revived/wiki/Issues Lists Incompatibility's. Probably needs Update.

• [ ] At what point do we note stuff here?

---

Updated: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Lighting

---

Check: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Logistics TODO (tooling or manual):

• [ ] Separate Pages for Fueling Dispenser, Smart Hopper
• [ ] Separate Page for all Pullers
• [ ] Separate Page for all Belts + maybe the Item chute
• [ ] (Tooling) Texture issue for Wall & Underground Splitter

---

Updated: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Miners TODO (tooling or manual):

• [ ] (Tooling) Stuffable Resource Costs apper to not show up
• [ ] Maybe (Tooling) add Info what can be mined

---

Regarding: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Mod-support-and-Patches An Overview Might be useful but i would prefer to have the details on the pages of the affected Buildings

---

Updated: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Workbenches TODO (tooling or manual):

• [ ] Maybe Separate Page for Research
• [ ] Add info for the Different Possible Bills

---

Check: https://github.com/zymex22/Project-RimFactory-Revived/wiki/Storage-Management TODO (tooling or manual):

• [ ] Separate Page for DSU
• [ ] Separate Page for Crate's