📦 about 🧻 posts
Garry Newman
🏠 Home 📄 Posts

Projects

Facepunch Garry's Mod Rust S&box

Online

Twitter-color Created with Sketch. Twitter YouTube TikTok GitHub
Posts
Azure Media Services4 months agoquestion_answer 10Common Math Library4 months agoquestion_answer 5Handshake Game4 months agoquestion_answer 2The Death Of The Web5 months agoquestion_answer 12Aaron Peters5 months agoquestion_answer 19Your licensing system sucks10 months agoquestion_answer 11Disposable Actionone year agoquestion_answer 5The Good Guysone year agoquestion_answer 15Unity can get fuckedone year agoquestion_answer 66Facepunch Birminghamone year agoquestion_answer 10Mexicoone year agoquestion_answer 8NPMone year agoquestion_answer 4Facepunch Bloxwichone year agoquestion_answer 2Laplandone year agoMailbag: Sausage Men2 years agoquestion_answer 1Holiday GameDev Books2 years agoOffice Design2 years agoAccess control in serverside Blazor2 years agothe man who fell to earth2 years agoquestion_answer 1Unity 20222 years agoquestion_answer 13D Printer2 years agoquestion_answer 1Rip Foszor2 years agoquestion_answer 2My Tesla Is Fixed2 years agoMy Tesla Broke2 years agoWhat sucks about Steam2 years agoquestion_answer 1Making A Game 20222 years agoquestion_answer 1InteropGen2 years agoFrozen Shoulder2 years agoShitty Holiday Photos2 years agoYour Portfolio Gave Me Diarrhea3 years agoquestion_answer 2Motivation3 years agoquestion_answer 1We got married3 years agoEverything We Watched In Lockdown4 years agoHouse - What I'd Have Done Different4 years agoHouse - Fuckups4 years agoReceiver Broken4 years agoMy Feet Are Fucked4 years agoWhat Unity Is Getting Wrong4 years agoquestion_answer 2Lockdown Kicks Ass4 years agoHalf-Life:Alyx is a Masterpiece4 years agoOpen a 30gb Unity Log on Windows4 years agoAlex The Gamer4 years agoBlazor Ain't Ready4 years agoJailbreaking Control44 years agoBenchmarking Rust4 years ago£600 Remote4 years agoRusty Legs5 years agoControl45 years agoAndroid: Best & Worst5 years agoRobot Lawnmower5 years agoBest VR Shagging Games5 years agoquestion_answer 2Red Dead 26 years agoUnity FPSSample6 years agoForum Downtime6 years agoFatty6 years agoBlogging & Twitter6 years agoUnity's Staging Packages6 years agoPlaytest Recording6 years agoSteamworks and IL2CPP6 years agoMonitor Upgrade6 years agoSteamworks Libraries6 years agoProcedural Generation6 years agoUnity 2018.16 years agoTimeSince6 years agoKitchen Wank6 years agoPrototyping6 years agoDisplaying an Avatar6 years agoPlayer Name Overlay6 years agoTesla Model X7 years agoNaming Stuff7 years agoFacepunch Api7 years agoAggregation7 years agoThe curse of Early Access7 years agoJenkins Library7 years agoJenkinsfile7 years agoJenkins7 years agoUnity 2017 Changelist7 years agoBinding Steamworks SDK8 years agoFacepunch.Steamworks8 years agoPolitics8 years agoUnreal Engine8 years agoI got suspended from twitter8 years agoPlasticSCM Speed Tip8 years agoBecoming A Gamedev8 years agoJessica8 years agoLiving Room Vive8 years agoI jacked off in VR, twice8 years agoquestion_answer 6GDC 20168 years agoRust's Networking8 years agoCrash Log Tags8 years agoAutomated Crash Processor8 years agoMicrotransactions9 years agoUnity Tips 29 years agoUnity Tips9 years agoGodus9 years agoSteam9 years agoPaying for Mods9 years agoLeafblower9 years agoGarry's Mod is 10 years old9 years agoquestion_answer 1Selling Out10 years agoOne Year On10 years agoI fell out of love with Lua10 years agoRust Screenshots10 years agoDepression10 years agoHow I Upload Stuff10 years ago9 reasons why I LOVE C#10 years agoSerializing Shit10 years agoUnity Viewmodels10 years agoBaby Gadgets10 years agoValve VR Demo10 years agoSteam Dev Days : Day 210 years agoSteam Dev Days Day 110 years ago2013 Goals - in review10 years agoCatchup10 years agoIs Paypal Slow11 years agoStop Programming11 years agoGrand Design11 years agoNext Gen Console11 years agoParenting11 years agoChildbirth II11 years agoChild Birth11 years agoResuable Tools11 years agoDesign by Committee11 years agoThe Columbo11 years agoThis Old House11 years agoClustered11 years agoThe Rust backend11 years agoServer Downloads11 years agoThe Story of Rust11 years agoquestion_answer 2The Conversion11 years agoLike a Rolling Stone11 years agom0r3 gmod beta11 years agoSteampipe Beta11 years agoPiss Shake11 years agoThe Pipe Beta!11 years agoOculus Rift11 years agoLinux and The Pipe11 years agoOffice downstairs11 years agoUnity Wordpress Plugin11 years agoLinuxxx11 years agoThe Beach11 years agoTrees have leaves11 years agoOBS11 years agoPrivacy Thing11 years agoOffice Progress11 years agoLearning Unity11 years agoNew Project11 years agoNextbot & Coroutines11 years agoAirplay To Room11 years agoResellers11 years agoSteampipe Looming11 years agoCoroutines11 years agoRecruiters11 years agoWriting a Wiki Bot11 years agoOil your brain11 years agoTax Investigation11 years agoLua Bindings11 years agoOffice Progress11 years agoPaths11 years agoNext Bot11 years agoThe Sign11 years agoVPK Search Paths11 years agoMailbag11 years agoSteamPipe Mounting11 years agoMailbag – Questions11 years agoOffice Refurb Progress11 years agoTesting GMod Updates11 years agoCatch Up11 years agoGit outa hear11 years agoShadow Gap11 years ago2013 Goals11 years agoPC Hardware Design Sucks11 years agoBorderless Window Mode?11 years agoMore Kinect Stuff11 years agoCoD or Battlefield?11 years agoKinecting GMod11 years agoEntity Editor12 years agoFan Mail12 years agoLua Errors12 years agoOptimising GMod12 years agoTexture Filtering12 years agoToybox Torrent12 years agoToybox Disabled12 years agoSnack Chair12 years agoCoffee Shirt12 years agoCrash Dump12 years agoLuaJIT12 years agoThanks EU12 years agoNew Office12 years agoSky Shader12 years agoEgypt!12 years agoquestion_answer 1I'm going to Egypt for 2 weeks12 years agoMake maps bigger12 years agoApproved Updates12 years agoContext Screen Improvements12 years agoAuto Refresh12 years agoGMod 13 Release Date12 years agoPyro Patch12 years agoSFM vs GMod12 years agoMore Dieting12 years agoAmazon Cloud Search12 years ago12 years agoFrame Blending12 years agoDemo Movies12 years agoDOTA212 years agoWeight Loss Update12 years agoCheaters in GMod12 years agoPortable Computer12 years agoCoding Websites in C++12 years agoBigger Maps12 years agoSteam Captcha12 years agoQuitting Caffine12 years agoMaking Gamemodes Better12 years agoLottery Results12 years agoGWEN Designer12 years agoUnclamped Faceposer12 years agoThe Lottery12 years agoPoster Screenshots12 years agoTrade Off Game Dev12 years agoVersion 49 Models12 years agoImproved Shadows12 years agoquick tool: bundler12 years agoWeight Loss12 years agoWorkshopping12 years agoMore Stuff I did12 years agoCool stuff I did this week12 years agoMegaUpload12 years agoOops12 years agoSOPA12 years agoFamily Tree12 years agoTop 6 Games of 201112 years agoAnt Farm 2.012 years agoCoding Evolution12 years agoHolly Holly, Get Dolly12 years agomklink12 years agoVideo12 years agoBlog update12 years agoAss Kicker12 years agoOther Stuff13 years agoStuff done did13 years agoI done maths13 years agoPC Specs13 years agoBattlefield13 years agoBeta Keys Depleted13 years agoCoding & Beta13 years agoHow To Buy Hardware13 years agoBodygroups13 years agoProgress13 years agoNumpads and gibs13 years agoSpawnmenu update13 years agoBack in business13 years agoWe Beat Righthaven!13 years agoBack from Holiday!13 years agoHoliday Continue13 years agoHoliday Halt13 years agoVegas13 years agoHoliday13 years agoStill Coding13 years agoBeing Sued13 years agoSpawnicons13 years agoOffice Dog13 years agoThe Plan13 years agoErection Failure13 years agoquestion_answer 2The Wild13 years agoGWEN Skins / Pixel Reading13 years agoWIT: Deus Ex (3 I think)13 years agoCODBLOPS13 years agoResources13 years agoDocking13 years agoSteam Chat13 years agoSelling a Car Online13 years agoMy First PC Games13 years agoWIT: From Dust13 years agoThat GMod Update13 years agoGMod Broke Routine13 years agoCloudflare security issues13 years agoImages in Source13 years agoVisual Studio for Lua editing13 years agoMore Android bitching13 years agoRiots13 years agoHome Gym13 years agoAndroid vs iOS13 years agoDoing Stuff13 years agoBlogging lookback13 years agoFrom wordpress to tumblr13 years agoGMod Updating13 years agoBullshit13 years agoForum Owner13 years agoSarah, Part 314 years agoSarah, part 214 years agoSarah, part 114 years agoThe Perfect Woman14 years agoquestion_answer 3The Duplicator17 years agoSTALKER17 years agoSUCCESS!17 years agoReleased!17 years agoRelease Today!17 years agoGMod10 - Tomorrow!17 years agoquestion_answer 1Back In England!18 years agoNew Lua Implementation18 years agoProfessional Mod Makers18 years agoGrey Hair18 years agoGMod Open Source18 years agoPSP Problems18 years agoMore FW Animation18 years agoSnakes18 years agoFacewound Update19 years agoLost19 years agoSuperman19 years agoGMod Text Corruption19 years agoGMod 9.0.1 released19 years agoGMod 9 released19 years agoquestion_answer 2Gmod 9 Release Date Update19 years agoBlack & White 219 years agoquestion_answer 1More 8.4 gamemodes19 years agoLUA (the programming language)19 years agoquestion_answer 1Dee Dee Bam21 years agoSteam Launched21 years agoquestion_answer 3Driving Test21 years agoquestion_answer 1Updated Game Test21 years agoquestion_answer 1Driving lesson and NS22 years agoquestion_answer 1Poor Titch22 years agoquestion_answer 5
Binding Steamworks SDK
8 Years Ago, 1,444 views

