Unturned Documentation ====================== .. Below is the table-of-content tree for the website, which is hidden from the page but appears in the sidebar. ... The toctree is located at the top of this file, so that chapters are generated properly for the offline downloads. .. toctree:: :hidden: :maxdepth: 1 :caption: About about/getting-started about/launch-options about/steam-workshop .. toctree:: :hidden: :maxdepth: 1 :caption: Introduction to Modding assets/asset-bundles assets/asset-definitions assets/data-file-format assets/asset-validation assets/asset-bundle-custom-data assets/curated-items assets/animation assets/layers assets/mod-hooks assets/unity-upgrade .. toctree:: :hidden: :maxdepth: 1 :caption: Creating Items :glob: items/introduction items/blueprints items/actions items/* .. toctree:: :hidden: :maxdepth: 1 :caption: Creating Vehicles assets/vehicle-asset assets/vehicle-physics-profile-asset assets/vehicle-redirector-asset .. toctree:: :hidden: :maxdepth: 1 :caption: Creating Objects :glob: assets/object-asset assets/material-palette-asset .. toctree:: :hidden: :maxdepth: 1 :caption: NPCs and Logic :glob: npcs/introduction npcs/npc-asset npcs/dialogue-asset npcs/quest-asset npcs/vendor-asset npcs/conditions npcs/rewards npcs/rewards-list-asset npcs/currency-asset .. toctree:: :hidden: :maxdepth: 1 :caption: Creating Miscellaneous Assets assets/airdrop-asset assets/animal-asset assets/character-mesh-replacement assets/crafting-asset assets/crafting-blacklist-asset assets/effect-asset assets/foliage-asset assets/road-asset assets/level-asset assets/mythical-asset assets/outfit-asset assets/physics-material-asset assets/redirector-asset assets/resource-asset assets/server-browser-curation-asset assets/spawn-asset assets/stereo-song-asset assets/tag-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 ★ Setting up a Server ★ Using SteamCMD (Advanced Setup) ★ Server Hosting Rules 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-browser-curation servers/server-codes 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 .. toctree:: :hidden: :maxdepth: 1 :caption: SDG / Project Info :glob: sdg/source-code sdg/using-git sdg/unity-project sdg/* 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. Upcoming Features ----------------- 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. Several high-priority ideas that don't yet have a solid plan, like a crafting revamp, are not listed on the board. Legacy Tutorials ---------------- 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. - `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. Offline Downloads ----------------- PDF and Epub versions of the documentation can be `downloaded `_ for offline use. Contributing ------------ 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.