.. toctree::
:hidden:
:maxdepth: 1
:caption: About
about/getting-started
about/launch-options
.. toctree::
:hidden:
:maxdepth: 1
:caption: Asset Manual
assets/asset-bundle-custom-data
assets/asset-bundles
assets/asset-definitions
assets/data-file-format
assets/asset-validation
assets/curated-items
assets/airdrop-asset
assets/animal-asset
assets/animation
assets/character-mesh-replacement
assets/crafting-blacklist-asset
assets/currency-asset
assets/effect-asset
assets/foliage-asset
assets/item-asset/index
assets/layers
assets/level-asset
assets/material-palette-asset
assets/mod-hooks
assets/npc-asset/index
assets/object-asset
assets/outfit-asset
assets/physics-material-asset
assets/redirector-asset
assets/resource-asset
assets/spawn-asset
assets/stereo-song-asset
assets/unity-2018
assets/unity-2019
assets/vehicle-asset
assets/vehicle-physics-profile-asset
assets/vehicle-redirector-asset
assets/weather-asset
assets/zombie-difficulty-asset
.. toctree::
:hidden:
:maxdepth: 1
:caption: Mapping
mapping/charts
mapping/curated-maps
mapping/editor-asset-redirectors
mapping/favorite-searches
mapping/level-batching
mapping/level-config
mapping/manual-object-culling
.. toctree::
:hidden:
:maxdepth: 1
:caption: Servers & Programming
servers/bookmark-host
servers/command-io
servers/debugging-exceptions
servers/dedicated-workshop-update-monitor
servers/fake-ip
servers/game-server-login-tokens
servers/glazier
servers/openmod
servers/port-forwarding
servers/rocket
servers/server-auto-restart
servers/server-codes
servers/server-hosting
servers/server-hosting-rules
servers/server-update-notifications
.. toctree::
:hidden:
:maxdepth: 1
:caption: Data Types
data/built-in-types
data/asset-ptr
data/bitmask
data/color
data/enum/index
data/flag
data/guid
data/master-bundle-ptr
data/rich-text
data/struct/index
data/vector3
Welcome to the official documentation for Unturned's modding and server hosting features! To navigate, use the table of contents in the sidebar or the search function in the top-left corner.
You can find modding features under consideration on this Trello board: Unturned Roadmap. The cards on the board aren't ordered in any particular way. i.e., they do not dictate the order of updates.
Miscellaneous requests and tasks that may pop up take priority over the roadmap, so it may go a while between progress updates. For example, work for curated maps often takes priority. Several high-priority ideas that don't yet have a solid plan, like a crafting revamp, are not listed on the board.
Our earliest modding documentation was available through Steam Guides. Although most of these guides have been superseded by our documentation here, some still contain useful information about Unity setup that we have yet to bring over. The useful guides are:
- Items: Most of the sub-sections about Unity setup are still relevant.
- Vehicles: Information about Unity setup.
- Objects: Information about Unity setup.
- Misc. Assets: Unity setup for animals, effects, and resources.
- Maps: Explaining various features.
- Legacy Spawn Tables: Some notes about how legacy spawn tables interact with spawn table assets.
- Localization
- Creating 3rd-party Modules: Not to be confused with mods or plugins.
- Uploading Mods to the Steam Workshop
- Upgrading from Unity 5 LTS to Unity 2017 LTS: Only relevant for very old mods, but lists the important changes between those two versions.
There are several official video tutorials available, but many of these have gradually become outdated. They do not accurately represent the current modding features available, or may contain incorrect information, but are listed here for completeness:
- Hosting a Dedicated Server on Windows
- Uploading Skins to the Curated Workshop
- Creating Custom Songs
- Quick Overview of First Version of Foliage Upgrade
- Devkit 101 + Landscapes Overview
- Spawn Tables
- Building Models
If you refer to a video tutorial (official or otherwise), we recommend double-checking the information with our written documentation when possible.
PDF and Epub versions of the documentation can be downloaded for offline use.
Anyone can contribute towards the Unturned modding documentation! To submit an issue, visit the GitHub repository. See the README for more details on how to contribute.