https://github.com/shane-sdk/usource
USource is a Unity Engine plugin for importing Source Engine content
https://github.com/shane-sdk/usource
bsp garrys-mod garrysmod half-life mdl source source-engine unity unity-engine unity-package unity3d vmf vmt vtf
Last synced: 8 months ago
JSON representation
USource is a Unity Engine plugin for importing Source Engine content
- Host: GitHub
- URL: https://github.com/shane-sdk/usource
- Owner: Shane-SDK
- Created: 2025-01-17T23:15:14.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-01-24T22:35:00.000Z (9 months ago)
- Last Synced: 2025-01-24T23:24:47.260Z (9 months ago)
- Topics: bsp, garrys-mod, garrysmod, half-life, mdl, source, source-engine, unity, unity-engine, unity-package, unity3d, vmf, vmt, vtf
- Language: C#
- Homepage:
- Size: 792 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
>[!WARNING]
>### This is in a very rough state right now and is not production ready yet
>- Has not been tested in builds (Does successfully build however)
>- Asset browser does not show preview images for content
>- Has only been tested on content from 2013 Source Engine games, specifically Garry's Mod, Half Life 2, and Counter Strike: Source files.
>- Centered around the Universal Rendering Pipeline
>- Inconsistent MDL importing physics models / mesh colliders
>- Inconsistent MDL importing relating to checksum errors
>- Some VPKs (Garry's Mod) are not read properly
>- BSP/VMF angles are not converted correctly
>- Assets imported using the Asset Browser may need to be reimported through the Unity Project window in order for them to import correctly.
>
>Despite the current state I want to publicize this for anyone who may be interested in its development. I plan on using this in my other projects so it is important to me that these problems get solved in the future
### USource is a plugin that lets you import Source Engine content such as materials, textures, models, and maps.
Specifically it uses Unity's AssetImporter classes to allow Source's proprietary file formats to be converted into their Unity-counterparts. This means any assets converted are handled in a way consistent with how the Unity Editor expects you to use assets.
In addition an Asset Browser is provided that allows users to browse and import any Source assets found in their games' folders into their project.
>[!NOTE]
>USource is a heavily modified version of [uSource by DeadZoneLuna.](https://github.com/DeadZoneLuna/uSource)
>
>Any Source Engine files in your project require their dependencies (IE other files like vmts, vtfs...) to be present first in order for them to import correctly. The Asset Browser handles importing dependencies for you and should be your primary means of getting content in your project, as opposed to copy/pasting with your clipboard.
## Source Asset Support Status
|Source File Type|Asset Type|Status|
|-|-|-|
|mdl|Model|Prefabs/GameObjects|
|vtf|Texture|Texture2D|
|vmt|Material|Material|
|vmf|Uncompiled Level|Prefab/RealTimeCSG Brushes. [1] Buggy|
|bsp|Compiled Level|Prefabs/GameObjects|
|pcf|Particles|In the future|
>[!IMPORTANT]
>- [1] VMF files use [RealtimeCSG](https://realtimecsg.com/) brushes for the level geometry. It is not a requirement to use this plugin
>
>VMFs are only functional/supported if the RealtimeCSG symbol is present in your Project Settings. This symbol should appear automatically if RealtimeCSG is in your project.
## MDL Data Support Status
|Feature|Status|
|-|-|
|Mesh|Supported [1]|
|Bodygroups|In the future|
|Skins|In the future|
|Shape keys|In the future|
|Hitboxes|In the future|
|Animations|In the future|
|Physics/Colliders|Supported|
|Lightmaps|Supported|
>[!NOTE]
>- [1] Currently only the 'default' bodygroup/skin configuration is imported.
## BSP Data Support Status
|Feature|Status|
|-|-|
|World collision|In the future|
|World Geometry|Supported [1]|
|Displacements|Buggy [2]|
|Props|Supported|
|Brush entities|In the future|
|Skybox|In the future [3]|
|Light probes|Supported|
|Lightmaps|Supported [4]|
|Water|In the future|
>[!NOTE]
>- [1] BSP files have import options to change how world geometry is imported. You can import it as 1 mesh or have it split by visleafs. The latter is necessary for Unity's occlusion system as it allows sections of the world to be hidden.
>- [2] Displacements generally work but can appear flattened. Blended materials are not supported right now.
>- [3] You can choose to occlude the skybox from your BSP's mesh. However models that appear in the sky will not be occluded right now. Additionally Unity Sky Materials are not created at the moment.
>- [4] Lightmap UVs are generated by Unity's lightmap UV generator. It does not use the BSP's UVs.
## Images
