About this mod

This library supports the creation of new vehicles.

Requirements
Permissions and credits
Changelogs
Donations
Please support me by:


To learn more about using VF or developing with VF, check out the wiki!

Installation Guide (video)

How to use the Drone Station (video)

Vehicle Framework Vehicles:


Vehicle Framework Upgrade Modules (they also work for Seamoth/Prawn/Cyclops!)



Vehicle Framework also supports the following in-game upgrade modules:
  • Hull Modules
  • Storage Modules
  • Engine Efficiency Modules


Vehicle Framework is supported by, but doesn't require, some other mods:
  • Vanilla Styled Icons
  • Roll Control
  • Free Look
  • Attitude Indicator
  • Here are all the others

    Contributors



    What is this library?
    This library more-or-less completely automates the process of turning a model into a real, usable-vehicle.
    If you are a user, I hope this means you will see many new vehicles in the future.
    If you are a developer, look here to implement your own Vehicle Framework watercraft.

    Is this compatible with previous saves?
    Yes, you can add and remove this mod and its derivatives at will.

    Does this work with Slot Extender?
    Yes, it does. Here's how it works:
    • Slot Extender and VF can be installed alongside each other
    • Slot Extender will not add slots to VF vehicles
    • Config Manager can be used to add slots to VF vehicles


    Is there a comprehensive feature list?
    No, I'm afraid I don't have anything quite so formal right now.
    Please rest assured that vehicles added in this way will mesh into the game in most of the normal ways.
    They use the same batteries, have the same kinds of storage, take the same upgrades (to an extent), and cause angst in Crabsquids with their headlights just like the normal vehicles.

    What significant features have not yet been implemented?
    • A "seamoth class" of vehicles. These would not have a walkable interior, but you would enter directly to piloting. (January 2024)
    • An auto-pilot mode. The hard part is adding a new PDA page from which you can select a destination.
    • A full suite of autopilot voice lines (November 2021)
    • Arm modules. Honestly I've not felt any need to implement this, but I would like VehicleFramework to include "walkers" in the future.
    • Positional Damage. I would like if certain modules could be taken offline by damage.
    • Additional Pilot HUD. I had in mind to display information on storage and individual batteries, as well as positional damage sustained.
    • Don't simply disappear when destroyed. (November 2021)
    • Crabsquid protection module
    • Better glass shading? Notice the Atrama glass canopy is opaque. This can probably be fixed by dividing the canopy into an "inside" and an "outside," each of which have only one normal.
    • Dock Interaction? For a certain class of vehicles, maybe docking can be permitted in a Moonpool or Cyclops.
    • Interaction with the "Vehicle Upgrade Console." It would be nice to be able to change colors and names on-the-fly.  (October 2022)
    • Internal Fabricator(s). (November 2021)
    • Steering Wheel and Animations. The Seamoth steering column can probably be repurposed.
    • Engine Sounds. (January 2022) Thank you, Shiruba.
    • VR Support. (August 2022) I strongly recommend VR Enhancements
    • Vehicles docking onto Vehicles. See the Beluga!
    • External Cameras (June 2024)
    • Interior Building (June 2024)


    Console Commands:
    Vehicle Framework introduces several console commands, which you can use by inputting them in the game's console. Normally, you can access the console by hitting Shift+Enter. Here's what they are and do:
    • vfhelp: writes a PDA note to your screen with the names of all these console commands
    • givevfupgrades: adds to your inventory every upgrade for VF vehicles
    • givevfseamothupgrades: adds to your inventory every VF upgrade for the Seamoth
    • givevfprawnupgrades: adds to your inventory every VF upgrade for the Prawn
    • givevfcyclopsupgrades: adds to your inventory every VF upgrade for the Cyclops
    • logvfupgrades: writes to your bepinex log all the VF upgrade mods you have installed
    • logvfvehicles: writes to your BepInEx log all the vehicle mods you have installed
    • logvfvoices: writes to your BepInEx log all the vehicle voices you have available
    • vfspawncodes: writes a PDA note to your screen with all the vehicle/upgrade spawn codes (the spawn console command)
    • undockclosest: attempts to forcibly undock the nearest vehicle from its docking bay
    • vfdestroy [vehicle type]: attempts to forcibly delete the nearest vehicle you specify (eg "vfdestroy exosuit" or "vfdestroy odyssey")


    I would like to read the source.

    Credits: