Pragma is currently in an early beta, some features may not be fully functional at the moment or are unfinished/experimental.
Pragma also ships with the [Pragma Filmmaker](https://wiki.pragma-engine.com/books/pragma-filmmaker/page/getting-started), an open source alternative to the Source Filmmaker. You can use the Book Navigation on the left to navigate to the next page, which has details on how to download and install Pragma. Click the [](https://wiki.pragma-engine.com/shelves) button at the top right for other topics (such as the API documentation for developers). ### Media # Download ### System requirements - **Operating System:** Windows 10 (or newer) / Ubuntu 22.04 LTS (or newer) - **Memory:** 4 GiB RAM or more - **Graphics card:** GTX 1050 Ti or newer ### Download ##### Standalone [](https://github.com/Silverlan/pragma/releases/latest) Download the "-win64.zip" version if you're on a Windows OS, and "-lin64.tar.gz" for Linux. No installation is required, simply extract the archive somewhere and run the "pfm.exe". ##### Source Code [Pragma](https://github.com/Silverlan/pragma) and [PFM](https://github.com/Silverlan/pfm) are both completely open-source on GitHub, which means you can also build them yourself. For more information, check out [this article](https://wiki.pragma-engine.com/books/pragma-engine/page/building-pragma). # Changelog See [progress reports](https://wiki.pragma-engine.com/books/supporters/chapter/posts) for a showcase of new features. ### Version 1.0.5 \[2022-08-30\] ##### Filmmaker v0.4.6 - Added Pragma Renderer - Added SSAA - Added motion blur - Added directional light maps - Added volumetric spot-lights - Virtual Reality support - Added new [transform gizmo system](https://wiki.pragma-engine.com/books/pragma-filmmaker/page/viewport#bkmrk-move) - Added/Improved viewport actor interaction - Added undo-redo system - Added [decals](https://wiki.pragma-engine.com/uploads/images/gallery/2022-08/scaled-1680-/pragma-2022-08-27-16-34-24.png) - Added [tutorials](https://wiki.pragma-engine.com/books/pragma-filmmaker) - Added option for importing map into project - Added new actor context menu options - Added support for rendering legacy Eye shader with Cycles X - General UI improvement updates - Significantly improve quality of baked lightmaps - Added components: - pfm\_baked\_lighting - pfm\_cuboid\_bounds - pfm\_pragma\_renderer - pfm\_motion\_blur - pfm\_rt\_mover - pfm\_overlay\_object - pfm\_camera\_actor\_link - pfm\_selection\_wireframe - pfm\_cone\_wireframe ##### Engine - Added motion blur effect - Added object BVH system for fast scene intersection tests - Added directional lightmap baking - Improved volumetric spot-light effect - Fixed bloom effect appearing stretched on widescreen resolutions - Fixed white edges around objects with masked alpha transparency - Added entity components: - renderer\_pp\_bloom, renderer\_pp\_dof, renderer\_pp\_fog, renderer\_pp\_fxaa, renderer\_pp\_tone\_mapping - optical\_camera - bvh, static\_bvh\_cache, static\_bvh\_user - light\_map\_data\_cache - Fixed various crashes ##### Lua - Added table.count, table.is\_empty - Added gui.Element:FindAncestorByClass, :SetAutoSizeToContents, :UpdateAutoSizeToContents, :ShouldAutoSizeToContentsX, :ShouldAutoSizeToContentsY - Added game.Model:GetEyeball, .Load - Added ents.EyeComponent:FindEyeballIndex, :GetEyeballProjectionVectors - Added ents.ClickComponent.find\_entities\_in\_kdop - Added ents.BvhComponent:IntersectionTestKDop - Added ents.BaseBhvComponent:RebuildBvh, :FindPrimitiveMeshInfo, .HitInfo:CalcHitNormal - Added ents.DecalComponent:ApplyDecal - Added util.ImageBuffer:SetPixelColor - Added game.Model.Mesh.Sub:HasVertexWeights - Added python library - Added prosper.util.record\_resize\_image, .create\_generic\_image\_descriptor\_set - Added Model.Mesh.Sub:MakeVerticesUnique, :SetVertices, :SetIndices - Added asset.get\_asset\_state - Added vector.calc\_spherical\_stereo\_transform - Added ents.LightMapComponent.DataCache:GetInstanceIds, :GetInstancePose - Added ents.BaseEnvLightSpotComponent:CalcConeFalloff, :CalcDistanceFalloff - Added ents.BaseEnvLightPointComponent:CalcDistanceFalloff - Added util.ThreadPool:WaitForCompletion - Added ents.citerator, ents.get\_all\_c, ents.IteratorFilterFunction - Added classes ents.LightMapDataCacheComponent, ents.LightMapComponent.DataCache ### Version 1.0.4 \[2022-05-31\] ##### Filmmaker v0.4.5 - Replaced Cycles with Cycles X (With OptiX and OptiX denoising) - Significantly improved performance of live raytracing render - Live raytracing render now automatically updates on certain scene changes (e.g. lighting) - Graph Editor is now mostly functional and can be used for animating - Added internal [Web-Browser](https://wiki.pragma-engine.com/books/pragma-filmmaker/page/downloading-and-importing-assets#bkmrk-web-browser) which automatically detects and imports downloaded assets - Added new project file format (old format is no longer supported) - Added reflection probe and lightmap baking - Added option to copy/paste and share actors with animation data between projects - Added secondary and tertiary viewports - Significantly reduce real-time peformance impact of retargeted actors - Sky settings have been moved to "sky" actor component to allow animating sky properties - Sky overrides and angles can now be previewed in the game viewport - Actors and actor components can now be removed - Improved asset explorer filter - "emission\_factor" entry field in material editor is now a color field instead of a simple slider - General load and save performance improvements - Added quicksave and autosave - Added new rebindable hotkey system and default hotkeys - Bones can now be animated with transform widgets in 3D viewport - Support for volumetric spotlights when rendering with Cycles - Generated model asset icons now zoom in and focus on the character head for character models - Added IK configs, IK posing and animating with IK - Actors can now be right-clicked in game viewport to edit materials directly - Fixed timeline zoom issues and improved zooming behavior - Fixed incorrect camera FOV values when importing a SFM session - Lots of crash, interface, general bug fixes, improvements and QOL changes ##### Engine - Added support for meshes with more than 65535 vertices - Significantly improved asset loading times - Added model asset import support for formats: blend, fbx, dae, x3d, obj, abc, usd, pmx (MMD) - Assets can now be automatically detected and imported from archive files - Added support for Source Engine ["Eyes" shader](https://developer.valvesoftware.com/wiki/Eyes) - Added support for "$alpha" VMT parameter - Added console commands: - asset\_multithreading\_enabled - asset\_file\_cache\_enabled - render\_enable\_verbose\_output - debug\_dump\_font\_glyph\_map - locale\_localize - util\_convert\_cubemap\_to\_equirectangular\_image - util\_convert\_equirectangular\_image\_to\_cubemap - Added "-console" launch parameter arguments: "gui", "guid" - Console command launch parameters that appear after "+map" are now executed after the map has been loaded - Added entity components: - game\_animation\_player, game\_animation\_recorder - func\_portal, portal - liquid\_surface, liquid\_volume, buoyancy, surface, liquid - weapon\_physcannon - wireframe\_camera - Added maps: test\_3d\_skybox, test\_ai\_nav, test\_fog, test\_mirror, test\_physics, test\_portal, test\_water, test\_particles - Added gravity gun script - Added support for rotating GUI elements - Added support for UTF8 fonts and localization - Added "local view target factor" for controlling character eyes - Updated particle system to new renderer - Various blob particle improvements - Fixed water buoyancy physics - Fixed fog not rendering - Fixed 3D skybox not rendering - Fixed water not rendering - Fixed issue where light source could appear as turned on despite being turned off or removed previously - Fixed crash when loading models with custom activity names - Added Fortress Forever to default mount list - Added support for equirectangular skyboxes and sky angles - Fixed crash when attempting to export model asset with invalid flex rules - Fixed some model meshes not being rendered - Maps in new-game menu are now split into native maps and external maps - General performance improvements - Spot-light inner cone angle has been replaced with blend fraction - Spot-light outer cone angle has been changed from half-angle to full-angle - prop\_dynamic entities no longer spawn with physics - General crash fixes and improvements ##### Lua - Lua-defined component members can now be animated - Add "prepared render command buffer" system for issuing multi-threaded render commands - Component member flags can now be specified as strings - Added Component member meta data information - Added function bindings: - asset.find, asset.clear\_unused, asset.normalize\_asset\_name, asset.load, asset.reload, asset.precache, asset.is\_supported\_extension, asset.wait\_until\_loaded, asset.wait\_until\_all\_pending\_jobs\_complete, asset.poll, asset.poll\_all - ents.Entity:GetUri, :GetMemberValue, :SetMemberValue, :DebugPrintComponentProperties - ents.EntityComponent:Log, :GetUri, :GetMemberUri, :GetDynamicMemberIndices, :GetStaticMemberCount, :GetMemberIndices - ents.ModelComponent:ReloadRenderBufferList, :IsDepthPrepassEnabled, :SetDepthPrepassEnabled, :IsAutoLodEnabled, :SetAutoLodEnabled - ents.BaseEnvLightSpotComponent:GetBlendFractionProperty, :GetOuterConeAngleProperty, :GetConeStartOffsetProperty - ents.CameraComponent:GetFocalDistance, :SetFocalDistance, :GetFocalDistanceProperty - ents.PanimaComponent:DebugPrint, :GetCurrentTime, :SetCurrentTime, :GetCurrentTimeFraction, :SetCurrentTimeFraction, :ReloadAnimation - ents.LightComponent:SetLightIntensityType, :SetLightIntensity - ents.ReflectionComponent:GetLocationIdentifier, :GenerateFromEquirectangularImage - ents.LightComponent:IsBaked, :SetBaked - ents.add\_component\_creation\_listener - ents.find\_installed\_custom\_components, ents.get\_registered\_entity\_types - ents.RenderComponent:IsInPvs - ents.TransformComponent:Teleport - ents.WorldComponent:RebuildRenderQueues - ents.ModelComponent:UpdateRenderMeshes - file.is\_empty - debug.render\_mesh - game.get\_number\_of\_scenes\_queued\_for\_rendering, game.get\_queued\_scene\_render\_info, game.set\_gameplay\_control\_camera, game.reset\_gameplay\_control\_camera, game.get\_gameplay\_control\_camera, game.clear\_gameplay\_control\_camera, game.get\_primary\_camera\_render\_mask - geometry.calc\_rect\_circle\_touching\_position - gui.create\_render\_target, gui.create\_color\_image, gui.register\_default\_skin, gui.set\_focus\_enabled, gui.is\_focus\_enabled - game.DrawSceneInfo:AddSubPass - gui.Base:CheckPosInBounds - gui.DropDownMenu:FindOptionIndex - gui.Element:GetRelativePos, :SetLocalAlpha, :GetLocalAlpha, :IsRemovalScheduled, :ResetRotation, :GetRotationMatrix, :SetRotation, :SetStencilEnabled, :IsStencilEnabled, :SetLocalRenderTransform, :ClearLocalRenderTransform, :DrawToTexture, :GetLocalRenderTransform, :AnchorWithMargin, :ClearFocus, :SetParentAndUpdateWindow - gui.Text:GetTextHeight, :UpdateSubLines, :SetMaxLineCount, :GetMaxLineCount - gui.Shape:ClearBuffer, :SetShape, :GetBuffer, :SetBuffer, :GetVertexCount - gui.WIContextMenu:IsPopulated - gui.ProgressBar:SetLabelVisible - input.InputBindingLayer, input.add\_input\_binding\_layer, input.get\_input\_binding\_layers, input.get\_input\_binding\_layer, input.remove\_input\_binding\_layer, input.get\_core\_input\_binding\_layers, input.update\_effective\_input\_bindings, input.get\_effective\_input\_bindings, input.set\_binding\_layer\_enabled, input.is\_binding\_layer\_enabled, input.is\_binding\_layer\_enabled, input.InputBindingLayer:FindBoundKeys - locale.localize - math.snap\_to\_gridf, math.get\_power\_of\_2\_values, math.calc\_bezier\_point - math.Mat4.create\_reflection - math.Quaternion:MirrorAxis - math.Transform:ToPlane, math.Transform:Reflect - math.Vector2:GetAngle, math.Vector:Reflect - Model:GetExtensionData, :GetSubMesh, :FindSubMeshId - Model.Mesh.Sub:GetTriangle, :GetIndexType, :SetIndexType, :AddIndex, :SetIndex, :GetIndex, :HasUvSet, :GetExtensionData, :ReverseIndices, IndexType and MaxIndex enums - Renamed Model.Mesh.Sub:GetTriangles to :GetIndices - panima.Animation.load, :RemoveChannel - panima.Channel:Resize, :GetSize, :SetTime, :SetValue, :ClearValueExpression, :GetValueExpression, :RemoveValue, :FindInterpolationIndices, :FindIndex, :RemoveValueRange, :AddValueRange, :SortValues, :GetInterpolatedValue, :FindIndexRangeInTimeRange - prosper.blur\_texture - prosper.RenderTarget:GetColorAttachmentTexture, :GetDepthStencilAttachmentTexture - prosper.Window:GetMonitorBounds, :Maximize, :IsMaximized - shader.BaseTexturedLit3D:IsDepthPrepassEnabled, :SetDepthPrepassEnabled - table.is\_empty, table.table\_to\_map - util.File:GetSize, util.import\_assets, util.generate\_hair\_file, util.generate\_hair\_data - udm.is\_numeric\_type, is\_generic\_type, is\_non\_trivial\_type, type\_to\_string, get\_numeric\_component, lerp, get\_numeric\_component\_count, is\_vector\_type, is\_matrix\_type, get\_matrix\_row\_count, get\_matrix\_column\_count, is\_array\_type, get\_class\_type, parse - input.is\_ctrl\_key\_down, is\_alt\_key\_down, is\_shift\_key\_down - udm.Array:ToTable, udm.PropertyWrapper:ToTable, :ToAscii - udm.Property:AddValueRange, :RemoveValueRange, :SetValueType, :RemoveValue, :Copy - Material:SetLoaded - Added classes/enums: - util.ThreadPool - util.ZipFile - gui.DrawToTextureInfo - asset.AssetLoadFlags - shader.BindState - Fixed EntityComponent:GetMemberValue, :SetMemberValue not working correctly for some member types - Fixed util.remove not removing all objects in table correctly in some cases - Fixed Lua-defined component members of type string not working correctly ### Version 1.0.2 \[2021-09-13\] ##### Filmmaker v0.4.3 - Added options for animating actor properties - `util_export_asset` command can now export retargeted models - Fixed depth buffer issues if camera nearZ or farZ is set to 0 - Fixed some meshes not being rendered when rendering with Cycles/LuxCoreRender **LuxCoreRender** - Added volumetric lighting options - Added subdivision options for materials - Added option for enabling [PhotonGI cache](https://wiki.luxcorerender.org/PhotonGI) ##### Engine - Added new animation system - Added animation math expression system - Added animation driver system - Added entity component member system - Fixed translucent objects causing depth rendering issues - Fixed eyes\_updown / eyes\_rightleft flex controllers not working correctly - Fixed crash instance when trying to import some Source Engine materials with invalid texture references - Fixed crash instance when importing some Source Engine maps - Fixed issue where some meshes would appear invisible if the actor has a skin > 0 - Fixed textures with format ABGR8888 getting imported with swapped color channels ##### Lua - Added new [Lua API documentation](https://wiki.pragma-engine.com/api/docs) - Added **CompositeComponent:GetEntities, :GetRootGroup, :AddChildGroup, :GetChildGroups** - Added **panima** library - Added **ents.EntityComponent:GetMemberIndex**, **:GetMemberInfo** - Added **util.get\_object\_hash** - Added **ents.UniversalEntityReference**, **ents.UniversalComponentReference** and **ents.UniversalMemberReference** - Added **ents.AnimatedComponent.parse\_component\_channel\_path**, **:ClearPreviousAnimation**, **:ReloadAnimation**, **:AdvanceAnimations** - Added **ents.EntityComponent:GetMemberInfos** - Added **udm.Array:GetArrayType**, **udm.Element:GetArrayValues**, **:SetArrayValues**, **udm.to\_json** - Added type aliases: - Entity components can be used in place of entity arguments on C++ function calls - EulerAngles and Quaternions can be used interchangeably - Vector types can be used interchangeably where applicable ### Version 1.0.1 \[2021-06-22\] ##### Filmmaker v0.4.2 - Improve retargeting performance - Fix various retargeting issues - General retargeting improvements - Update default material hair settings ##### Engine - Added updated Lua documentation and ZeroBrane configuration files - Updated "lua\_help" documentation database - Added "TF2" and "HL1" demo gamemodes - Fixed random crashes on some hardware - Fixed issue where game could freeze permanently during shutdown - Fixed Lua JIT-Compiler not being enabled - Fixed importing glTF models saving material files in wrong location - Fixed exporting maps not working in some cases when the map name has a "." in the name - Fixed crash on startup with certain launch parameters - Fixed automatic asset reloading on asset file change not working - Fixed issue where Steam locations wouldn't get mounted properly on new Steam installations - Added additional crash dump debug information - Transitioned AI-nav file-format to UDM system - Transitioned Lua documentation file-format to UDM system ##### Lua - Added **Skeleton:IsRootBone** string parameter overload - Added **Skeleton:GetBoneHierarchy** - Added **phys.Transform.IDENTITY**, **:GetAngles**, **:SetAngles**, **:GetForward**, **:GetRight**, **:GetUp**, **.x**, **.y**, **.z**, **.pitch**, **.yaw**, **.roll**, **phys.ScaledTransform.IDENTITY** - Added **CompositeComponent:ClearEntities** - Add **EVENT\_UPDATE\_BONE\_POSES** and **EVENT\_ON\_BONE\_POSES\_FINALIZED** animated component events - Added **table.copy** - Added **engine.library\_exists** - Added **ents.PlayerComponent:SetFlashlightEnabled**, **:ToggleFlashlight**, **:IsFlashlightEnabled** - General LuaDoc improvements ### Version 0.9.15 \[2021-05-30\] ##### Filmmaker v0.4.1 - Added console commands: **pfm\_max\_fps**, **pfm\_asset\_icon\_size** - Added bone visualization to retarget editor - Retarget rigs can now be auto-generated from existing rigs if a match can be found - Various retargeting improvements - Fixed "hair" settings in material editor not working - Fixed PFM not showing up in new game menu - Fixed material editor and explorer not working properly ##### Engine - Added console commands: **udm\_validate**, **asset\_clear\_unused**, **asset\_clear\_unused\_textures**, **asset\_clear\_unused\_models**, **asset\_clear\_unused\_materials**, **cache\_version\_target**, **loc\_reload** - Added launch option: **-audio\_api <audioApi>** - Added game mount priority options - Physics engine can now be toggled between **PhysX** and **Bullet** - **Bullet** is now the default physics engine - Audio engine is now implemented as a module (can be changed in options) - Assets are now automatically cleared from memory when not in use - Transition particle system format to UDM - Fixed entities appearing invisible in some cases - Fixed various character animation issues - Fixed character eyes not working correctly if entity is scaled - Fixed issue where models with a "." in the name could not get imported properly - Fixed maps not being rendered if map was compiled without BSP - Fixed crash when generating reflection probes - Fixed crash when loading map with invalid world model - Fixed various crash instances - Fixed various shader/rendering issues ##### Lua - Added **debug.beep** and **debug.print** - Added **phys.CollisionObject:SetAlwaysAwake**, **:IsAlwaysAwake** - Added **math.map\_value\_to\_fraction** and **math.map\_value\_to\_range** - Added **locale.set\_text** - Added **composite** and **animated2** entity components - Added **util.DirectoryChangeListener** class - Added **animation.Channel**, **.Slice**, **.Animation2**, **.Pose**, **.Player** classes - Added **ents.Entity:SetUuid** - Added **ents.RenderComponent:GetRenderModeProperty** - Added **ents.EyeComponent:GetEyePose** - Added **udm.PropertyWrapper:GetChildCount**, :**HasValue** and :**ToAscii** - Added **ents.AnimatedComponent:GetLayeredAnimations**, **:ApplyLayeredAnimations** - Added **game.Model.Animation:GetBoneId** - Added **ents.IteratorFilterModel** - Added **asset.delete**, **.determine\_type\_from\_extension**, **.get\_legacy\_extension, .get\_binary\_udm\_extension, .get\_ascii\_udm\_extension, .determine\_format\_from\_data, .determine\_format\_from\_filename, .matches, .relative\_path\_to\_absolute\_path, .absolute\_path\_to\_relative\_path, .get\_udm\_format\_extension, .get\_asset\_root\_directory, .exists, .find\_file, .is\_loaded** - Added **file.find\_absolute\_path** - Added new overload for **file.remove\_file\_extension** with parameter to specify which extensions to remove - Added **udm.AssetData:SetData** - Added **gui.find\_focused\_window**, **gui.get\_primary\_window**, **gui.find\_window\_under\_cursor**, **gui.get\_base\_elements**, **gui.add\_base\_element** - Added **gui.Element:GetRootElement**, **:GetRootWindow** - Added **shader.BasePbr** base class - Added **prosper.create\_window**, **prosper.WindowCreateInfo** and **prosper.Window** classes - Fixed **ents.Entity:SetEnabled** Lua binding not behaving correctly in certain cases - Scripts loaded with **lua\_exec** and **lua\_exec\_cl** now auto reload when changed (Unless"nocache" argument is set) - **util.register\_class** now defines a default constructor and tostring method - **util.register\_class** now returns class object (or nil) instead of boolean ### Version 0.9.14 \[21-04-16\] ##### Filmmaker - Added animation and flex retargeting system - Transform widget can now be toggled between world/local/view space - Added basic posing and animating capabilities - Improved hair rendering quality with LuxCoreRender - Added hair configuration options to material editor - Added live raytracing preview ##### Engine - Added "util\_export\_asset" option to export assets to Source Engine model/material/texture format with optional fake pbr conversion - Transitioned asset file formats to UDM system - Added console commands: "udm\_convert", "save", "crash", "debug\_render\_memory\_budget" and "debug\_render\_memory\_stats" - Exporting model with glTF exporter now includes additional UV sets (such as lightmap UVs) - Fixed rare random deadlock issue - Added entity UUIDs to uniquely identify entities - Added additional crash dump debug information ##### Lua - Added **asset.get\_supported\_extensions, asset.export\_texture\_as\_vtf, asset.TYPE\_MAP** - Added **ents.GetUuid, ents.AttachableComponent:GetBone** - Added **Quaternion:Distance** - Added class **ents.IteratorFilterUuid** - Added **udm** library - Added **game.get\_material** - Added **util.BSPTree.Node:GetIndex** - Added **game.Material:Reset** - Added **game.Model.Animation.Load**, **game.Model.FlexAnimation.Load** - Added **game.Model.Mesh.Sub:Copy** - Added **game.Model.Animation:GetBoneId** - Added **game.Model.Eyeball:GetUpperLidFlexIndices**, **:GetUpperLidFlexAngles**, **:GetLowerLidFlexIndices**, **:GetLowerLidFlexAngles**, **:GetUpperLidFlexIndex** and **:GetLowerLidFlexIndex** - Added **game.Model.FCOPY\_BIT\_FLEX\_ANIMATIONS** flag - Added **ents.ModelComponent:GetBodyGroups**, **:SetBodyGroups** - Added **ents.AnimatedComponent:GetBaseAnimationFlags**, **:SetBaseAnimationFlags**, **:GetLayeredAnimationFlags**, **:SetLayeredAnimationFlags, ents.AnimatedComponent:SetAnimatedRootPoseTransformEnabled,** **:IsAnimatedRootPoseTransformEnabled, :AddRootPoseBone**, **:SetRootPoseBoneId**, **:GetRootPoseBoneId** and **ents.AnimatedComponent.FPLAYANIM\_LOOP** - Added **ents.LightComponent:SetMorphTargetsInShadowsEnabled**, **:AreMorphTargetsInShadowsEnabled, .BakeSettings.globalLightIntensityFactor** and **.import\_lightmap\_atlas** - Added **ents.ReflectionProbeComponent:GetIBLMaterialFilePath**, **:CaptureIBLReflectionsFromScene** and **:RequiresRebuild** - Added **prosper.ImageCreateInfo:FLAG\_ALLOCATE\_DISCRETE\_MEMORY\_BIT**, **FLAG\_DONT\_ALLOCATE\_MEMORY\_BIT**, **FLAG\_SRGB\_BIT**, **FLAG\_NORMAL\_MAP\_BIT** - Added **prosper.Image:IsSrgb**, **:IsNormalMap**, **:SetSrgb**, **:SetNormalMap** and **:Convert** - Added **prosper.Mesh:ClearBuffers** - Added **ents.LightMapComponent:SetLightmapAtlas** - Added **ents.RenderComponent:ClearBuffers** - Removed **game.Model.Eyeball:GetUpperFlexDesc**, **:GetLowerFlexDesc**, **:GetUpperTarget**, **:GetLowerTarget**, **.lowerLidFlexDesc** and **.upperLidFlexDesc** ### Version 0.9.13 \[2021-03-14\] ##### Filmmaker - Fully integrated LuxCoreRender - Added support for transparent backgrounds/skies when rendering with LuxCoreRender - Added new render tool commands (LuxCoreRender only): - preview: Creates a preview image of what's been rendered so far and opens it in the default image program - pause: Pauses the current render - resume: Resumes the current render - stop: Stops the render and uses what's been rendered so far to generate the final image - suspend: Creates a .rsm-file, which can be used to continue the render at a later date - export: Exports the entire scene in a LuxCoreRender format (including models and textures), which can be used to render it with the [standalone LuxCoreRender program](https://luxcorerender.org/download/) - Fixed issue where importing textures via drag-and-drop would not generate mipmaps ##### Engine - Updated [build instructions](https://github.com/Silverlan/pragma) - Morph targets now affect shadows - Increased bone limit from 512 to 1024 - Added console commands "strip\_weapons" and "cl\_render\_frustum\_culling\_enabled" - Reduced number of entities with unnecessary tick/logic events to improve performance - Characters now blink if no eyeballs are defined in the model, but blink flex controllers exist - Added [UDM](https://github.com/Silverlan/util_udm) data format for unifying asset file formats - Fixed issue where viewmodel entities would use incorrect field of view - Fixed viewmodel not appearing in some cases if viewmodel was changed after weapon was deployed - Changed entity component net event system so net events no longer have to be registered on the server *before* they are registered on the client - Merged cengine with client library and engine with shared ##### Lua - Removed gamemode system and replaced it with gamemode entity components - Allows changing gamemodes on the fly, as well as running multiple different gamemodes at the same time - Added "player" and "gamemode" entity component types (and sub-directories) - All entity components can now have individual tick/logic events instead of relying on the logic component - Added **udm** library for loading/saving/working with udm assets - Added **ents.ModelComponent:GetBodyGroups** and **:SetBodyGroups** - Added **math.Quaternion:Distance** - Added **ents.PhysicsComponent:EnableCollisions**, **:DisableCollisions**, **:SetCollisionsEnabled**, **:SetSimulationEnabled** and **:IsSimulationEnabled** - Added **ents.CharacterComponent:SetMoveController** and **:GetMoveController** - Added **util.DataStream:WriteVertex**, **:ReadVertex** - Added **Vector:GetYaw** and **:GetPitch** - Added **util.generate\_uuid\_v4** - Added **ents.register\_component\_net\_event** - Added **ents.AttachableComponent.FATTACHMENT\_MODE\_FORCE\_TRANSLATION\_IN\_PLACE**, **FATTACHMENT\_MODE\_FORCE\_ROTATION\_IN\_PLACE** and **FATTACHMENT\_MODE\_FORCE\_IN\_PLACE** ### Version 0.9.12 \[2021-02-08\] ##### Filmmaker - Added support for rendering with [**LuxCoreRender**](https://luxcorerender.org/gallery/) - Added fur rendering options with LuxCoreRender ##### Engine - Massive general performance improvements - Added automatic rendering instancing system - Added flex animation system - Added new bloom/glow implementation - Added lightmap baking with Cycles - Added console commands **debug\_render\_octree\_dynamic\_find**, **debug\_render\_stats**, **render\_vsync\_enabled**, **render\_draw\_static**, **render\_draw\_dynamic**, **render\_translucent**, **cl\_render\_shadow\_lod\_bias**, **render\_queue\_worker\_thread\_count**, **debug\_textures**, **sky\_override**, **render\_queue\_entities\_per\_worker\_job**, **render\_queue\_worker\_jobs\_per\_batch**, **render\_instancing\_threshold** and **render\_instancing\_enabled** - Fixed issue where camera would move upwards continuously in fullscreen windowed resolution mode - Fixed first LOD being skipped when importing Source Engine models - Fixed model LODs not working - Fixed various crash bugs - Fixed bone scaling not working correctly in some cases ##### Lua - Added **ents.RenderComponent:GetLocalRenderBounds**, **ents.RenderComponent:GetLocalRenderSphereBounds**, **ents.RenderComponent:GetAbsoluteRenderBounds**, **ents.RenderComponent:GetAbsoluteRenderSphereBounds**, **ents.RenderComponent:SetLocalRenderBounds**, **ents.RenderComponent:ShouldCastShadows**, **ents.RenderComponent:ShouldDraw**, **ents.RenderComponent:ShouldDrawShadow**, **ents.RenderComponent.EVENT\_ON\_RENDER\_MODE\_CHANGED** and **ents.RenderComponent.EVENT\_UPDATE\_INSTANTIABILITY** - Added **util.DataBlock:GetVector2** - Added **game.Material.detail\_blend\_mode\_to\_enum** and **game.Material.DetailBlendMode** enums - Added **ents.SceneComponent:GetRenderQueue**, **ents.SceneComponent:BuildRenderQueue** and **ents.SceneComponent.CreateInfo** - Added **math.Vector:ToScreenUv** - Added **game.set\_default\_game\_render\_enabled**, **game.is\_default\_game\_render\_enabled**, **game.render\_scenes**, **game.set\_debug\_render\_filter** and **game.update\_render\_buffers** - Added **game.RENDER\_FLAG\_TRANSLUCENT\_BIT** - Added **util.ImageBuffer:SwapChannels** - Added **prosper.get\_api\_identifier**, **prosper.get\_api\_abbreviation**, **prosper.wait\_for\_current\_swapchain\_command\_buffer\_completion**, **prosper.create\_primary\_command\_buffer** and **prosper.create\_secondary\_command\_buffer** - Added **prosper.CommandBuffer:Flush** - Added **game.DrawSceneInfo.FLAG\_FLIP\_VERTICALLY\_BIT**, **game.DrawSceneInfo.FLAG\_DISABLE\_RENDER\_BIT** and **game.DrawSceneInfo.flags** - Added classes **game.RenderQueue**, **game.DepthStageRenderProcessor**, **game.LightingStageRenderProcessor**, **shader.GameWorld**, **game.Model.FlexAnimation** and **game.Model.FlexAnimation.Frame** - Added **ents.ModelComponent:SetMaxDrawDistance**, **ents.ModelComponent:GetMaxDrawDistance** and **ents.ModelComponent.EVENT\_ON\_RENDER\_MESHES\_UPDATED** - Added **ents.AnimatedComponent:AreSkeletonUpdateCallbacksEnabled**, **ents.AnimatedComponent:SetSkeletonUpdateCallbacksEnabled**, **ents.AnimatedComponent.EVENT\_ON\_SKELETON\_UPDATED**, **ents.AnimatedComponent.EVENT\_ON\_BONE\_MATRICES\_UPDATED** and **ents.AnimatedComponent.EVENT\_ON\_BONE\_BUFFER\_INITIALIZED** - Added **util.BSPTree:FindLeafNodesInAABB** - Added **ents.LightmapComponent.bake\_lightmaps**, **ents.LightmapComponent:SetExposure**, **ents.LightmapComponent:GetExposure**, **ents.LightmapComponent:GetExposureProperty** and **ents.LightmapComponent.BakeSettings** - Added **ents.FlexComponent:PlayFlexAnimation**, **ents.FlexComponent:StopFlexAnimation**, **ents.FlexComponent:GetFlexAnimationCycle**, **ents.FlexComponent:SetFlexAnimationCycle** and **ents.FlexComponent:SetFlexAnimationPlaybackRate** - Added **game.Model:GetFlexAnimations**, **game.Model:GetFlexAnimationNames**, **game.Model:GetFlexAnimationCount**, **game.Model:AddFlexAnimation**, **game.Model:LookupFlexAnimation**, **game.Model:GetFlexAnimation**, **game.Model:GetFlexAnimationName**, **game.Model:ClearFlexAnimations**, **game.Model:RemoveFlexAnimation**, **game.Model.AddFlexControllerId**, **game.Model.SetFlexControllerValue**, **game.Model.LookupLocalFlexControllerIndex**, **game.Model:GetLOD** and **game.Model.Mesh:RemoveSubMesh** - Added **game.RasterizationRenderer:ReloadPresentationRenderTarget** - Added **file.to\_relative\_path** - Added **geometry.calc\_point\_on\_triangle** and **geometry.calc\_triangle\_area** - **util.save\_image** now has an option for saving cubemap textures - Removed **ents.SceneComponent:PrepareRender**, **ents.TransformComponent:GetPosProperty**, **ents.TransformComponent:GetRotationProperty**, **ents.TransformComponent:GetScaleProperty**, **game.draw\_scene**, **ents.RenderComponent:GetRenderBounds**, **ents.RenderComponent:SetRenderBounds**, **ents.RenderComponent:GetRenderSphereBounds**, **ents.RenderComponent:GetRenderModeProperty**, **ents.RenderComponent:SetDepthBias,** **ents.RenderComponent:GetDepthBias**, **game.DrawSceneInfo.flipVertically** and **ents.RenderComponent.RENDERMODE\_AUTO** - Changed parameters of **ents.SceneComponent:Render** and **ents.RenderComponent:UpdateRenderBuffers** ### Version 0.9.11 \[2020-11-11\] ##### Filmmaker - Cycles render settings are now saved with the project - Changed frame render order when rendering animations with external render tool for easier quality control - Added support for detail maps when rendering with Cycles - Fixed emission textures having no effect when rendering with Cycles - Fixed IOR value being set improperly when opening material in material editor - Fixed material editor not updating properly when switching to a different material - Fixed HDR output format not working properly when rendering with Cycles - Changed default gamma correction value when rendering with Cycles to 2.2 (was 2.4 before) ##### Engine - Added support for **$detail**, **$detailscale**, **$detailblendfactor**, **$detailblendmode** and **$detailtint** VMT parameters - Added CS: GO to default game mount list - Fixed issue where entities with morph target animations would get visually corrupted if they were made invisible and then visible again - Fixed issue where ingame cursor position would mismatch actual cursor position in fullscreen windowed resolution mode - Fixed issue where camera would move upwards continuously in fullscreen windowed resolution mode ##### Lua - Replaced class **game.Scene** with **ents.SceneComponent** - Added **ents.SceneComponent.OcclusionCullingMethod** enums - Added **game.Material.DetailBlendMode** enums - Added **game.Material.detail\_blend\_mode\_to\_enum** - Added **ents.SceneComponent:SetOcclusionCullingMethod** - Added **game.Model:GetBodyGroupMesh** - Added **game.Material:SetShader** - Added **ents.Entity:GetBodyGroup** and **:SetBodyGroup** overloads for body group IDs - Added **ents.BaseEntityComponent:Save**, **ents.BaseEntityComponent:Load** and **ents.BaseEntityComponent:Copy** - Added **ents.Entity:RemoveFromAllScenes** and **ents.Entity:AddChild** - Added **debug.breakpoint** (Only available if `-luaext` was specified in the launch options) - Added **math.Mat4:ApplyProjectionDepthBiasOffset** - Added **ents.RenderComponent:SetReceiveShadows** and **ents.RenderComponent:IsReceivingShadows** - Added **ents.EyeComponent:ClearViewTarget** - Added **util.DataBlock:GetVector2** - Renamed **game.create\_scene** to **ents.create\_scene** - **util.remove** now has a second argument for removing objects safely (if available) - **toboolean** and **toint** now accept numbers and booleans as arguments - Changed parameter order of **ents.create\_prop** ### Version 0.9.10 ##### Filmmaker - Added Cycles option for setting the number of frames to the end of a clip or session - Render jobs now take up a lot less disk space for animations (static geometry is now stored shared instead of every frame) - Slightly improved overall rendering speed - Fixed rendering taking up your entire CPU resources when rendering with your GPU - Fixed an issue where rendering several times consecutively could slow your PC down to a crawl - Fixed VR renders being flipped horizontally - Fixed a denoising issue which caused less than optimal denoising quality - Fixed issue where the tiles in the final image would have mismatching sample counts and some tiles would be lower quality as a result - Fixed render preview not being interactable when rendering VR images - Fixed potential crash when doing a preview render with the Vulkan renderer being used ##### Engine - Minor occlusion culling performance optimizations - Greatly improved reflection probe rendering speed - Fixed issue where entities would get rendered with error materials if their skin would exceed the max skin count of their model - Fixed bone scaling not working correctly - Fixed massive performance hit for light sources that cast shadows in the past, but had shadow casting disabled - Fixed BSP occlusion culling not working for imported Source Engine maps - Fixed meshes not being rendered if entity skin exceeds maximum skin count - Improved lightmap implementation - Various minor bug fixes and improvements - Improved loading times when starting a game ##### Lua - Added class **util.Version** - Added **exec** - Added **ents.create\_prop** - Added **ents.AnimatedComponent:SetBindPose** and **ents.AnimatedComponent:GetBindPose** - Added **ents.LightMapComponent:UpdateLightmapUvBuffers**, **ents.LightMapComponent:ReloadLightmapData** and **ents.LightMapComponent:SetLightmapAtlas** - Added **ents.LightMapReceiverComponent:UpdateLightmapUvData** - Added **gui.Element:InjectMouseClick** and **gui.Element:InjectKeyPress** - Added **ents.Entity:IsDisabled** and **ents.Entity:IsTurnedOff** - Added **util.Path:CreateFilePath** and **util.Path:CreatePath** - Added **ents.MapComponent:GetMapIndex** - Added **ents.AnimatedComponent:PlayAnimation** overloads for playing animations by id - Added **util.DataBlock:ToString** - Added **game.Model.Frame:Copy**, **game.Model.Skeleton.Bone:IsAncestorOf** and **game.Model.Skeleton.Bone:IsDescendantOf** - Added **math.calc\_average\_rotation** - Added **file.strip\_illegal\_filename\_characters** - Added **game.Model.Mesh:GetReferenceId** - Added **game.Model.Mesh.Sub:FlipTriangleWindingOrder**, **:SetVertexCount**, **:SetIndexCount**, **:AddUVSet,** **:GetUVSetNames**, **:SetVertexTangent** and **:HasUVSet** - Added **string.hash** - Added new overload for **game.Model.Mesh.Sub:GetUVs**, **:SetVertexUV**, **:GetVertexUV** with UV set parameter - Changed argument format for **util.pack\_zip\_archive** - Renamed **ents.AnimatedComponent:GetBindPose** to **ents.AnimatedComponent:GetBoneBindPose** - **util.remove** now accepts a table as argument - **file.write** now automatically creates the file path if it doesn't exist - File write operations now accept paths that include "addons/<addonName>/" as prefix # Troubleshooting ### Pragma crashes on startup If Pragma crashes on startup, please ensure that your system fulfills the [system requirements](https://wiki.pragma-engine.com/books/pragma-engine/page/download#bkmrk-%5Bwip%5D) and that your graphics drivers are up to date. If you have multiple GPUs, please make sure to enable your high-default GPU as the default for Pragma. You can follow the instructions [on this page](https://pureinfotech.com/set-gpu-app-windows-10/) to do so. ### There is no text in the main menu Try adding `-graphics_api vulkan` to the launch options in Pragma to switch to the Vulkan renderer: [](https://wiki.pragma-engine.com/uploads/images/gallery/2020-08/firefox_2020-08-21_09-35-29.png) ### I have an AMD GPU and Pragma/PFM crashes on startup This should be fixed in newer versions of PFM, until they are released publicly, you can try this temporary fix: 1. Go to the Pragma root folder 2. Remove the `cache` directory 3. Go to `Pragma/shaders/world/eye/` 4. Rename `fs\_eye.gls` to `fs\_eye\_bak.gls` 5. Launch PFM Character eyes won't be rendered properly in the real-time render viewport, but it shouldn't be freezing anymore. # Mapping # Asset Import / Export ### Export Pragma comes with the following export capabilities: - You can use Pragma to export Source Engine and Source 2 Engine assets for use in modelling programs - Assets in Pragma can be exported in the Source Engine model/material/texture format - Fake PBR can be applied automatically for use in SFM - Automatic generation of ambient occlusion maps (if they don't exist) - Automatic re-scaling of the models to meters - Conversion to match Blender's coordinate system - Includes the rig, all of the animations and morph targets of the model - Conversion to standard normal maps (e.g. if self-shadowed bumpmaps are used) - Conversion of Source 1 assets with PBR settings - Automatic conversion of the textures to png, bmp, tga, jpg, hdr, dds, ktx or vtf - Automatic conversion of the textures to a RMA format - Works with maps / level geometry #### Exporting Assets If you want to export a model or material, the easiest way to do so is via the Filmmaker interface. Simply open the model/material catalog, right click on the model icon, then click "Export asset": [](https://wiki.pragma-engine.com/uploads/images/gallery/2021-04/pragma_2021-04-07_18-38-05.png) If you want to export a different asset type, or need more control, you can use the export command utility instead. To use it, start a game in Pragma first. You can either load a map (which map doesn't matter), or run "map empty" in the console. Once the map has been loaded, you can use the "util\_export\_asset" console command with the following parameters: - **-model** *<modelName>*: Exports the specified model. If a directory is specified, all models within that directory will be exported. - **-texture** *<textureName>*: Exports the specified texture(s). If a directory is specified, all textures within that directory will be exported. - **-material** *<materialName>*: Exports the specified material(s). If a directory is specified, all materials within that directory will be exported. - **-map** *<mapName>*: Exports the specified map(s). If a directory is specified, all maps within that directory will be exported. - **-export\_images** *1/0*: If enabled, all textures of the asset will be converted to the specified image output format and saved alongside the asset. Default: 1 - **-normalize\_texture\_names** *1/0*: If enabled, the exported textures will be renamed according to their type (e.g. "textureName\_normal") and will not keep their original name. Default: 0 - **-image\_format** *png/bmp/tga/jpg/hdr/dds/ktx*: The format to use for exported textures. Default: dds - **-binary** *1/0*: If enabled, the model will be exported in the "glb" format, otherwise "glTF". Default: 0 - **-verbose** *1/0*: If enabled, additional information will be printed to the console during the export. Default: 1 - **-recursive** *1/0*: If enabled and a directory is specified as the asset, all assets from all sub-directories will be exported as well. Default: 0 Models only: - **-export\_animations** *1/0*: If enabled, all animations of the model will be exported as well. This may drastically increase the file size and loading times when importing the model into a modelling program. Default: 1 - **-export\_morph\_targets** *1/0*: If enabled, will export all morph targets (flexes) of the model as well. Default: 1 - **-export\_skinned\_mesh\_data** *1/0*: If disabled, no skeleton, vertex weights or animations will be exported. Default: 1 - **-embed\_animations** *1/0*: If enabled, all of the animations of the model will be embedded in the exported glTF file. When disabled, each animation will be exported as a separate file instead. Default: 1 - **-full\_export** *1/0*: If enabled, body groups of the model will be exported as well. Default: 0 - **-scale** *<scale>*: The value by which to scale the exported meshes. Use 1 to keep the original scale. Use 0.025 to convert the meshes to meters. Default: 0.025 - **-generate\_ao** *1/0*: If enabled, will automatically generate ambient occlusion maps for the model if it doesn't have any. Default: 0 - **-ao\_resolution** *<resolution>*: The resolution to use for the ambient occlusion maps if "generate\_ao" is enabled. Default: 512 - **-ao\_samples** *<samples>*: The number of samples to use for generating the ambient occlusion maps if "generate\_ao" is enabled. Default: 40 - -**ao\_device** *cpu/gpu*: Whether to use the CPU or GPU to generate the ambient occlusion maps if "generate\_ao" is enabled. Default: cpu - **-merge\_meshes\_by\_material** *1/0*: If enabled, all meshes that use the same material will be merged. Default: 1 - **-enable\_extended\_dds** *1/0*: If enabled and the image format is set to dds, will enable support for BC6 and BC7 compression using the DXT10 version of the format. Default: 0 - **-list\_animations** *1/0*: If enabled, the model will not be exported and all available animations of the model will be listed in the console instead. Default: 0 - **-animation** *<animName>*: If specified, only this animation will be exported. - **-format** *glTF/mdl*: The output format for the model. If "mdl" is specified TODO - **-game** *1/0*: Only has an effect if "format" is set to "mdl". TODO - **-preview** *1/0*: If enabled, the model will be shown in the viewport. Default: 0If you want to use Pragma to export Source Engine assets, you generally don't have to copy any of the assets to Pragma, the Engine should be able to locate the assets automatically as long as they're part of one of your installed Source Engine games on Steam.
##### Usage Examples Exporting a material (including textures): ```shell util_export_asset -material "brick/brick_1a" -verbose -image_format png ``` Exporting a texture: ```shell util_export_asset -texture "concrete/concrete_5_floor_3_psd_918fcd2d" -verbose -image_format png ``` Exporting a map: ```shell util_export_asset -map "gm_construct" -verbose -export_images 1 -image_format png -generate_ao 0 -export_animations 0 ``` Exporting a model: ```shell util_export_asset -model "props_2fort/tank001" -verbose -image_format png -generate_ao 0 ``` (Make sure to remove the ".mdl" extension!) Exporting a Source 2 model: ```shell util_export_asset -model "characters/gman/gman" -verbose -image_format png -generate_ao 0 ``` Batch-exporting all models in a directory and all sub-directories: ```shell util_export_asset -model "props_2fort" -verbose -image_format png -generate_ao 0 -recursive 1 ``` ##### Exporting retargeted modelsThis section refers to PFM v0.4.3 and newer and may not be representative of older versions.
It is also possible to export a model with retargeted animations (i.e. export a model with the animations of another model.): [](https://wiki.pragma-engine.com/uploads/images/gallery/2021-09/2021-09-24-21-16-05.gif) To do so, you will have to set up a retarget rig in PFM's retarget editor first: Once you have created the retarget rig, you can use the `-retarget_source` argument in the `util_export_asset` command to export the model with the retargeted animations: ```shell util_export_asset -model "e3assassin" -retarget_source "re5/jv1" -verbose -image_format tga -generate_ao 0 -embed_animations 1 ``` ##### Exporting to Source Engine You can also use the command to export a model **to** the Source Engine .mdl format. To do so, simply set the "format" parameter to "mdl": ```shell util_export_asset -model "props_2fort/tank001" -format "mdl" ```Most of the parameters listed above will have no effect when using the Source Engine mdl-exporter!
This will automatically generate the QC and SMD files for the model, convert the textures to vtf, convert the materials to vmt, as well as automatically compile the model using studiomdl. Pragma will attempt to locate studiomdl automatically, but you can also specify which game's studiomdl should be used: ```shell util_export_asset -model "props_2fort/tank001" -format "mdl" -game "tf2" ``` This will use the studiomdl from TF2. The game name has to match the entry from "Pragma/cfg/mounted\_games.udm" (You can open the file in a text-editor). If the model's materials use PBR, the exporter will also automatically apply fake PBR for use in SFM. All of the model's animations will be included in the Source Engine model as well, however morph targets are currently not supported. ##### Using Pragma to convert models from Blender to Source Converting a model from Blender (or other modelling programs) is very simple. All you have to do is export your model from Blender in either the glTF format, or the glb format and copy the exported file to "Pragma/addons/imported/models". Then use the command above and replace the model name with the name of the glTF/glb file (without the extension). #### Source 2 The approach for Source 2 assets is exactly the same as for Source 1 assets, with the exception of maps. To export a Source 2 map, follow these steps (using Half-Life: Alyx as an example): 1. Open the map's vpk-file (steamapps/common/Half-Life Alyx/game/hlvr/maps) in [GCFScape](https://developer.valvesoftware.com/wiki/GCFScape) 2. Extract all of the files from the vpk to "Pragma/addons/imported/" 3. Run the "util\_export\_asset" command with the asset name pointing to the "vwrld\_c"-file. For example, for the map "a5\_vault", you should use: ```shell util_export_asset -map "a5_vault/world" -verbose -export_images 1 -image_format png -generate_ao 0 ``` ### Import If you want to import a model from Blender (or other modelling programs), all you have to do is export the model in the glTF or glb format and copy the exported file to "Pragma/addons/imported/models". The model should automatically show up in the PFM model catalog and it will automatically get converted (along with the textures) when used. ##### Source Engine / Source 2 If you want to import a model (or material/texture) from Source or Source 2, you generally don't have to do anything. All of your installed Source Engine games (assuming they're installed via Steam) should be automatically detected and mounted by Pragma. In the rare event that this doesn't work, you can try adding the mount path for the game to "Pragma/cfg/mounted\_games.udm". Alternatively you can also simply extract the asset files to "Pragma/addons/imported/models" and "Pragma/addons/imported/materials" respectively. # Console Commands # Variables ##### audio\_api <audioApi> **Type:** String The underlying audio API to use. ##### cache\_version <value> **Type:** String The engine version that the cache files are associated with. If this version doesn't match the current engine version, the cache will be cleared. ##### cache\_version\_target <value> **Type:** String If cache\_version does not match this value, the cache files will be cleared and it will be set to it. ##### cl\_allowdownload <value> **Type:** String ##### cl\_allowupload <value> **Type:** String ##### cl\_audio\_always\_play <value> **Type:** String 0 = Don't play sounds if window isn't focused., 1 = Always play sounds ##### cl\_audio\_hrtf\_enabled <value> **Type:** String Enables or disables Head-related transfer function. ##### cl\_audio\_master\_volume <value> **Type:** String Volume scale for all sounds. ##### cl\_audio\_streaming\_enabled <value> **Type:** String 0 = All sounds will be loaded immediately (= Slower load times), 1 = Some sounds will be loaded over time. (= Sounds might start with a delay) ##### cl\_controller\_axis\_input\_threshold <value> **Type:** String Axis inputs below this threshold will be ignored for regular console commands. ##### cl\_controller\_enabled <value> **Type:** String Enables or disables game controllers / joysticks. ##### cl\_downscale\_imported\_high\_resolution\_rma\_textures 1/0 **Type:** Boolean If enabled, imported high-resolution RMA textures will be downscaled to a more memory-friendly size. ##### cl\_effects\_volume <value> **Type:** String Volume scale for effect sounds (e.g. footsteps, gunshots, explosions, etc.). ##### cl\_flex\_phoneme\_drag <value> **Type:** String Changes the time required for facial phoneme flexes to adapt to new phonemes. ##### cl\_fov <value> **Type:** String Horizontal world field of view. ##### cl\_fov\_viewmodel <value> **Type:** String Horizontal view model field of view. ##### cl\_fps\_decay\_factor <value> **Type:** String How slowly to decay the previous fps. ##### cl\_gpu\_device <value> **Type:** String The unique identifier for the GPU vendor and device to use. If empty (or invalid), the first detected device will be used. Usage: <vendorId,deviceId> ##### cl\_gpu\_timer\_queries\_enabled <value> **Type:** String Enables or disables GPU timer queries for debugging. ##### cl\_gui\_volume <value> **Type:** String Volume scale for sounds emitted by GUI elements. ##### cl\_language <value> **Type:** String Game language. ##### cl\_material\_streaming\_enabled <value> **Type:** String 0 = All materials and textures will be loaded immediately (= Slower load times), 1 = All materials and textures will be loaded over time. (= Black textures until loaded) ##### cl\_max\_fps <value> **Type:** String FPS will be clamped at this value. A value of < 0 deactivates the limit. ##### cl\_mouse\_acceleration <value> **Type:** String Amount of mouse acceleration. 1 = No acceleration. ##### cl\_mouse\_pitch <value> **Type:** String Mouse sensitivity on the pitch axis. Use positive values to invert the axis. ##### cl\_mouse\_sensitivity <value> **Type:** String Scale for the mouse sensitivity. ##### cl\_mouse\_yaw <value> **Type:** String Mouse sensitivity on the yaw axis. ##### cl\_music\_volume <value> **Type:** String Volume scale for music. ##### cl\_physics\_simulation\_enabled <value> **Type:** String Enables or disables physics simulation. ##### cl\_port\_tcp <value> **Type:** String Port used for TCP transmissions. ##### cl\_port\_udp <value> **Type:** String Port used for UDP transmissions. ##### cl\_render\_anti\_aliasing <value> **Type:** String 0 = No Anti Aliasing, 1 = MSAA, 2 = FXAA. ##### cl\_render\_brightness <value> **Type:** String Scene brightness. ##### cl\_render\_contrast <value> **Type:** String Scene contrast. ##### cl\_render\_depth\_of\_field <value> **Type:** String Depth of field scale. ##### cl\_render\_fov <value> **Type:** String Specifies the horizontal field of view. ##### cl\_render\_frustum\_culling\_enabled <value> **Type:** String Enables or disables frustum culling. ##### cl\_render\_fxaa\_edge\_threshold <value> **Type:** String The minimum amount of local contrast required to apply algorithm. ##### cl\_render\_fxaa\_min\_edge\_threshold <value> **Type:** String Trims the algorithm from processing darks. ##### cl\_render\_fxaa\_sub\_pixel\_aliasing\_removal\_amount <value> **Type:** String The amount of sub-pixel aliasing removal. ##### cl\_render\_lod\_bias <value> **Type:** String Model LOD-bias. Higher values means higher LOD-Models will be used at lower distance (=Lower quality). ##### cl\_render\_monitor <value> **Type:** String Which monitor to use in fullscreen mode. ##### cl\_render\_motion\_blur <value> **Type:** String Amount of motion blur. 0 = disabled. ##### cl\_render\_msaa\_samples <value> **Type:** String 1 = MSAAx2, 2 = MSAAx4, 3 = MSAAx8, etc. ##### cl\_render\_occlusion\_culling <value> **Type:** String 0 = Off, 1 = Brute-Force, 2 = CHC++, 3 = Octree, 4 = BSP +Octree ##### cl\_render\_particle\_quality <value> **Type:** String Quality of particle systems. 0 = No particles will be rendered, 1 = Particles will be unlit, 2 = Particles will receive lighting, 3 = Particles will cast shadows. ##### cl\_render\_present\_mode <value> **Type:** String 0 = Immediate, 1 = FIFO, 2 = Mailbox ##### cl\_render\_preset <value> **Type:** String Selected preset in display options. ##### cl\_render\_reflection\_quality <value> **Type:** String Changes the quality of reflections. 0 = Only static reflections, 1 = Dynamic reflections, 2 = Reflections with particle effects. ##### cl\_render\_resolution <value> **Type:** String Changes the internal rendering resolution. If left empty, the resolution will be the same as the window resolution! ##### cl\_render\_shader\_quality <value> **Type:** String Shader quality. The actual effect depends on the shader. 1 = Lowest Quality, 10 = Highest Quality ##### cl\_render\_shadow\_dynamic <value> **Type:** String Turns dynamic shadows on or off. ##### cl\_render\_shadow\_lod\_bias <value> **Type:** String Model LOD-bias for shadows. Higher values means higher LOD-Models will be used at lower distance (=Lower quality). This value is added on top of cl\_render\_lod\_bias! ##### cl\_render\_shadow\_pssm\_split\_count <value> **Type:** String The number of cascades to be used for PSSM. Cannot be 0 or higher than 4. ##### cl\_render\_shadow\_pssm\_update\_frequency\_offset <value> **Type:** String Update frequency for PSSM shadows in frames, relative to 'cl\_render\_shadow\_update\_frequency'. ##### cl\_render\_shadow\_resolution <value> **Type:** String Shadowmap Resolution. Higher resolution equals higher quality shadows, but is also more expensive to render. ##### cl\_render\_shadow\_update\_frequency <value> **Type:** String Update frequency in frames. 0 = Updates every frame, 1 = Updates every second frame, etc. ##### cl\_render\_ssao <value> **Type:** String 1 = Screen space ambient occlusion enabled, 0 = disabled. ##### cl\_render\_texture\_filtering <value> **Type:** String 0 = Nearest Neighbour, 1 = Bilinear Filtering, 2 = Trilinear Filtering, 3 = Antisotropic Filtering x2, 4 = Antisotropic Filtering x4, 5 = Antisotropic Filtering x8, 6 = Antisotropic Filtering x16 ##### cl\_render\_texture\_quality <value> **Type:** String 0 = Minimal, 1 = Low, 2 = Medium, 3 = High, 4 = Very High. ##### cl\_render\_tone\_mapping <value> **Type:** String Changes the tone-mapping algorithm to use. -1 = Use the default, 0 = Gamma correction only, 1 = Reinhard, 2 = Hejil-Richard, 3 = Uncharted, 4 = Aces, 5 = Gran Turismo ##### cl\_render\_vr\_enabled <value> **Type:** String Turns support for virtual reality on or off. ##### cl\_render\_vsync\_enabled <value> **Type:** String Turns vertical sync on or off. ##### cl\_render\_window\_mode <value> **Type:** String 0 = Fullscreen, 1 = Windowed, 2 = Windowed no-border. ##### cl\_show\_fps <value> **Type:** String Displays the current fps at the top left of the screen if enabled. ##### cl\_steam\_audio\_ambisonics\_order <value> **Type:** String The amount of directional detail in the simulation results. Range: \[0,3\]. ##### cl\_steam\_audio\_enabled <value> **Type:** String Enables or disables steam audio. ##### cl\_steam\_audio\_ir\_duration <value> **Type:** String The time delay between a sound being emitted and the last audible reflection. Range: \[0.5,4.0\]. ##### cl\_steam\_audio\_number\_of\_bounces <value> **Type:** String The maximum number of times any ray can bounce within the scene. Range: \[1,32\]. ##### cl\_steam\_audio\_number\_of\_diffuse\_samples <value> **Type:** String The number of directions to consider when a ray bounces off a diffuse (or partly diffuse) surface. Range: \[32,4096\]. ##### cl\_steam\_audio\_number\_of\_rays <value> **Type:** String The number of rays to trace from the listener. Range: \[1024,131072\]. ##### cl\_steam\_audio\_propagation\_delay\_enabled <value> **Type:** String Enables or disables propagation delay if steam audio is enabled. ##### cl\_steam\_audio\_reverb\_enabled <value> **Type:** String Enables the reverb DSP effect. ##### cl\_steam\_audio\_reverb\_indirect\_binaural <value> **Type:** String Spatialize reverb using HRTF. ##### cl\_steam\_audio\_reverb\_simulation\_type <value> **Type:** String Real-time or baked. 0 = Real-time, 1 = Baked. ##### cl\_steam\_audio\_spatialize\_air\_absorption <value> **Type:** String Enable air absorption. ##### cl\_steam\_audio\_spatialize\_direct\_binaural <value> **Type:** String Spatialize direct sound using HRTF. ##### cl\_steam\_audio\_spatialize\_direct\_level <value> **Type:** String Relative level of direct sound. Range: \[0,1\]. ##### cl\_steam\_audio\_spatialize\_distance\_attenuation <value> **Type:** String Enable distance attenuation. If disabled, regular distance attenuation will be used instead. ##### cl\_steam\_audio\_spatialize\_enabled <value> **Type:** String Enables the spatialize DSP effect. ##### cl\_steam\_audio\_spatialize\_hrtf\_interpolation <value> **Type:** String HRTF interpolation. 0 = Nearest, 1 = Bilinear. ##### cl\_steam\_audio\_spatialize\_indirect <value> **Type:** String Enable indirect sound. ##### cl\_steam\_audio\_spatialize\_indirect\_binaural <value> **Type:** String Spatialize indirect sound using HRTF. ##### cl\_steam\_audio\_spatialize\_indirect\_level <value> **Type:** String Relative level of indirect sound. Range: \[0,10\]. ##### cl\_steam\_audio\_spatialize\_occlusion\_method <value> **Type:** String Direct occlusion algorithm. 0 = Raycast, 1 = Partial. ##### cl\_steam\_audio\_spatialize\_occlusion\_mode <value> **Type:** String Direct occlusion and transmission mode. 0 = Off, 1 = On, No Transmission, 2 = On, Frequency Independent Transmission, 3 = On, Frequency Dependent Transmission. ##### cl\_steam\_audio\_spatialize\_simulation\_type <value> **Type:** String Real-time or baked. 0 = Real-time, 1 = Baked ##### cl\_steam\_audio\_spatialize\_static\_listener <value> **Type:** String Uses static listener. ##### cl\_updaterate <value> **Type:** String The amount of times per second user input is being transmitted to the server. ##### cl\_voice\_volume <value> **Type:** String Volume scale for voice (Coming from players and NPCs). ##### cl\_vr\_hmd\_view\_enabled <value> **Type:** String Enables or disables the view for virtual reality (Only works if virtual reality has been enabled in the menu.). ##### cl\_vr\_mirror\_window\_enabled <value> **Type:** String Enables or disables the mirror window for virtual reality (Only works if virtual reality has been enabled in the menu.). ##### cl\_water\_surface\_simulation\_edge\_iteration\_count <value> **Type:** String The more iterations, the more detailed the water simulation will be, but at a great performance cost. ##### cl\_water\_surface\_simulation\_enable\_gpu\_acceleration <value> **Type:** String If enabled, water surfaces will be simulated on the GPU instead of the CPU. This should greatly improve performance in most cases. ##### cl\_water\_surface\_simulation\_spacing <value> **Type:** String Grid spacing for simulating water surfaces. Lower values will result in a more detailed simulation, but at a great performance cost. ##### cl\_window\_resolution <value> **Type:** String Changes the window resolution. ##### debug\_ai\_navigation <value> **Type:** String Displays the current navigation path for all NPCs. ##### debug\_bsp\_lock <value> **Type:** String Locks BSP culling so it doesn't change when the camera moves. ##### debug\_bsp\_nodes <value> **Type:** String Prints and draws various debug information about the binary space partitioning of the level (if available). 1 = Draw leaf of camera location and all visible leaves, 2 = Same, but doesn't update continuously. ##### debug\_hide\_gui 1/0 **Type:** Boolean Disables GUI rendering. ##### debug\_nav\_show\_meshes <value> **Type:** String Shows the navigation mesh for this map. ##### debug\_occlusion\_culling\_freeze\_camera <value> **Type:** String Freezes the current camera position in place for occlusion culling. ##### debug\_particle\_blob\_show\_neighbor\_links <value> **Type:** String Displays the links to adjacent neighbors for blob particles. ##### debug\_physics\_draw <value> **Type:** String Draws various physics information as wireframe. ##### debug\_profiling\_enabled <value> **Type:** String Enables profiling timers. ##### debug\_render\_lock\_render\_command\_buffers <value> **Type:** String Locks the current render command buffers and causes them to not be re-created every frame. ##### debug\_render\_lock\_render\_queues <value> **Type:** String Locks the current render queues and effectively disables the render queue thread. ##### debug\_render\_normals <value> **Type:** String Displays all normals as lines in the world. 0 = Disabled, 1 = Display normals, 2 = Display normals, tangents and bitangents, 3 = Display face normals, 4 = Display tangents, 5 = Display bitangents. ##### debug\_render\_octree\_dynamic\_draw <value> **Type:** String Draws the octree for dynamic objects. ##### debug\_render\_octree\_static\_draw <value> **Type:** String Draws the octree for static world geometry. ##### debug\_steam\_audio\_probe\_boxes <value> **Type:** String Displays the sound probe spheres for the current map. ##### host\_timescale <value> **Type:** String Specifies the timescale. A value of 2 means the game will run at twice the default speed. ##### log\_enabled <value> **Type:** String 0 = Log disabled; 1 = Log errors only; 2 = Log errors and warnings; 3 = Log all console output ##### log\_file <value> **Type:** String The log-file the console output will be logged to. ##### lua\_open\_editor\_on\_error <value> **Type:** String 1 = Whenever there's a Lua error, the engine will attempt to automatically open a Lua IDE and open the file and line which caused the error. ##### net\_graph <value> **Type:** String Displays a graph about current network transmissions. ##### net\_library <netLibrary> **Type:** String The underlying networking library to use for multiplayer games. ##### password <value> **Type:** String Password which will be used for the next connection attempt. ##### phys\_engine <physEngie> **Type:** String The underlying physics engine to use. ##### playername <value> **Type:** String Local player name. ##### rcon\_password <value> **Type:** String Specifies a password which can be used to run console commands remotely on a server. If no password is specified, this feature is disabled. ##### render\_api <renderApi> **Type:** String The underlying rendering API to use. ##### render\_bloom\_amount <value> **Type:** String Number of render passes to use for bloom. ##### render\_bloom\_enabled <value> **Type:** String Enables or disables bloom and glow effects. ##### render\_bloom\_resolution <value> **Type:** String The width for the bloom texture. The height will be calculated using the aspect ratio of the renderer. ##### render\_clear\_scene <value> **Type:** String 0 = Default, 1 = Screen is cleared before scene is rendered. ##### render\_clear\_scene\_color <value> **Type:** String Clear color to use if render\_clear\_scene is set to 1. ##### render\_csm\_max\_distance <value> **Type:** String The maximum distance at which csm shadows are casted. A larger distance means lower quality. ##### render\_debug\_mode 1/0 **Type:** Boolean 0 = Disabled, 1 = Ambient Occlusion, 2 = Albedo Colors, 3 = Metalness, 4 = Roughness, 5 = Diffuse Lighting, 6 = Normals, 7 = Normal Map, 8 = Reflectance, 9 = IBL Prefilter, 10 = IBL Irradiance, 11 = Emission, 12 = Lightmaps, 13 = Lightmap Uvs, 14 = Unlit, 15 = Show CSM cascades, 16 = Shadow Map Depth, 17 = Forward+ Heatmap. ##### render\_draw\_dynamic <value> **Type:** String 1 = Default, 0 = Don't draw props. ##### render\_draw\_glow <value> **Type:** String 1 = Default, 0 = Glow-effects aren't drawn. ##### render\_draw\_particles <value> **Type:** String 1 = Default, 0 = Particles aren't drawn. ##### render\_draw\_scene <value> **Type:** String 1 = Default, 0 = Scene isn't drawn. ##### render\_draw\_sky <value> **Type:** String 1 = Default, 0 = Sky isn't drawn. ##### render\_draw\_static <value> **Type:** String 1 = Default, 0 = Don't draw level geometry. ##### render\_draw\_translucent <value> **Type:** String 1 = Default, 0 = Don't draw translucent objects. ##### render\_draw\_view <value> **Type:** String 1 = Default, 0 = View-Models aren't drawn. ##### render\_draw\_water <value> **Type:** String 1 = Default, 0 = Water isn't drawn. ##### render\_draw\_world <value> **Type:** String 1 = Default, 2 = Wireframe, 0 = Don't draw world. ##### render\_dynamic\_lighting\_enabled 1/0 **Type:** Boolean Enables or disables dynamic lighting. ##### render\_dynamic\_shadows\_enabled 1/0 **Type:** Boolean Enables or disables dynamic shadows. ##### render\_forwardplus\_tile\_size <value> **Type:** String Changes the tile size used for the light culling in forward+. ##### render\_hdr\_max\_exposure <value> **Type:** String Expore will be clamped at this value. Can be overwritten by the map. ##### render\_ibl\_enabled 1/0 **Type:** Boolean Enables or disables image-based lighting. ##### render\_instancing\_enabled 1/0 **Type:** Boolean Enables or disables instanced rendering. ##### render\_instancing\_threshold \[2,inf\] **Type:** UInt32 The threshold at which to start instancing entities if instanced rendering is enabled (render\_instancing\_threshold). Must not be lower than 2! ##### render\_multithreaded\_rendering\_enabled 1/0 **Type:** Boolean Enables or disables multi-threaded rendering. Some renderers (like OpenGL) don't support multi-threaded rendering and will ignore this flag. ##### render\_normalmapping\_enabled <value> **Type:** String 1 = Normal mapping enabled, 0 = disabled. ##### render\_pp\_nightvision <value> **Type:** String Enables or disables night vision. ##### render\_pp\_nightvision\_color\_amplification <value> **Type:** String Amplification factor for pixels with low luminance. ##### render\_pp\_nightvision\_luminance\_threshold <value> **Type:** String Changes the luminance threshold for the night vision post-processing effect. ##### render\_pp\_nightvision\_noise\_texture <value> **Type:** String Noise texture to use for the night vision post-processing effect. ##### render\_queue\_entities\_per\_worker\_job \[1,50\] **Type:** UInt32 Number of entities for each job processed by a worker thread. ##### render\_queue\_worker\_jobs\_per\_batch \[0,10\] **Type:** UInt32 Number of worker jobs to accumulate in a batch before assigning a worker. ##### render\_queue\_worker\_thread\_count \[1,10\] **Type:** UInt32 Number of threads to use for generating render queues. ##### render\_shadow\_quality <value> **Type:** String Shadowmap Quality. This affects the detail of the object shadows that are being rendered ##### render\_technique <value> **Type:** String 0 = Rasterization, 1 = Raytracing ##### render\_texture\_filtering <value> **Type:** String 0 = Nearest-Neighbor, 1 = Bilinear, 2 = trilinear. ##### render\_vsync\_enabled <value> **Type:** String 1 = Vertical sync enabled, 0 = disabled. ##### sh\_lua\_remote\_debugging <value> **Type:** String 0 = Remote debugging is disabled; 1 = Remote debugging is enabled serverside; 2 = Remote debugging is enabled clientside. Cannot be changed during an active game. Also requires the "-luaext" launch parameter. Remote debugging cannot be enabled clientside and serverside at the same time. ##### sh\_mount\_external\_game\_resources <value> **Type:** String If set to 1, the game will attempt to load missing resources from external games. ##### sky\_override <value> **Type:** String Replaces the material for all current skyboxes with the specified material. ##### steam\_steamworks\_enabled <value> **Type:** String Enables or disables steamworks. ##### sv\_acceleration <value> **Type:** String Player acceleration. If this is too low, the player will be unable to reach full movement speed due to friction forces. ##### sv\_allowcslua <value> **Type:** String 1 = Clients can run own clientside scripts, 0 = Custom clientside scripts aren't allowed. ##### sv\_allowdownload <value> **Type:** String Specifies whether clients are allowed to download resources from the server. ##### sv\_allowupload <value> **Type:** String Specifies whether clients are allowed to upload resources to the server (e.g. spraylogos). ##### sv\_cheats <value> **Type:** String Allows clients to run console commands which are marked as cheats if set to 1. ##### sv\_debug\_physics\_draw <value> **Type:** String Draws various serverside physics information as wireframe. ##### sv\_friction <value> **Type:** String Global friction scale. ##### sv\_gamemode <value> **Type:** String Gamemode which should be used when starting a game. ##### sv\_gravity <value> **Type:** String Specifies the default gravity force and direction. Certain entities may overwrite this for themselves. ##### sv\_maxplayers <value> **Type:** String Specifies the maximum amount of players that are allowed to join the server. ##### sv\_noclip\_speed <value> **Type:** String The speed at which players can move in noclip mode. ##### sv\_password <value> **Type:** String Sets a password for the server. No player will be able to join, unless they provide the correct password using the 'password' command. ##### sv\_physics\_simulation\_enabled <value> **Type:** String Enables or disables physics simulation. ##### sv\_player\_air\_move\_scale <value> **Type:** String The scale at which players are still able to move while in the air. 0 = Players can't move until they've landed, 1 = Players can move freely while in the air ##### sv\_port\_tcp <value> **Type:** String TCP port which will be used when starting a server. ##### sv\_port\_udp <value> **Type:** String UDP port which will be used when starting a server. ##### sv\_require\_authentication 1/0 **Type:** Boolean If enabled, clients will have to authenticate via steam to join the server. ##### sv\_restitution <value> **Type:** String Global restitution scale. ##### sv\_servername <value> **Type:** String The server name which will be displayed in the server browser. ##### sv\_tickrate <value> **Type:** String Specifies the tickrate. A higher tickrate means smoother and more reliable physics, but also more data to transmit to clients. Higher values can result in more lag for clients. ##### sv\_timeout\_duration <value> **Type:** String Amount of time until a client is forcibly dropped if no data has been received. ##### sv\_use\_p2p\_if\_available <value> **Type:** String Use a peer-to-peer connection if the selected networking layer supports it. ##### sv\_water\_surface\_simulation\_edge\_iteration\_count <value> **Type:** String The more iterations, the more detailed the water simulation will be, but at a great performance cost. ##### sv\_water\_surface\_simulation\_shared <value> **Type:** String If enabled, water surface simulation will be shared between client and server (Simulation is only performed once). This will only have an effect in single-player or on listen servers. # Commands ##### +attack Triggers the primary fire for the player character's equipped weapon. ##### +attack2 Triggers the secondary fire for the player character's equipped weapon. ##### +attack3 Triggers the tertiary fire for the player character's equipped weapon. ##### +attack4 Triggers the quaternary fire for the player character's equipped weapon. ##### +backward Moves the player character backward while active. ##### +crouch Prompts the player character to crouch. ##### +forward Moves the player character forward while active. ##### +jump Prompts the player character to jump. ##### +left Moves the player character left while active. ##### +reload Triggers the reload for the player character's equipped weapon. ##### +right Moves the player character right while active. ##### +sprint Enables sprinting while moving forward. ##### +turn\_down Continuously turns the player character leftwards. ##### +turn\_left Continuously turns the player character leftwards. ##### +turn\_right Continuously turns the player character leftwards. ##### +turn\_up Continuously turns the player character leftwards. ##### +use Prompts the player character to use whatever is in front of him. ##### +walk Enables walking while moving forward. ##### -attack Triggers the primary fire for the player character's equipped weapon. ##### -attack2 Triggers the secondary fire for the player character's equipped weapon. ##### -attack3 Triggers the tertiary fire for the player character's equipped weapon. ##### -attack4 Triggers the quaternary fire for the player character's equipped weapon. ##### -backward Moves the player character backward while active. ##### -crouch Prompts the player character to crouch. ##### -forward Moves the player character forward while active. ##### -jump Prompts the player character to jump. ##### -left Moves the player character left while active. ##### -reload Triggers the reload for the player character's equipped weapon. ##### -right Moves the player character right while active. ##### -sprint Enables sprinting while moving forward. ##### -turn\_down Continuously turns the player character leftwards. ##### -turn\_left Continuously turns the player character leftwards. ##### -turn\_right Continuously turns the player character leftwards. ##### -turn\_up Continuously turns the player character leftwards. ##### -use Prompts the player character to use whatever is in front of him. ##### -walk Enables walking while moving forward. ##### asset\_clear\_unused Clears all unused assets from memory. ##### asset\_clear\_unused\_materials Clears all unused materials from memory. ##### asset\_clear\_unused\_models Clears all unused models from memory. ##### asset\_clear\_unused\_textures Clears all unused textures from memory. ##### bind Binds a key to a command string. Usage: bind <key> <command> ##### bind\_keys Prints a list of all bindable keys to the console. ##### cl\_debug\_netmessages Prints out debug information about recent net-messages. ##### cl\_entities Prints a list of all current clientside entities in the world. ##### cl\_find Finds similar console commands to whatever was given as argument. ##### cl\_gpu\_timer\_queries\_dump Prints all timer query results to the console. ##### cl\_list Prints a list of all clientside console commands to the console. ##### cl\_send Sends a text message to the server and displays it in the console. Usage: cl\_send <message> ##### cl\_send\_udp Sends a text message to the server via UDP and displays it in the console. Usage: cl\_send\_udp <message> ##### cl\_steam\_audio\_reload\_scene Reloads the steam audio scene cache. ##### clear Clears everything in the console. ##### clear\_cache Clears all of the cached engine files. ##### closeserver Closes the server (if active) and drops all connected clients. ##### connect Attempts to connect to the specified server. Usage: connect <ipV6/ipV4> or connect <steamId> or without arguments to re-try the last attempt. ##### crash Forces the engine to crash. ##### credits Prints a list of developers. ##### debug\_ai\_schedule Prints the current schedule behavior tree for the specified NPC on screen. ##### debug\_ai\_schedule\_print Prints the current schedule behavior tree for the specified NPC. ##### debug\_aim\_info Prints information about whatever the local player is looking at. ##### debug\_audio\_aux\_effect Applies a global DSP effect. Usage: debug\_audio\_aux\_effect <dspName> <gain> ##### debug\_audio\_sounds Prints information about all active server- and clientside sounds to the console. ##### debug\_dump\_shader\_code Dumps the glsl code for the specified shader. ##### debug\_font Displays the glyph map for the specified font. If no arguments are specified, all available fonts will be listed. Usage: debug\_font <fontName> ##### debug\_font\_glyph\_map Displays the glyph map for the specified font. ##### debug\_glow\_bloom Displays the scene glow texture on screen. Usage: debug\_glow\_bloom <1/0> ##### debug\_gui\_cursor Prints information about the GUI element currently hovered over by the cursor. ##### debug\_hdr\_bloom Displays the scene bloom texture on screen. Usage: debug\_hdr\_bloom <1/0> ##### debug\_hitboxes Displays the hitboxes for the entity under the crosshair, or the entity with the given name (If it was specified.). ##### debug\_light\_shadowmap Displays the depth map for the given light on screen. Call without arguments to turn the display off. Usage: debug\_light\_shadowmap <lightEntityIndex> ##### debug\_light\_sources Prints debug information about all light sources in the scene. ##### debug\_lightmaps Displays the lightmaps for the loaded level. ##### debug\_nav\_path\_end Sets an end point for a navigation path. Use debug\_nav\_path\_start to set the start point. The path will be drawn in the scene once both points have been set. ##### debug\_nav\_path\_start Sets a start point for a navigation path. Use debug\_nav\_path\_end to set the end point. ##### debug\_particle\_alpha\_mode Specifies the blend mode arguments for particle systems that use the 'custom' alpha mode. Argument order: <srcColorBlendFactor> <dstColorBlendFactor> <srcAlphaBlendFactor> <dstAlphaBlendFactor> <opColor> <opAlpha>. Blend factor options: zero, one, src\_color, one\_minus\_src\_color, dst\_color, one\_minus\_dst\_color, src\_alpha, one\_minus\_src\_alpha, dst\_alpha, one\_minus\_dst\_alpha, constant\_color, one\_minus\_constant\_color, constant\_alpha, one\_minus\_constant\_alpha, src\_alpha\_saturate, src1\_color, one\_minus\_src1\_color, src1\_alpha, one\_minus\_src1\_alpha Operation options: add, subtract, reverse\_subtract, min, max ##### debug\_pbr\_ibl Displays the irradiance, prefilter and brdf map for the closest cubemap. ##### debug\_prepass Displays prepass buffers to screen. ##### debug\_profiling\_physics\_end Prints physics profiling information for the last simulation step. ##### debug\_profiling\_physics\_start Prints physics profiling information for the last simulation step. ##### debug\_profiling\_print Prints the last profiled times. ##### debug\_render\_depth\_buffer Draws the scene depth buffer to screen. ##### debug\_render\_info Prints some timing information to the console. ##### debug\_render\_memory\_budget Prints information about the current GPU memory budget. ##### debug\_render\_memory\_stats Prints statistics about the current GPU memory usage. ##### debug\_render\_octree\_dynamic\_find Finds the specified entity in the octree for dynamic objects. ##### debug\_render\_octree\_dynamic\_print Prints the octree for dynamic objects to the console, or a file if a file name is specified. ##### debug\_render\_octree\_static\_print Prints the octree for static world geometry to the console, or a file if a file name is specified. ##### debug\_render\_scene Displays scene to screen. ##### debug\_render\_stats Prints information about the next frame. ##### debug\_render\_validation\_error\_enabled Enables or disables the specified validation error. ##### debug\_ssao Displays the ssao buffers to screen. ##### debug\_steam\_audio\_dump\_scene Saves the steam audio scene as OBJ file. ##### debug\_texture\_mipmaps Displays the mipmaps of the given texture. Usage: debug\_texture\_mipmaps <texturePath> ##### debug\_textures Prints information about the currently loaded textures. ##### debug\_water Displays the reflection, refraction and refraction depth map for the given water-entity on screen. Call without arguments to turn the display off. Usage: debug\_light\_water <waterEntityIndex> ##### disconnect Disconnects from the server (if a connection is active), or closes the game if in single player mode. ##### drop Drops the player's active weapon. ##### echo Prints something to the console. Usage: echo <message> ##### ent\_create Creates and spawns a new entity with the given class name at the position in the world the player is looking at. Usage: ent\_create <className> ##### ent\_input Triggers the given input on the specified entity. Usage: ent\_input <entityName/entityClass> <input> ##### ent\_remove Removes the specified entity, or the entity the player is looking at if no argument is provided. Usage: ent\_remove <entityName/className> ##### ent\_scale Changes the scale of the specified entity. Usage: ent\_input <entityName/entityClass> <scale> ##### entities Prints a list of all current serverside entities in the world. ##### exec Executes a config file. Usage exec <fileName> ##### exit Exits the game. ##### find Finds similar console commands to whatever was given as argument. ##### flashlight Toggles the flashlight. ##### fps Prints the current fps to the console. ##### getang Prints the current angles of the local player to the console. ##### getcamang Prints the current angles of the camera to the console. ##### getcampos Prints the current position of the camera. ##### getpos Prints the current position of the local player to the console. ##### give\_ammo Gives the local player the specified ammunition. ##### give\_weapon Gives the local player the specified weapon and deploys it. ##### godmode Toggles god mode. Requires cheats to be enabled (Or single player mode running). ##### heartbeat Instantly sends a heartbeat to the master server. ##### help Find help about a convar/concommand. ##### hurtme Applies the specified amount of damage to self. ##### keymappings Prints a list of all active key bindings to the console. ##### kick Kicks the specified player for the given reason. Usage: kick <playerId/playerName> <reason> ##### list Prints a list of all serverside console commands to the console. ##### list\_maps Prints a list of all available list to the console. ##### listmaps ##### load ##### loc\_reload Reloads all localization files. ##### log Adds the specified message to the engine log. Usage: log <msg>. ##### lua\_compile Opens the specified lua-file and outputs a precompiled file with the same name (And the extension '.clua'). ##### lua\_exec Opens and executes a lua-file on the server. ##### lua\_exec\_cl Opens and executes a lua-file on the client. ##### lua\_help Prints information about the specified function, library or enum (or the closest candiate). Usage: lua\_help <function/library/enum>. ##### lua\_reload\_entities Reloads the scripts for all registered lua entity classes. ##### lua\_reload\_entity Reloads the scripts for the given entity class. Usage: lua\_reload\_entity <className> ##### lua\_reload\_weapon Reloads the scripts for the given weapon class. Usage: lua\_reload\_weapon <className> ##### lua\_reload\_weapons Reloads the scripts for all registered lua weapon classes. ##### lua\_run Runs a lua command on the server lua state. ##### lua\_run\_cl Runs a lua command on the client lua state. ##### lua\_run\_gui Runs a lua command on the GUI lua state. ##### map Loads the given map immediately. Usage: map <mapName> ##### map\_build\_reflection\_probes Build all reflection probes in the map. Use the '-rebuild' argument to clear all current IBL textures first. Use 'debug\_pbr\_ibl' to check the probes after they have been built. ##### map\_rebuild\_lightmaps Rebuilds the lightmaps for the current map. Note that this will only work if the map was compiled with lightmap uvs. ##### nav\_generate Generates a navigation mesh for the current map and saves it as a navigation file. ##### nav\_reload Reloads the navigation mesh for the current map. ##### next\_weapon Switches to the next weapon in the player's inventory. ##### noclip Toggles noclip mode. Requires cheats to be enabled (Or single player mode running). ##### notarget Toggles notarget mode. Requires cheats to be enabled (Or single player mode running). ##### previous\_weapon Switches to the previous weapon in the player's inventory. ##### quit Exits the game. ##### rcon Sends the given command to the server and runs it serverside. Usage: rcon <command> ##### reloadmaterial Reloads the given material (and textures associated with it). Usage: reloadmaterial <materialFile> ##### reloadmaterials Reloads all loaded materials and textures. ##### render\_api\_info Prints information about the current render API to the console. ##### save ##### screenshot Writes the contents of the screen into a .tga-file in 'screenshots/'. The name of the file will start with the map's name, or 'pragma' if no map is loaded. After the name follows an ID which is incremented each time. You can use 'screenshot 1' to take a screenshot without the GUI (Ingame only). ##### setang Changes the angles of the local player. Requires cheats to be enabled. Usage: setang <pitch> <yaw> <roll> ##### setpos Changes the position of the local player. Requires cheats to be enabled. Usage: setpos <x> <y> <z> ##### shader\_list Prints a list of all currently loaded shaders ##### shader\_optimize Uses LunarGLASS to optimize the specified shader. ##### shader\_reload Reloads a specific shader, or all registered shaders if no arguments are given. Usage: shader\_reload <shaderName> ##### sound\_play Precaches and immediately plays the given sound file. Usage: sound\_play <soundFile> ##### sound\_stop Stops all sounds that are currently playing. ##### startserver Starts an internet server. Requires a running game. ##### status Prints information about the current connection to the console. ##### strip\_weapons Strips all weapons from the local player. ##### suicide Commit suicide. ##### sv\_debug\_netmessages Prints out debug information about recent net-messages. ##### sv\_send Sends a text message to all connected clients and displays it in the console. Usage: sv\_send <message> ##### sv\_send\_udp Sends a text message to all connected clients via UDP and displays it in the console. Usage: sv\_send\_udp <message> ##### thirdperson Toggles between first- and third-person mode. ##### toggle Toggles the specified console variable between 0 and 1. ##### toggleconsole Toggles the developer console. ##### udm\_convert Converts a UDM file from binary to ASCII or the other way around. ##### udm\_validate Validates the specified UDM file. ##### unbind Unbinds the given key. ##### unbindall Unbinds all keys. ##### version Prints the current engine version to the console. ##### vk\_dump\_extensions Dumps all available vulkan extensions to 'vk\_extensions.txt'. ##### vk\_dump\_features Dumps all vulkan features to 'vk\_features.txt'. ##### vk\_dump\_format\_properties Dumps all vulkan format properties to 'vk\_format\_properties.txt'. ##### vk\_dump\_image\_format\_properties Dumps all vulkan image format properties to 'vk\_image\_format\_properties.txt'. ##### vk\_dump\_layers Dumps all available vulkan layers to 'vk\_layers.txt'. ##### vk\_dump\_limits Dumps all vulkan limitations to 'vk\_limits.txt'. ##### vk\_dump\_memory\_stats Dumps information about currently allocated GPU memory. ##### vk\_print\_memory\_stats Prints information about currently allocated GPU memory to the console. # Game Mounting Pragma can automatically import assets that can't be found in its native formats from one of the mounted games. The default list of mounted games includes all Valve Source Engine games, as well as a few popular mods, but in some cases you may want to add custom entries. This is currently only possible by editing the list of mounted games in a text-editor manually. To do so, go to "Pragma/cfg" and open "mounted\_games.udm" in a text-editor. Scroll to the end of the file and add the following entry: ``` "If you don't need the filmmaker, you can omit the `--with-pfm --with-all-pfm-modules` arguments, which will significantly reduce the build time and the required amount of disk space.
###### *Linux*Before running the build script, you will have to install the following packages:
```shell # Required for the build script sudo apt-get install python3 # Required for Pragma core sudo apt install build-essential sudo add-apt-repository ppa:savoury1/llvm-defaults-14 sudo apt update sudo apt install clang-14 sudo apt install libstdc++-12-dev sudo apt install libstdc++6 sudo apt-get install patchelf # Required for Vulkan sudo apt-get -qq install -y libwayland-dev libxrandr-dev sudo apt-get install libxcb-keysyms1-dev sudo apt-get install xcb libxcb-xkb-dev x11-xkb-utils libx11-xcb-dev libxkbcommon-x11-dev # Required for GLFW sudo apt install xorg-dev # Required for OIDN sudo apt install git-lfs # Required for Cycles sudo apt-get install subversion # Required for Curl sudo apt-get install libssl-dev sudo apt install libssh2-1 # Required for OIIO sudo apt-get install python3-distutils ``` Once the build script has been completed, you should find the build files in `pragma/build`, and the install files in `pragma/build/install`. The `install` directory should contain everything you need to run Pragma. If you make any code changes to the core engine code, you can build the `pragma-install` target to build them. This will also re-install the binaries. If you make any code changes to a module, you will have to build the module build target first, and then build `pragma-install` afterwards. ### ### Build Customization Running the build-script with the arguments above will build and install Pragma and the Pragma Filmmaker with all dependencies. Alternatively you can also configure the build to your liking with the following parameters:| **Parameter** | **Description** | **Default** |
| `--help` | Display this help | |
| `--generator | The generator to use. | `Visual Studio 17 2022` (On Windows) `Unix Makefiles` (On Linux) |
| `--c-compiler` | \[Linux only\] The C-compiler to use. | `clang-14` |
| `--cxx-compiler` | \[Linux only\] The C++-compiler to use. | `clang++-14` |
| `--with-essential-client-modules <1/0>` | Include essential modules required to run Pragma. | 1 |
| `--with-common-modules <1/0>` | Include non-essential but commonly used modules (e.g. audio and physics modules). | 1 |
| `--with-pfm <1/0>` | Include the Pragma Filmmaker. | 0 |
| `--with-core-pfm-modules <1/0>` | Include essential PFM modules. | 1 |
| `--with-all-pfm-modules <1/0>` | Include non-essential PFM modules (e.g. chromium and cycles). | 0 |
| `--with-vr <1/0>` | Include Virtual Reality support. | 0 |
| `--build <1/0>` | Build Pragma after configurating and generating build files. | 1 |
| `--build-config | The build configuration to use. | `RelWithDebInfo` |
| `--build-directory | Directory to write the build files to. Can be relative or absolute. | `build` |
| `--deps-directory | Directory to write the dependency files to. Can be relative or absolute. | `deps` |
| `--install-directory | Installation directory. Can be relative (to build directory) or absolute. | `install` |
| `--verbose <1/0>` | Print additional debug information. | 0 |
| `--module | Custom modules to install. Use this argument multiple times to use multiple modules. |
Tip: You can use the --rerun option to make the build script re-use the options used in the previous build.
#### Method 2) You can also add the following option when running the build script: