Curated Maps¶
Overview¶
Community-created updates and maps that are officially linked from the game are considered Curated Maps. They help players find high-quality new experiences, and keep the game updated with fresh content. Modders can then earn money from their work on their hobby, and get their creations highlighted.
Menu Visibility¶
One key component of sharing a curated map, trending popular workshop item, or specifically featured map is spotlighting it on the main menu. In any of these cases an article is placed above the recent news and announcements showcasing the preview image, and an expandable description.
In-game the description supports the following BBCode tags:
- [b]
- [i]
- [list]
- [*]
- [h1]
- [img]
- [url]
Ideally descriptions are kept succinct, so separate discussion topics might be a better place for long sections like ID lists.
By default popular items are surfaced, but workshop items can be specifically featured to help bring attention to projects with a lot of effort put into them, and curated maps. This can be done for new releases or major updates. Updates can link to a separate URL for the release notes.
Additionally, curated maps are linked from the singleplayer curated maps list, and will inherit the main menu "new" or "updated" label.
Quality Assurance¶
The primary focus of this article at the time of posting is to begin laying out standards to help ensure top quality between maps. This will be an iterative process, and is open to collaboration and feedback from the community.
Map Variety: New maps should feel noticeably different in order to be a candidate for curation. This is a subjective rule, and is covered by factors like interesting progression, new items, new environments, new architecture styles, new buildings, etc.
Asset Validation: Running the game with the -ValidateAssets command-line flag should not produce any warnings or errors.
English Text: Having an English-speaking member of the mod team is recommended, and MoltonMontro has offered to help with English-related questions. Most importantly in this regard is proper punctuation and grammar: while native English speakers can easily read incorrect punctuation, it is very helpful for non-native readers. Ironically this paragraph probably has some punctuation errors.
Project Organization: To prevent unintended assets from being exported into asset bundles, convention is to separate the project files into Sources and MasterBundle directories. Hawaii is split between a directory called "HawaiiMasterBundle" in the project root, and a Sources directory which contains all of the .blend, .mb, .xcf, .psd, .ai, etc files. When exporting the asset bundle this ensures only game files like .fbx and .prefab are included.
Asset Duplication: If multiple objects share identical prefabs, or use vanilla content, asset bundle size can be improved by sharing the same prefabs. For an example of this refer to the vanilla notes using Bundle_Override_Path.
Water Reflections: When using water volumes, only one should have planar reflections enabled. These reflections require rendering the world a second time for each enabled volume, and are some of the most performance expensive effects in the game.
Overlapping Navmeshes: No bounds should overlap. Otherwise zombies will appear and disappear unexpectedly in multiplayer.
Visibility Overlay: The visibility menu in the editor sums the mesh complexity in each region. Ideally there should only be a few red zones.
Item Icons: Each item should have a proper icon in the inventory. One way to quickly preview the icon is to attach an orthographic camera in Unity, and tune the orthographic size before setting the size in the .dat file.
Stockpile Preparation¶
Each curated map release is usually accompanied by a few cosmetics and skins in the game's item store. Royalties from the sales are shared with the mod team. Even if a project is not eligible for curation, it may be appropriate to have some support-the-creator items in the Stockpile e.g. the Candyland map.
File Sharing: Ideally the items have been setup for use as clothes in-game, and then exported into a .unitypackage. This package will then be imported into the vanilla project.
Curated Workshop Item: Payment splits are handled by a hidden curated workshop item. Setting this up usually takes a few weeks for new contributors bank and tax information to be processed.
Bundles: Two or three collections of sets of four to six items.
Mystery Boxes: Fifteen to twenty items that have individual value (not parts of sets like a shirt/pants).
Eligibility for Curation¶
Even if a map is of substantial quality, it may not be eligible for curation. When considering eligibility, it is important that the map fits the vanilla style of the game.
Although not every map should be curated, it is important to recognize the amount of effort that modders have put into their projects. Depending on the direction of the project, non-vanilla assets should either be adjusted to fit the vanilla style, or alternatives to curation should be considered instead.
Vanilla-style maps are eligible for curation, whereas non-vanilla maps are eligible to be featured. To help support the creators, both are eligible for revenue sharing cosmetic content in the game's item store e.g. the Candyland map.
It is encouraged to still work on a project even if it is not eligible for curation. Creating a variety of Workshop content creates a valuable portfolio for future curation attempts, and may still benefit from being featured.