Ben1138 / SWBF2-.lvl-Extraction-Tools-for-Unity3D

Unity SWBF2 .lvl Extraction Toolset

Extract assets contained within .lvl files to Unity. This project began as a fork of Ben1138's modtools importer, but diverged and conflicted so significantly that it made sense to separate it. It is one of the many projects under the LibSWBF2 umbrella.

Tested on MacOS Catalina, Ubuntu 18.04, and Windows 10.

Features

• Import multiple .lvl files and automatically resolve references between them
• Handles:
  worlds with skydomes, mesh or heightmapped terrain, regions, and props,
  
  static and skinned models, animations,
  
  collision meshes and primitives.
  
  
• Objects can also be imported free from association with a specific world
• Animation, Prefab, Model, Material, and Texture assets can be saved with each import

Installation

1. This repo itself should only be cloned if you plan on contributing, it does not contain the required native plugin builds (see bottom). If you wish to simply use the tools, please download a ZIP release!
2. Unzip and place the LVLImport folder into your Assets/ directory. If the SWBF2 menu entry doesn't appear, check the error log.

Usage

1. Click on SWBF2 --> Import .lvl.
2. Add/Remove .lvl files, dependency order does not matter.
3. Import Worlds to import the worlds and their dependencies into your project/active scene. Import Objects will import all the objects (ODFs) contained within the loaded lvl files and space them out under a root object in the project/active scene. Check Save World if you wish to save terrain and skydome assets. Check Save Objects if you wish to save/instantiate the converted GameObjects as prefabs. The other options are self explanatory,
4. Note that if you are saving assets, the import process may take quite some time depending on the lvl size, with no direct progress indicator. This will be fixed soon, but requires precise use/testing of the AssetDatabase API, which I'm still grappling with.

TODO:

• More finely grained extraction, eg, per-model, ODF in each .lvl file
• Sounds
• Particle effects
• Lightmap UV generation
• Full ODF inheritance + properties for root classes like hover, solider, prop, etc
• Special handling for soldier classes

General Notes:

• This importer relies on native plugins (libLibSWBF2.so/.dylib on Linux/MacOS and LibSWBF2.dll on Windows), which are not included in this repo
• Munged script data is the focus of this project
• LibSWBF2 contains the first working animation unmunger, and thus this importer can import animations correctly, apply them to GameObjects, and save them as clips. However, SWBF2 animations identify bones simply by name, while Unity requires a full transform path, so some anims may fail to be properly attached. Moreover, some animation dependencies are hardcoded into the root classes, eg soldier. These are not handled yet, so unless the imported object's ODF explicitly defines an AnimationName property, the required animations will not be imported.
• Many objects depend on common assets defined in ingame.lvl