galaco / studiomodel

Go package for parsing Source Engine StudioModel formats (.mdl, .vtx, .vvd, .phy)

studiomodel

Golang library for loading Valve studiomodel formats (.mdl, .vtx, .vvd)

Some parts of a prop are mandatory (mdl,vvd,vtx), others are not (phy). It's up to the implementor to construct a studiomodel the way they want to.

This is a collection of parsers for different formats, it has no concept of the filesystem structure (theoretically different StudioModel components could be located in different folders).

Tested against Counter Strike Source and Counter Strike Global Offensive

Features

• VVD reader is stable
• VTX reader is usable, only for single LOD models
• MDL reader is usable, currently incomplete (some properties not populated)
• PHY reader is usable, string data table is not supported yet

Usage

package main

import (
	"github.com/galaco/studiomodel"
	"github.com/galaco/studiomodel/mdl"
	"github.com/galaco/studiomodel/phy"
	"github.com/galaco/studiomodel/vtx"
	"github.com/galaco/studiomodel/vvd"
	"log"
	"os"
)


func main() {
	filePath := "foo/prop" //
	
	// create model
	prop := studiomodel.NewStudioModel("models/error")

    // MDL
	f,err := os.Open(filePath + ".mdl") // file.Load just returns (io.Reader,error)
	if err != nil {
		log.Println(err)
		return
	}
	mdlFile,err := mdl.ReadFromStream(f)
	if err != nil {
		log.Println(err)
		return
	}
	prop.AddMdl(mdlFile)

	// VVD
	f,err = os.Open(filePath + ".vvd") // file.Load just returns (io.Reader,error)
	if err != nil {
		log.Println(err)
		return
	}
	vvdFile,err := vvd.ReadFromStream(f)
	if err != nil {
		log.Println(err)
		return
	}
	prop.AddVvd(vvdFile)

	// VTX
	f,err = os.Open(filePath + ".vtx") // file.Load just returns (io.Reader,error)
	if err != nil {
		log.Println(err)
		return
	}
	vtxFile,err := vtx.ReadFromStream(f)
	if err != nil {
		log.Println(err)
		return
	}
	prop.AddVtx(vtxFile)

	// PHY
	f,err = os.Open(filePath + ".phy") // file.Load just returns (io.Reader,error)
	if err != nil {
		log.Println(err)
		return
	}
	phyFile,err := phy.ReadFromStream(f)
	if err != nil {
		log.Println(err)
		return
	}
	prop.AddPhy(phyFile)
	
	log.Println(prop)
}

studiomodel's Issues

How do Hitboxes work?

Hey 👋

From what I gather hitboxes of things like doors, boxes and barrels are part of model files as well.

Do you know how to work out if a certain trajectory goes through a model placed in a certain location on the map? (of course the model doesn't hold data about where it's placed, that part would need to be provided by the user)

I'd be happy to contribute some code in this area once I understand how to do this

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update module github.com/go-gl/mathgl to v1.1.0

Detected dependencies

circleci

.circleci/config.yml

• circleci/golang 1.17

gomod

go.mod

• go 1.19
• github.com/go-gl/mathgl v1.0.0

---

• Check this box to trigger a request for Renovate to run again on this repository