# FPS Framework

## FPS Framework

- [Welcome!](https://akila.gitbook.io/fps-framework/get-started/welcome.md): Welcome to the FPS Framework's official documentation! This document will teach you how to use each part of the asset in detail!
- [Setup](https://akila.gitbook.io/fps-framework/get-started/setup.md): Basic unity setup and installation process of the package!
- [RP Conversions](https://akila.gitbook.io/fps-framework/tutorials/rp-conversions.md): A guide to convert to or from any RP using FPSF.
- [Character](https://akila.gitbook.io/fps-framework/tutorials/character.md): A detailed guide on how to use each component for the character
- [First-Person Controller](https://akila.gitbook.io/fps-framework/tutorials/character/first-person-controller.md): A basic character controller based on Unity's Character Controller
- [Inventory](https://akila.gitbook.io/fps-framework/tutorials/character/inventory.md): A basic inventory system based on IInventory interface.
- [Firearm](https://akila.gitbook.io/fps-framework/tutorials/character/firearm.md): A detailed guide on how to use the firearm system.
- [Basics](https://akila.gitbook.io/fps-framework/tutorials/character/firearm/basics.md): A detailed guide on how to setup the firearm using its wizard.
- [Advanced](https://akila.gitbook.io/fps-framework/tutorials/character/firearm/advanced.md): The full details for everything related to the firearm and how to use it.
- [Other](https://akila.gitbook.io/fps-framework/tutorials/character/firearm/other.md): Everything else related to the firearm.
- [Spray pattern](https://akila.gitbook.io/fps-framework/tutorials/character/firearm/other/spray-pattern.md): A scriptable object that represents the spray pattern of the firearm.
- [Attachment System](https://akila.gitbook.io/fps-framework/tutorials/character/firearm/other/attachment-system.md): A detailed guide on how to use the attachment system.
- [Projectile System](https://akila.gitbook.io/fps-framework/tutorials/character/firearm/other/projectile-system.md): A detailed guide on how to use the projectile system.
- [Explosive](https://akila.gitbook.io/fps-framework/tutorials/character/explosive.md): A detailed guide on how to use and setup the explosive.
- [Systems](https://akila.gitbook.io/fps-framework/tutorials/systems.md): A detailed guide on how to use all the tools.
- [Audio System](https://akila.gitbook.io/fps-framework/tutorials/systems/audio-system.md): A system that manages your sounds based on Unity's audio system.
- [Animation System](https://akila.gitbook.io/fps-framework/tutorials/systems/animation-system.md): A procedural system that makes creating smooth and fluid animations easier than ever.
- [Interactions](https://akila.gitbook.io/fps-framework/tutorials/systems/interactions.md): An advanced interactions system based based on interfaces.
- [Pickable](https://akila.gitbook.io/fps-framework/tutorials/systems/interactions/pickable.md): A component responbile for handling pickable items.
- [Save System](https://akila.gitbook.io/fps-framework/tutorials/systems/save-system.md): A basic save system based on unity's JsonUtility
- [Settings System](https://akila.gitbook.io/fps-framework/tutorials/systems/settings-system.md): An advanced settings system based on Reflection
- [Tools](https://akila.gitbook.io/fps-framework/tutorials/tools.md): The given simple tools to speed up development by a bit
- [Extension Methods](https://akila.gitbook.io/fps-framework/tutorials/tools/extension-methods.md): All Extension Methods available by default in FPS Framework
- [UI](https://akila.gitbook.io/fps-framework/tutorials/ui.md): A detailed guide on how to use each UI component.
- [FPS Counter](https://akila.gitbook.io/fps-framework/tutorials/ui/fps-counter.md): A basic FPS counter.
- [Get Name](https://akila.gitbook.io/fps-framework/tutorials/ui/get-name.md): A component responsible for updating text from transform.name
- [Image Size Fitter](https://akila.gitbook.io/fps-framework/tutorials/ui/image-size-fitter.md): A detailed guide on how to use the image fitter component.
- [Introduction](https://akila.gitbook.io/fps-framework/get-started-pro-only/introduction.md): A small intro for Pro version of FPS Framework
- [Setup](https://akila.gitbook.io/fps-framework/get-started-pro-only/setup.md): A small guide on how to setup FPSF Pro.
- [Hosting](https://akila.gitbook.io/fps-framework/get-started-pro-only/hosting.md)
- [Character](https://akila.gitbook.io/fps-framework/tutorials-pro-only/character.md)
- [First-Person Controller](https://akila.gitbook.io/fps-framework/tutorials-pro-only/character/first-person-controller.md)
- [Inventory](https://akila.gitbook.io/fps-framework/tutorials-pro-only/character/inventory.md)
- [Firearm](https://akila.gitbook.io/fps-framework/tutorials-pro-only/character/firearm.md)
- [Systems](https://akila.gitbook.io/fps-framework/tutorials-pro-only/systems.md): A detailed guide on how to use all the tools for Pro asset.
- [Interactions Manager](https://akila.gitbook.io/fps-framework/tutorials-pro-only/systems/interactions-manager.md)
- [Pickable](https://akila.gitbook.io/fps-framework/tutorials-pro-only/systems/interactions-manager/pickable.md)
- [Server Discovery](https://akila.gitbook.io/fps-framework/tutorials-pro-only/systems/server-discovery.md)
- [Full Change Log](https://akila.gitbook.io/fps-framework/other/full-change-log.md): All development years with their full data
- [2026 Change Log](https://akila.gitbook.io/fps-framework/other/full-change-log/2026-change-log.md)
- [2025 Change Log](https://akila.gitbook.io/fps-framework/other/full-change-log/2025-change-log.md): All 2025 updates and their change logs
- [2024 Change Log](https://akila.gitbook.io/fps-framework/other/full-change-log/2024-change-log.md): All 2024 updates and their change logs
- [2023 Change Log](https://akila.gitbook.io/fps-framework/other/full-change-log/2023-change-log.md): All 2023 updates and their change logs
- [2022 Change Log](https://akila.gitbook.io/fps-framework/other/full-change-log/2022-change-log.md): All 2022 updates and their change logs