> For the complete documentation index, see [llms.txt](https://sneakykittygamedev.gitbook.io/skgsfdocs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sneakykittygamedev.gitbook.io/skgsfdocs/readme.md). # SKG Shooter Framework The SKG Shooter Framework is a set of components for building first and third person shooters in Unreal Engine. Add the components to your pawn, firearms and attachments, and they handle aiming, sway, recoil, poses, attachments, optics, lights and lasers, night vision, thermal and more. Everything is replicated for multiplayer. It isn't limited to firearms. Anything you hold can use the procedural animation, such as a flashlight, a rock, or your character's own fists. These docs are for version 2.0.0. ## Getting started Start with [Project Setup](/skgsfdocs/getting-started/project-setup.md) to add the framework to your project. The example project has everything in these docs set up so feel free to use it as a reference. Follow these in order: 1. [Project Setup](/skgsfdocs/getting-started/project-setup.md) 2. [Developer Settings](/skgsfdocs/getting-started/developer-settings.md): your mesh forward axis, collision channels and material parameter collection. 3. [Setting up a pawn](/skgsfdocs/setup-guides/setting-up-a-pawn.md) 4. [Setting up the animation blueprint](/skgsfdocs/setup-guides/setting-up-the-animation-blueprint.md) 5. [Setting up a firearm](/skgsfdocs/setup-guides/setting-up-a-firearm.md) 6. [Setting up attachments](/skgsfdocs/setup-guides/setting-up-attachments.md), if you use the attachment system. Then use the guides for what your game needs: * Optics: [Setting up a red dot](/skgsfdocs/setup-guides/setting-up-a-red-dot.md) and [Setting up a magnified optic](/skgsfdocs/setup-guides/setting-up-a-magnified-optic.md) * Attachments: [Setting up a handguard and forward grip](/skgsfdocs/setup-guides/setting-up-a-handguard-and-forward-grip.md), [Setting up a muzzle device](/skgsfdocs/setup-guides/setting-up-a-muzzle-device.md), [Setting up a light and laser](/skgsfdocs/setup-guides/setting-up-a-light-and-laser.md) and [Gameplay tag attachment compatibility](/skgsfdocs/setup-guides/gameplay-tag-attachment-compatibility.md) * [Setting up night vision](/skgsfdocs/setup-guides/setting-up-night-vision.md) * [Holding other items](/skgsfdocs/setup-guides/holding-other-items.md), such as a flashlight * Animation: [Creating a custom pose](/skgsfdocs/setup-guides/creating-a-custom-pose.md) and [Performing animations](/skgsfdocs/setup-guides/performing-animations.md) ## Components Every component has its own page in the sidebar, with each of its settings, functions and events. [Using the framework](/skgsfdocs/getting-started/using-the-framework.md) covers how they connect and which one to call. ## Other * [Data Assets](/skgsfdocs/getting-started/data-assets.md): Optional templates for sharing settings between Blueprints. * [Multiplayer](/skgsfdocs/getting-started/multiplayer.md): What's sent to other players and what stays local. * [Projectiles](/skgsfdocs/systems/projectiles.md): An optional, simple projectile system for firing bullets. * [Physical Materials](/skgsfdocs/systems/physical-materials.md): Optional surface effects for footsteps and bullet impacts. * [Troubleshooting](/skgsfdocs/getting-started/troubleshooting.md): Common problems and what to check. * [Updating to 2.0.0](/skgsfdocs/getting-started/updating-to-2-0-0.md): For projects that used the framework before 2.0.0. ## Modules The plugin is split into modules. If you use the framework from C++, add the ones you need to your Build.cs. | Module | Contains | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | SKGShooterFramework | [SKGShooterPawnComponent](/skgsfdocs/components/skgshooterpawncomponent.md), [SKGFirearmComponent](/skgsfdocs/components/skgfirearmcomponent.md), [SKGCharacterMovementComponent](/skgsfdocs/components/skgcharactermovementcomponent.md) and the anim instance | | SKGShooterFrameworkCore | The SKG Shooter Framework developer settings and the infrared world subsystem used by the other modules | | SKGProceduralAnim | [SKGProceduralAnimComponent](/skgsfdocs/components/skgproceduralanimcomponent.md) and [SKGOffhandIKComponent](/skgsfdocs/components/skgoffhandikcomponent.md) | | SKGAttachment | [SKGAttachmentComponent](/skgsfdocs/components/skgattachmentcomponent.md) and [SKGAttachmentManagerComponent](/skgsfdocs/components/skgattachmentmanagercomponent.md) | | SKGOptic | [SKGOpticComponent](/skgsfdocs/components/skgopticcomponent.md) and [SKGOpticSceneCaptureComponent](/skgsfdocs/components/skgopticscenecapturecomponent.md) | | SKGMuzzle | [SKGMuzzleComponent](/skgsfdocs/components/skgmuzzlecomponent.md) | | SKGLightLaser | [SKGLightLaserComponent](/skgsfdocs/components/skglightlasercomponent.md) and [SKGInfraredHandlerComponent](/skgsfdocs/components/skginfraredhandlercomponent.md) | | SKGNightVision | [SKGNightVisionComponent](/skgsfdocs/components/skgnightvisioncomponent.md) | | SKGTemperature | [SKGObjectTemperatureComponent](/skgsfdocs/components/skgobjecttemperaturecomponent.md) | | SKGRangeFinder | [SKGRangeFinderComponent](/skgsfdocs/components/skgrangefindercomponent.md) | | SKGStock | [SKGStockComponent](/skgsfdocs/components/skgstockcomponent.md) | | SKGStats | [SKGFirearmAttachmentStatComponent](/skgsfdocs/components/skgfirearmattachmentstatcomponent.md) | | SKGProjectile | The projectile system, see [Projectiles](/skgsfdocs/systems/projectiles.md) | | SKGPhysicalMaterialModule | SKGPhysicalMaterial for surface impact and footstep effects, see [Physical Materials](/skgsfdocs/systems/physical-materials.md) | | SKGAnimGraphNodes | The Gameplay Tag Blend anim graph node | | SKGShooterFrameworkActors | SKGBaseActor, an actor with gameplay tags, and other base actor classes | | SKGShooterFrameworkEditor | Editor tools | | SKGOptional | An example character class. Can be ignored | ## Support Ask questions and get help on the [Discord](https://discord.gg/W5g6pZXfjh). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://sneakykittygamedev.gitbook.io/skgsfdocs/readme.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.