joseasoler / Pathfinding-Framework

Pathfinding Framework is a RimWorld mod that enables the creation of custom movement rules for pawns.
MIT License
7 stars 0 forks source link
framework mod modding pathfinding rimworld unity

Pathfinding Framework

RimWorld Steam Downloads License: MIT Contributor Covenant

Mod preview

Ever wished your colonists in RimWorld could do more than just walk? With the Pathfinding Framework mod, they can! The mod introduces a variety of new movement types, allowing pawns to move across the world in entirely new ways.

You only need to add this mod to your mod list, along with any other mods of your choice that have support for this framework (such as for example mods in the Biomes! series). Pathfinding Framework will then automatically assign appropriate movement types to pawns based on their characteristics, apparel, and other factors.

Discord server: https://discord.gg/HB3KyzStgp

Features

Frequenty Asked Questions (FAQ)

Can I safely add this mod to an existing save?

Yes.

Can I safely remove this mod from an existing save?

No.

How can I make humans walk over deep water?

Go to Options > Mod Settings > Pathfinding Framework. Choose the Pawn Movements tab. Scroll to the end until you see the Human entry. Click on the Terrestrial button and set it to Swimming.

Where should I place Pathfinding Framework in my mod list load order?

As long as the mod does not trigger any load order warnings, it will work fine. Using RimSort or RimPy to sort your list should always give optimal results.

Is this mod compatible with...

Pathfinding Framework should be compatible with almost every mod. Other mods can be found in the table below.

Mod Compatible
Biomes! Islands Yes
Clean Pathfinding 2 Yes
Giddy-Up 2 Yes
Vanilla Expanded Framework Yes
Vehicles Framework Yes
Vanilla Furniture Expanded - Security Yes
Windows Yes
SwimmingKit No
TerrainMovementKit No

Releases

Pathfinding Framework releases can be found at the following places:

Steam Workshop page: https://steamcommunity.com/sharedfiles/filedetails/?id=3070914628

GitHub tags: https://github.com/joseasoler/Pathfinding-Framework/tags

Troubleshooting

Pathfinding Framework includes some useful features for troubleshooting bugs, which can be checked at the Troubleshooting wiki.

The preferred sites for bug reports are the Discord server and the GitHub issue tracker.

Development

To compile this mod on Windows, you will need to install the .NET Framework 4.8 Developer Pack. On Linux the packages you need vary depending on your distribution of choice. Dependencies are managed using NuGet. Your checkout must be placed in the RimWorld/Mods folder to let it find the RimWorld assemblies required for compilation.

Contributions

This project encourages community involvement and contributions. Check the CONTRIBUTING file for details.

MSeal: Original implementation of TerrainMovementKit and SwimmingKit.

joseasoler: Pathfinding Framework implementation.

Elseud: Preview image.

Other contributors can be checked in the contributors list.

License

This project is licensed under the MIT license. Check the LICENSE file for details.

The preview image is licensed under the Attribution-NonCommercial-NoDerivs 4.0 International license.

Acknowledgements

Read the ACKNOWLEDGEMENTS file for details.