I’ve been working on Facepunch.Steamworks in the background while doing Rust’s workshop integration. Just Prerelease branch is shipping with it now.

The challenge was to make a c# library that works under Unity (and not) without recompiling, and on a bunch of platforms.

Here’s everything that sucked about it.

Pack Size

All the structs in the sdk are packed, like this.

#if defined( VALVE_CALLBACK_PACK_SMALL )
#pragma pack( push, 4 )
#elif defined( VALVE_CALLBACK_PACK_LARGE )
#pragma pack( push, 8 )
#else
#error isteamclient.h must be included
#endif

This creates a split between windows and osx/linux. Structs are 8 byte aligned on Windows, 4 byte aligned on osx/linux. This causes drama when you come to marshal them.

CSteamID

It also seems that on Windows CSteamID stops structs getting packed at all. So you’ll find that any structs that have a CSteamID member (which is a lot of them) need to be treated as unpacked.

Callback

A lot of stuff uses callbacks in the Steamworks SDK. The callback system expects a c++ class. This sucks for c#. Getting it to work means you need to create a class to emulate this:

class CCallbackBase
{
public:
CCallbackBase() { m_nCallbackFlags = 0; m_iCallback = 0; }
// don’t add a virtual destructor because we export this binary interface across dll’s virtual void Run( void *pvParam ) = 0;
virtual void Run( void *pvParam, bool bIOFailure, SteamAPICall_t hSteamAPICall ) = 0;
int GetICallback() { return m_iCallback; }
virtual int GetCallbackSizeBytes() = 0;

protected:
enum { k_ECallbackFlagsRegistered = 0x01, k_ECallbackFlagsGameServer = 0x02 };
uint8 m_nCallbackFlags;
int m_iCallback;
friend class CCallbackMgr;

private:
CCallbackBase( const CCallbackBase& );
CCallbackBase& operator=( const CCallbackBase& );
};

Which ends up looking something like this.

[StructLayout( LayoutKind.Sequential )]
internal class Callback
{
public IntPtr vTablePtr;
public byte CallbackFlags;
public int CallbackId;
}

vTablePtr is a pointer to the vtable – which is implementing the virtual functions.

[StructLayout( LayoutKind.Sequential )]
public class VTable
{
public IntPtr ResultA;
public IntPtr ResultB;
public IntPtr GetSize;
}

The awesome confusing part of the VTable is that the first two functions swap positions on windows.

steam_api_interop.cs

For a long time I was trying to use the steam_api_interop.cs file included with the SDK. Don’t use this. It’s non functional out of the box, it’s using the wrong parameters for a bunch of functions and it’s not packing structs.

Because of this I ended up writing my own generator (which I’m sure is getting a few things wrong, but I’m unit testing as much as I can).

For this I’m using the steam_api.json file and some source code regexes for missing stuff. So as much as steam_api_interop.cs sucks, I’m sure it’s only there to serve as an example of how to use steam_api.json and steam_api_flat.h – which makes this all a million times easier.

Things That Suck

Callbacks can return with “IO Failure” if you call them too soon after Steam Init. This sucks for Unit Tests.

Steam thinks your game is still running until you close the exe. This sucks when working in Unity Editor etc.

question_answer

Add a Comment

An error has occurred. This application may no longer respond until reloaded. Reload 🗙
🔌 Reconnecting..