# Airship ## Airship - [Welcome to Airship](https://docs.airship.gg/getting-started/readme.md) - [Installing Airship](https://docs.airship.gg/getting-started/installing-airship.md) - [Typescript Overview](https://docs.airship.gg/typescript/typescript-overview.md) - [Airship Components](https://docs.airship.gg/typescript/airshipbehaviour.md) - [Adding Inspector Properties](https://docs.airship.gg/typescript/airshipbehaviour/adding-inspector-properties.md) - [AirshipSingleton](https://docs.airship.gg/typescript/airshipbehaviour/airshipsingleton.md) - [Using Component Decorators](https://docs.airship.gg/typescript/airshipbehaviour/using-component-decorators.md) - [Accessing Other Components](https://docs.airship.gg/typescript/airshipbehaviour/accessing-other-components.md) - [Lifecycles](https://docs.airship.gg/typescript/airshipbehaviour/lifecycles.md): AirshipBehaviours share many of the Unity MonoBehaviour lifecycle methods. - [Airship Scriptable Objects](https://docs.airship.gg/typescript/airship-scriptable-objects.md) - [Server-only/Client-only code](https://docs.airship.gg/typescript/server-only-client-only-code.md): How to strip code from the server or client, making code server or client only. - [Compiler JSDoc Modifiers](https://docs.airship.gg/typescript/compiler-jsdoc-modifiers.md) - [Multiplayer](https://docs.airship.gg/networking/multiplayer.md) - [Local Server Mode](https://docs.airship.gg/networking/local-server-mode.md) - [Network Signals](https://docs.airship.gg/networking/network-signals.md) - [Network Identity](https://docs.airship.gg/networking/network-identity.md) - [Network Transform](https://docs.airship.gg/networking/network-transform.md) - [Network Functions](https://docs.airship.gg/networking/network-functions.md) - [AirshipNetworkBehaviour](https://docs.airship.gg/networking/airshipnetworkbehaviour.md) - [Lifecycle Events](https://docs.airship.gg/networking/airshipnetworkbehaviour/lifecycle-events.md) - [ServerRpc](https://docs.airship.gg/networking/airshipnetworkbehaviour/serverrpc.md) - [ObserversRpc](https://docs.airship.gg/networking/airshipnetworkbehaviour/observersrpc.md) - [TargetRpc](https://docs.airship.gg/networking/airshipnetworkbehaviour/targetrpc.md) - [Create Dashboard - Game CMS](https://docs.airship.gg/publishing/create-dashboard-game-cms.md) - [Game Visibility](https://docs.airship.gg/publishing/create-dashboard-game-cms/game-visibility.md) - [Game Loading Screens](https://docs.airship.gg/publishing/create-dashboard-game-cms/game-loading-screens.md) - [Publish Game](https://docs.airship.gg/publishing/publish-game.md) - [Publishing with API Key](https://docs.airship.gg/publishing/publishing-with-api-key.md) - [What is the Core Package?](https://docs.airship.gg/core-package/what-is-the-core-package.md) - [Chat Commands](https://docs.airship.gg/core-package/chat-commands.md): Quickly run code from the chat window - [Proximity Prompts](https://docs.airship.gg/core-package/proximity-prompts.md) - [Inventory](https://docs.airship.gg/core-package/inventory.md): Airship has a built-in networked inventory system that is useful for quickly prototyping games. - [VoxelWorld](https://docs.airship.gg/core-package/voxelworld.md) - [Voxel World Getting Started](https://docs.airship.gg/core-package/voxelworld/voxel-world-getting-started.md): How to setup a voxel world and our suggested best practices - [Voxel World Tips](https://docs.airship.gg/core-package/voxelworld/voxel-world-tips.md) - [Prefab Voxels](https://docs.airship.gg/core-package/voxelworld/prefab-voxels.md) - [QuarterBlocks](https://docs.airship.gg/core-package/voxelworld/quarterblocks.md): Quarterblocks are a feature of VoxelWorld that allows you to have "beveled blocks". - [Enable / Disable Core Features](https://docs.airship.gg/core-package/enable-disable-core-features.md): To easily configure your project you can add the CharacterConfigSetup component to any game object in your scene. - [Developer Console](https://docs.airship.gg/core-package/developer-console.md) - [Data Store](https://docs.airship.gg/platform-services/data-store.md) - [Locking](https://docs.airship.gg/platform-services/data-store/locking.md) - [Cache Store](https://docs.airship.gg/platform-services/cache-store.md) - [Leaderboards](https://docs.airship.gg/platform-services/leaderboards.md) - [Platform Inventory](https://docs.airship.gg/platform-services/platform-inventory.md) - [Server Management](https://docs.airship.gg/platform-services/server-management.md) - [Server List](https://docs.airship.gg/platform-services/server-list.md) - [Server Transfers](https://docs.airship.gg/platform-services/server-transfers.md) - [Server Messaging](https://docs.airship.gg/platform-services/server-messaging.md) - [Users](https://docs.airship.gg/platform-services/users.md) - [Parties](https://docs.airship.gg/platform-services/parties.md) - [Matchmaking](https://docs.airship.gg/platform-services/matchmaking.md): Matchmaking Platform Documentation - [External Services](https://docs.airship.gg/platform-services/external-services.md) - [Extending the editor](https://docs.airship.gg/editor-extensions/extending-the-editor.md) - [Custom Inspectors (C#)](https://docs.airship.gg/editor-extensions/custom-inspectors-c.md) - [Displaying properties of other components](https://docs.airship.gg/editor-extensions/custom-inspectors-c/displaying-properties-of-other-components.md) - [Editor API (C#)](https://docs.airship.gg/editor-extensions/editor-api-c.md) - [Quick Overview](https://docs.airship.gg/unity-for-airship/quick-overview.md): A brief breakdown of how Airship games are built - [DataType Math](https://docs.airship.gg/unity-for-airship/datatype-math.md) - [Random](https://docs.airship.gg/unity-for-airship/random.md) - [Resources Folder](https://docs.airship.gg/unity-for-airship/resources-folder.md) - [Physics Settings](https://docs.airship.gg/unity-for-airship/physics-settings.md) - [Physics Layers](https://docs.airship.gg/unity-for-airship/physics-layers.md): How to work with Unity Game Object layers in Airship - [Animation Events](https://docs.airship.gg/unity-for-airship/animation-events.md): Create and capture animation events to run functions in code when your animation hits a specific location. - [User Input](https://docs.airship.gg/unity-for-airship/user-input.md) - [Actions](https://docs.airship.gg/unity-for-airship/user-input/actions.md) - [Keyboard](https://docs.airship.gg/unity-for-airship/user-input/keyboard.md) - [Mouse](https://docs.airship.gg/unity-for-airship/user-input/mouse.md) - [Easy Helper Utils](https://docs.airship.gg/unity-for-airship/easy-helper-utils.md): There are several components and scripts that can be helpful when creating your own games. Here is a general break down of several of them. - [Material Color URP](https://docs.airship.gg/unity-for-airship/easy-helper-utils/material-color-urp.md): Set the color of a material - [Easy Motion](https://docs.airship.gg/unity-for-airship/easy-helper-utils/easy-motion.md): A c# component that allows you to quickly animate a Transform. Works with linear motion or Sine motion. - [Easy Grid Align](https://docs.airship.gg/unity-for-airship/easy-helper-utils/easy-grid-align.md): A c# component that allows you to quickly align multiple transforms in multiple axis. - [Easy Look At](https://docs.airship.gg/unity-for-airship/easy-helper-utils/easy-look-at.md): A c# component that allows you to quickly aim a Transform at another Transform - [Easy Shake](https://docs.airship.gg/unity-for-airship/easy-helper-utils/easy-shake.md): A c# component that shakes a transform. - [Easy Destroy](https://docs.airship.gg/unity-for-airship/easy-helper-utils/easy-destroy.md): A c# component that destroys or disables the GameObject it is on - [Unity Asset Store](https://docs.airship.gg/unity-asset-store.md) - [Import a Package](https://docs.airship.gg/packages/import-a-package.md): Airship packages are bundles of assets that can be imported into your project. This allows reuse of code, artwork and sounds. - [Creating a Package](https://docs.airship.gg/packages/creating-a-package.md) - [Editing a Package](https://docs.airship.gg/packages/editing-a-package.md) - [Common Packages](https://docs.airship.gg/packages/common-packages.md) - [Character System](https://docs.airship.gg/characters/character-system.md) - [Spawning Characters](https://docs.airship.gg/characters/character-system/spawning-characters.md) - [Custom Character](https://docs.airship.gg/characters/character-system/quick-configuration.md): Quickly get a custom character prefab working in your scene. - [First Person Viewmodel](https://docs.airship.gg/characters/character-system/first-person-viewmodel.md): How to setup first person animations - [Player System](https://docs.airship.gg/characters/player-system.md) - [Character Movement System](https://docs.airship.gg/characters/character-movement-system.md): How to work with Airships core character movement system - [Character Movement Hierarchy](https://docs.airship.gg/characters/character-movement-system/character-movement-hierarchy.md) - [Character Movement Physics](https://docs.airship.gg/characters/character-movement-system/character-movement-physics.md) - [Character Movement Data](https://docs.airship.gg/characters/character-movement-system/character-movement-data.md): Details on the exposed variables on CharacterMovementData - [Character Movement Events](https://docs.airship.gg/characters/character-movement-system/character-movement-events.md) - [Character Movement Networking](https://docs.airship.gg/characters/character-movement-system/character-movement-networking.md): The core multiplayer movement system supports Client Authoritative and Server Authoritative movement. The default movement networking mode is Client Authoritative. - [Server Authoritative Movement](https://docs.airship.gg/characters/character-movement-system/character-movement-networking/server-authoritative-movement.md): How to use Server Authoritative Movement. - [Architecture](https://docs.airship.gg/characters/character-movement-system/character-movement-networking/server-authoritative-movement/architecture.md): An overview of how server authoritative character networking works and the associated tools you can use to modify the character behavior. - [Predicted Command Manager](https://docs.airship.gg/characters/character-movement-system/character-movement-networking/server-authoritative-movement/predicted-command-manager.md): How to utilize the predicted command manager to easily create server authoritative commands with client prediction. - [Lag Compensation](https://docs.airship.gg/characters/character-movement-system/character-movement-networking/lag-compensation.md): Performing lag compensated checks using Airship's Character Networking. - [Character Camera](https://docs.airship.gg/characters/character-camera.md) - [Custom Camera Mode](https://docs.airship.gg/characters/character-camera/custom-camera-mode.md) - [Character Animations](https://docs.airship.gg/characters/character-animations.md) - [Character Rig Download](https://docs.airship.gg/characters/character-animations/character-blender-animations.md): This page contains a download of the Airship Character Rig so you can animate in tools like Blender. - [Character Ragdoll](https://docs.airship.gg/characters/character-animations/character-ragdoll.md): Quick toggling of ragdoll physics for characters - [Accessories Intro](https://docs.airship.gg/accessories/accessories-intro.md): Accessories are objects that attach to Airship Characters. - [Creating Accessories](https://docs.airship.gg/accessories/creating-accessories.md) - [Using Accessories](https://docs.airship.gg/accessories/using-accessories.md): In code accessories are managed by the AccessoryBuilder. The accessory builder places items into slots and runs the MeshCombine to optimize the character with its new look. - [Using Accessory Customization](https://docs.airship.gg/accessories/using-accessory-customization.md): Accessories can have special customization data that users can modify per outfit - [Live Game Profiler](https://docs.airship.gg/optimization/live-game-profiler.md) - [Reducing Bundle Size](https://docs.airship.gg/optimization/reducing-bundle-size.md) - [FAQ](https://docs.airship.gg/other/faq.md) - [JavaScript -> Luau](https://docs.airship.gg/other/javascript-greater-than-luau.md): Equivalent JavaScript functions/libraries in the Airship Luau ecosystem. - [Airship on Linux](https://docs.airship.gg/other/airship-on-linux.md) - [Tutorial - Build Your First Game](https://docs.airship.gg/guides/tutorial-build-your-first-game.md): The Hello World of Airship Games - [Tutorial - Top Down Battle!](https://docs.airship.gg/guides/tutorial-top-down-battle.md) - [Project Setup](https://docs.airship.gg/guides/tutorial-top-down-battle/project-setup.md): Get your game running - [Spawn a Player Character](https://docs.airship.gg/guides/tutorial-top-down-battle/spawn-a-player-character.md): Now lets get a player running around our scene - [Custom Camera](https://docs.airship.gg/guides/tutorial-top-down-battle/custom-camera.md): Now we need a camera that will follow around the player - [VoxelWorld Level Generation](https://docs.airship.gg/guides/tutorial-top-down-battle/voxelworld-level-generation.md): Generate our level design through code using VoxelWorld - [AI Enemies](https://docs.airship.gg/guides/tutorial-top-down-battle/ai-enemies.md): Spawn an enemy on the map, and have the enemy move towards the players, and damage the player on collision. --- # 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, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.airship.gg/getting-started/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.