Skip to content

Latest commit

 

History

History
101 lines (67 loc) · 4.67 KB

README.md

File metadata and controls

101 lines (67 loc) · 4.67 KB
Raw

HL2UE4 Asset Importer

A WIP Unreal Engine 5 plugin that adds support for importing various Source engine file format, with a long-term goal of being able to import the entirety of Half-Life 2 into the UE5 editor and play through the full game.

Project Status

Please see Project Status for a more detailed list.

  • Key

    • ✔️ Full Support
    • ❗ Partial Support / WIP
    • ❌ No Support

  • ❗ Textures (.vtf) v<=7.5.3

  • ❗ Materials (.vmt)

  • ✔️ Static Models (.mdl) v44-48

  • ❗ Animated Models (.mdl) v44-48

  • ❗ Maps (.bsp) v19-20

  • ❗ Sounds

  • ❌ Effects and Particles

Entities and Logic

  • ❗ Entities (from .bsp)
  • ❗ Player
  • ❌ NPCs

Other

  • ❗ Lighting
  • ❗ Physics

Getting Started

This project is architected as a UE5 plugin, comprising of an editor module and a runtime module.

Prerequisites

Installing

  1. Create a new UE5 project - choose a blank empty project with no default assets and no default code. Close the editor.
  2. Create a folder in the project folder (next to the .uproject) called "Plugins".
  3. Create a folder inside "Plugins" called "HL2AssetImporter" - clone the repo into there.
  4. Load up the UE5 project. It should talk about compiling the plugin for the first time.
  5. Go to Edit -> Plugins, go to the "Project" category and find "HL2.AssetImporter".
  6. If "Enabled" is not ticked, tick it and restart the editor.
  7. If all has gone well, you should see a new "HL2" icon in the main tool bar.

Screenshot of toolbar

Importing HL2

Note that the following steps, especially the bulk imports, will take a long time - depending on if your project and extracted HL2 assets are on SSDs or not, and the strength of your CPU. Expect to put aside an hour or more for the whole process. You should also have 32GB of ram or more in your system as the editor likes to feast upon it during the bulk imports.

There may also be certain assets that fail to import. This won't cause issues usually, but you do need to watch it and click ok otherwise it won't continue with the bulk import.

After every step you should save (File -> Save All) otherwise, if it crashes, you'll have to start all over again.

  1. Use GCFScape or another tool to extract the HL2 vpks to somewhere on disc.
  2. From the "HL2" toolbar icon, click "Bulk Import Textures". Navigate to the extracted HL2 "materials" folder.
  3. From the "HL2" toolbar icon, click "Convert Skyboxes".
  4. From the "HL2" toolbar icon, click "Bulk Import Materials". Navigate to the extracted HL2 "materials" folder.
  5. From the "HL2" toolbar icon, click "Bulk Import Models". Navigate to the extracted HL2 "models" folder.
  6. Create a new empty level.
  7. From the "HL2" toolbar icon, click "Import BSP". Navigate to the extracted HL2 "maps" folder. Select a map like d1_trainstation_01.
  8. TODO: Instructions on how to setup inputs for player interaction.

Running the tests

There are only a couple of unit tests for some core systems so there's not much point in running these religiously (yet).

  1. Go to Edit -> Plugins, find and enable the "Editor Tests", "Runtime Tests" and "Functional Testing Editor" plugins.
  2. Restart the editor.
  3. Go to Window -> Test Automation.
  4. Tick the category "HL2" and click "Start Tests".

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Note that there is some third party code included with the project that is NOT licensed under MIT, this code is kept in separate folders with their own licenses.

Acknowledgments