Skip to content

H2xDev/GodotVMF

Repository files navigation

GodotVMF

Discord Reddit Godot Asset Library

Description

An importer of VMF files into Godot Engine or Redot Engine.

Highly recommended to use Hammer++ since it supports precised vertex data.

Why?

We with my friend Ambiabstract did not find a convenient plugin for us to create levels for Godot and so we decided to use our favorite and familiar editor :)

A useful tool for those who like making levels in Hammer and are making a project on the Godot. Or for those who just want to port their map from Source Engine to Godot and see what happens.

Usage

Features

  • Brushes geometry import (including UVs, materials IDs and smoothing groups)
  • Instances support
  • Native MDL support
  • Native materials support
  • Native VTF support (only DXT1, DXT3, DXT5 supported)
  • Displacements import (with vertex data)
  • Entities support
  • Hammer's Input/Output system support
  • Automatically generates SteamAudioGeometry in case godot-steam-audio plugin detected
  • Surface props support

Known issues

  • Extraction of materials and models from VPKs is not supported
  • Some of imported models may have wrong orientation
    • Use Additional Rotation property in the MDL import options
  • Avoid importing a big bunch of models/materials at once it may cause the engine crash or import freeze. There's some issues with threaded import in the engine.

Legality of use

If you are going to use Hammer Editor for commercial purpose it's worth to asking Valve for permission to use their tool. There shouldn't be any problems if you are using this tool for non-commercial projects.

Contribution

If you have some ideas, suggestions regarding to quality or solutions of the problems above, feel free to contribute!

  • If you've added a new feature please add the relevant documentation.
  • Follow the common Godot codestyle (yea-yea i'll fix the existing code in upcoming updates).

How to test the addon after adding new features or fixing some bugs

  1. Install any of Source Engine Games (L4D, HL2, TF2)
  2. Unpack all textures and models from VPKs
  3. Decompile most complex maps
  4. Try to import decompiled maps in Godot
  5. Check for errors if they appear

Additional things

Credits

H2xDev - main contributor
Ambiabstract - tech help and inspiration
MyCbEH - level design for example project, UAZ model
Lachrymogenic - Linux test, performance test
SharkPetro - materials test

License

MIT

About

A VMF importer for Godot Engine/Redot Engine

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •