RimWorld

RimWorld

334 ratings
Caravan Formation Improvements
5
2
5
2
2
   
Award
Favorite
Favorited
Unfavorite
Mod, 1.3, 1.4, 1.5, 1.6
File Size
Posted
Updated
1.677 MB
2 Feb, 2023 @ 8:33am
14 Aug @ 4:52pm
13 Change Notes ( view )

Subscribe to download
Caravan Formation Improvements

Description
A few features that should help forming/managing a caravan.



Features:
  • Change the caravan formation spot: Essential if your caravan needs to load stuff from stockpiles that are not close to each other. Let them load stuff at a spot, then switch the spot.
    This can be done either while being in the "form caravan" dialog (new button "set a spot" at the bottom, next to "send") or per gizmo.

  • Select a exit spot: Sometimes you may want your caravan to exit at a specific spot
    This can be done either while being in the "form caravan" dialog (new button "set a spot" at the bottom, next to "send"), per gizmo or per building "exit spot".

  • Select a arrival spot: Select a spot for your caravan where it should enter the map.
    This can be done when you are on the world map and tell your caravan to enter a settlement/temporary map (the map needs to be created already). The dropdown menu will have a new option called "enter at specific spot". Or per building "arrival spot".

  • Pause the caravan formation: Helpful when the caravan can not safely exit the map or when your pawns need to get their mood improved before leaving.
    This can be done per gizmo.

  • Leave immediately: Mostly everything is loaded, but one unnecessary item on the other side of the map is missing. Your pawns are close to a mental break. Just tell them to leave now.
    This can be done per gizmo.
    Only for RW1.5 and below, since 1.6 it is a vanilla feature

  • Next caravan member: Clicking on that gizmo will jump to the next caravan member and select it. Hovering is pointing to every caravan member.
    This can be done per gizmo.

  • Rope on arrival: If set to true, animals will be roped on arrival if they would not otherwise. So if there is no available pen, instead of running free, the mod tries to bring the animals to a hitching spot. If that fails, it will rope the animals to the ground. Mod default is true.
    Mod setting.

  • Rope when caravan gets paused: If set to true, animals roped by a pawn are roped to the ground instead of running free when the caravan formation gets paused. Mod default is true.
    Mod setting.

  • Distance to next ropeable animal: When roping a animal, pawns check if in the radius of 10 cells there is another animal to rope. Mods default is 20 cells.
    Mod setting.

  • Maximal animals to rope at once: When gathering the caravan animals, pawns can collect 10 animals at once. You may want to increase that number. Mods default is vanilla.
    Mod setting.

  • Cancel caravan confirmation: If set to true, there will be a confirmation window if you click the vanilla gizmo "cancel forming caravan". Mod default is true.
    Mod setting.

  • Dont add newborns to caravan: If set to true, animals that are born during caravan formation are not automatically added to the caravan which leads to all animals getting unroped.
    Mod setting.

  • Mod defines exit tile: If set to true, the mod defines on which side of the map the caravan will be spawned on the world map.
    If you are heading to the north, but set the exit spot for this caravan to be south, the caravan should be spawned south of your map on the world map.
    Mod setting.

  • Default caravan arrival/exit spot: Mod setting to enable/disable. Priority for defining the arrival/exit spot of a caravan is as following: Manually selected spot per caravan > exit/arrival spot building > vanilla.

  • Pawns respect their assigned zone when formation is paused: Mod setting. Disabled by default.

  • Downed pawns and ropeable animals are brought simultaneously to the exit spot: Mod setting. Disabled by default.

  • Gizmos can be disabled: There is a section in the mod settings to disable the ones you do not need.



Performane:
Performance should be absolutely no problem, since mostly all of the code runs only once when you use one of the gizmos or when a caravan leaves/arrives at a map.
I checked the impact using "Dubs Performance Analyzer", but please tell me if you experience otherwise!


Limitations:
When the caravan includes downed pawns and you change the exit spot when they are already brought to the map edge, the downed pawns will be automatically removed from the caravan.
Furthermore there seems to be a vanilla bug where it might happen that downed pawns are left behind at the map edge when the caravan leaves the map.

Roping on arrival: Animals are getting roped to the spot where they entered the map if there is no pen/hitching spot, but pawns assigned to handling will try to unrope them. So make a hitching spot or a pen before they do so, so the animals are brought there.

Not every gizmo can be used at all times. If you can not use them at the moment, they are disabled (greyed out).


Compatibility:
  • Probably not compatible with mods that do the same/something similar.
    I am only aware of "Caravan Journey Spot" by leeh and "Caravan Entry Spot" by Cocock which are doing something similar and are probably incompatible.

  • There is a patch for Boundary Training by Owlchemist integrated so that animals that have learned 'boundaries' will not be roped to the ground.

  • Vehicle caravans introduced by Vehicle Framework by Smash Phil:
    You can use both mods, but my mod only applies to the vanilla caravans.

  • Tell me if you find something else.


Bug reporting:
Please dont tell me "it does not work".
Tell me which feature did not work in which circumstances, post a hugslib log and, if possible, tell me how to recreate the problem/error.


Adding/removing from save:
Should be absolutely no problem. You may get a red error after removing which is harmless.


Else:
Source of the mod is included.

Credits and Thanks to:
Ratzinger for beta testing and giving feedback.
Brrainz for Harmony.
Dubs for Dubs Performance Analyzer.
Marnador for the RimWorld font, used in the preview pictures and for the gizmos.
Tynan and Ludeon for RimWorld. Some of the textures/parts of the previews are modified versions of vanilla textures.

License [creativecommons.org]
Popular Discussions View All (1)
5
28 Jul @ 9:39am
Changing tabs configurations forces all items from Transpor pods and Shuttle to drop
Rovstam
151 Comments
kamikadza13 18 Aug @ 3:39am 
Ty.
Kopp  [author] 18 Aug @ 2:43am 
@kamikadza13
Rw 1.6 did introduce the feature "force caravan departure".
Thats why my "Leave the map now" is not active in 1.6, but in version before.
kamikadza13 18 Aug @ 12:48am 
Oh! So it didn't work with buildings, but it works with Commands...
thank you.
Then such a question. And when does gizmo "Leave the map now" show at all?
I always have a standard "Force caravan departure"
But your icon never (or I didn't get it)
Kopp  [author] 17 Aug @ 3:14pm 
@kamikadza13
If the "translated" textures in your mod have the same file path as the original, then your textures should be loaded (textures need the same names as well).
I guess you are talking about the three textures in Caravan Formation Improvements/Textures/UI/Commands (CFI_ExitHere, CFI_FormHere, CFI_LeaveNow).
I upload them for your, so you can easily change the text.
First time using this hoster, not really sure if safe: https://limewire.com/d/VjtCY#MAdCCIaPyI
kamikadza13 17 Aug @ 2:12pm 
Hi. I would like to translate the icons, but I could only do it for two - CFI_ArrivalSpot, CFI_ExitSpot
because they have a path.
ThingDef[defName="CFI_CaravanExitSpot"]/graphicData/texPath
As I understand it, the rest will not be translated until you, as the author, add this feature.
Can you tell me how to translate the rest of the icons that are in the "Commands"?

I have translated the textures through the patch.
https://gtm.steamproxy.vip/sharedfiles/filedetails/?id=2940426768
Kopp  [author] 14 Aug @ 4:53pm 
@dominicawb
Should be fixed.
Thanks for the report.
Kopp  [author] 14 Aug @ 11:46am 
@dominicawb
You are right, seems to be broken.
Will investigate and fix asap.
dominicawb 14 Aug @ 11:37am 
The caravan exit spot is consistently ignored, no matter what I do. caravan arrival seems to work, is anyone else experiencing this?
Cyberes 25 Jul @ 3:16pm 
Thank you for updating!
Rovstam 22 Jul @ 8:46pm 
Ok my bad if it sounded disrespectful. I'll do what you said.