Grimwar/Mapping - Revision history

DocumentationBot: Clarify custom content navigation and standardize asset examples

2026-10-04T16:29:56Z

Clarify custom content navigation and standardize asset examples

← Older revision		Revision as of 12:29, 4 October 2026
Line 5:		Line 5:
	== Create and name the map ==		== Create and name the map ==

	Save a new map in a source folder you own, such as <code>Maps/~~my_arena~~/~~my_arena~~.vertex</code>. Keep ~~the~~ companion script, thumbnail~~, and~~ custom ~~media there~~. Use '''File → Welcome… → Open repository…''' to find existing editable maps in a local checkout.		Save a new map in a source folder you own, such as <code>Maps/arena_mycustommap/arena_mycustommap.vertex</code>. Keep its companion script and thumbnail there; reusable custom assets stay in your [[Grimwar/Custom content\|shared content libraries]]. Use '''File → Welcome… → Open repository…''' to find existing editable maps in a local checkout.

	The filename sets the map ID and exported add-on ID. <code>~~sb_developer~~.vertex</code> produces <code>~~sb_developer~~</code>, including the ~~underscore~~. Set '''Map ~~→ Title~~''' to a readable display name. Changing the title does not rename the ID; '''Save As / Copy…''' with a different filename does.		The filename sets the map ID and exported add-on ID. <code>arena_mycustommap.vertex</code> produces <code>arena_mycustommap</code>, including the underscores. Set '''Title''' under '''Settings → Map details''' to a readable display name such as '''My Custom Map'''. Changing the title does not rename the ID; '''Save As / Copy…''' with a different filename does.

	Choose an ID that does not collide with a built-in map or another installed add-on. An <code>~~sb_~~</code>~~, <code>koth_</code>, or other~~ filename prefix is a naming convention, not a game-mode switch. Choose the mode when hosting. The current Vertex SDK connection uses King of the Hill for its default playtest launch.		Choose an ID that does not collide with a built-in map or another installed add-on. Use lowercase names with underscores. The <code>arena_</code> filename prefix is a naming convention, not a game-mode switch. Choose the mode when hosting. The current Vertex SDK connection uses King of the Hill for its default playtest launch.

	== Build a playable space ==		== Build a playable space ==
Line 57:		Line 57:
	For C# behavior tied to this map, use '''Map → SDK resources → VMod → Create…''' or attach an existing resource inside the source folder. The map build includes it; you do not need a second installed package. See [[Grimwar/VMod#Attach a VMod to a map\|map-bound VMods]].		For C# behavior tied to this map, use '''Map → SDK resources → VMod → Create…''' or attach an existing resource inside the source folder. The map build includes it; you do not need a second installed package. See [[Grimwar/VMod#Attach a VMod to a map\|map-bound VMods]].

	For custom materials, models, and prefabs in your general asset selection, follow [[Grimwar/~~Unity custom~~ content\|the shared Unity asset library guide]]. Keep the library outside your map folders and connect each map to it. '''Settings → Map details → Content…''' imports files owned by this map; references to another installed package become dependencies. See [[Grimwar/Custom content]].		For custom materials, models, and prefabs in your general asset selection, follow [[Grimwar/Custom content/Materials and models\|the shared Unity asset library guide]]. Keep the library outside your map folders and connect each map to it. '''Settings → Map details → Content…''' imports files owned by this map; references to another installed package become dependencies. See [[Grimwar/Custom content]].

			For '''sounds and music''', follow [[Grimwar/Custom content#Sounds and music\|the audio walkthrough]]. It covers shared audio packs, the Sound import type, playback settings, and placing an <code>env_ambient</code> entity.

	== Set lighting and a thumbnail ==		== Set lighting and a thumbnail ==

DocumentationBot: Keep custom assets in one library shared across maps

2026-10-04T16:11:50Z

Keep custom assets in one library shared across maps

← Older revision		Revision as of 12:11, 4 October 2026
Line 57:		Line 57:
	For C# behavior tied to this map, use '''Map → SDK resources → VMod → Create…''' or attach an existing resource inside the source folder. The map build includes it; you do not need a second installed package. See [[Grimwar/VMod#Attach a VMod to a map\|map-bound VMods]].		For C# behavior tied to this map, use '''Map → SDK resources → VMod → Create…''' or attach an existing resource inside the source folder. The map build includes it; you do not need a second installed package. See [[Grimwar/VMod#Attach a VMod to a map\|map-bound VMods]].

	~~Use~~ '''Settings → Map details → Content…''' ~~to import custom sounds, models, textures, and data. References~~ to another installed package become dependencies. See [[Grimwar/Custom content]]~~. For Unity-authored materials and model prefabs, follow [[Grimwar/Unity custom content\|the guided Unity asset workflow]], including the exact source folders and catalog setup~~.		For custom materials, models, and prefabs in your general asset selection, follow [[Grimwar/Unity custom content\|the shared Unity asset library guide]]. Keep the library outside your map folders and connect each map to it. '''Settings → Map details → Content…''' imports files owned by this map; references to another installed package become dependencies. See [[Grimwar/Custom content]].

	== Set lighting and a thumbnail ==		== Set lighting and a thumbnail ==

DocumentationBot: Guide custom Unity materials and models into Vertex

2026-10-04T15:55:12Z

Guide custom Unity materials and models into Vertex

← Older revision		Revision as of 11:55, 4 October 2026
Line 57:		Line 57:
	For C# behavior tied to this map, use '''Map → SDK resources → VMod → Create…''' or attach an existing resource inside the source folder. The map build includes it; you do not need a second installed package. See [[Grimwar/VMod#Attach a VMod to a map\|map-bound VMods]].		For C# behavior tied to this map, use '''Map → SDK resources → VMod → Create…''' or attach an existing resource inside the source folder. The map build includes it; you do not need a second installed package. See [[Grimwar/VMod#Attach a VMod to a map\|map-bound VMods]].

	Use '''Map → Content…''' ~~for~~ custom sounds, models, textures, and data. References to another installed package become dependencies. See [[Grimwar/Custom content]].		Use '''Settings → Map details → Content…''' to import custom sounds, models, textures, and data. References to another installed package become dependencies. See [[Grimwar/Custom content]]. For Unity-authored materials and model prefabs, follow [[Grimwar/Unity custom content\|the guided Unity asset workflow]], including the exact source folders and catalog setup.

	== Set lighting and a thumbnail ==		== Set lighting and a thumbnail ==

DocumentationBot: Document optional map settings and default music

2026-10-02T18:10:17Z

Document optional map settings and default music

← Older revision		Revision as of 14:10, 2 October 2026
Line 39:		Line 39:
	\|}		\|}

	The [[Grimwar/Entities\|entity reference]] lists ~~all 32~~ types. Its individual pages include placement, settings, defaults, and script signals.		The [[Grimwar/Entities\|entity reference]] lists entity types. Its individual pages include placement, settings, defaults, and script signals.

	Volumes use their authored orientation and size. Keep a trigger large enough to overlap a player, and check its team/activator filters. A new <code>trigger_multiple</code> has '''Allowed Teams: None''', which blocks participants until you select the intended teams.		Volumes use their authored orientation and size. Keep a trigger large enough to overlap a player, and check its team/activator filters. A new <code>trigger_multiple</code> has '''Allowed Teams: None''', which blocks participants until you select the intended teams.

			== Optional map settings and music ==

			'''Map Settings''' (<code>info_map_settings</code>) is optional. You can compile, export, and play a map without placing one or choosing music. Omitted settings use the game defaults; the default loading and gameplay score is '''Ordainment'''.

			To override the score, place one Map Settings entity and choose '''Compound''', '''Ritual''', '''Arcade''', or '''Ordainment''' in '''Music Set'''. Leaving Music Set at '''Unassigned''' also uses Ordainment. The map filename and title do not select music.

			Do not put objects beneath Map Settings: the compiler reads its overrides and removes the settings object from the compiled scene. Duplicate settings entities and invalid music values remain build errors. A package with no <code>musicSet</code> value also uses the default score.

	== Add logic and media ==		== Add logic and media ==

DocumentationBot: Version 1

2026-10-01T04:13:05Z

Version 1

New page

{{GameNav}}

Create the map in Vertex, build it with the Grimwar SDK, and test it in the installed game. Complete [[Grimwar/SDK setup#Install the SDK|SDK setup]] first.

== Create and name the map ==

Save a new map in a source folder you own, such as <code>Maps/my_arena/my_arena.vertex</code>. Keep the companion script, thumbnail, and custom media there. Use '''File → Welcome… → Open repository…''' to find existing editable maps in a local checkout.

The filename sets the map ID and exported add-on ID. <code>sb_developer.vertex</code> produces <code>sb_developer</code>, including the underscore. Set '''Map → Title''' to a readable display name. Changing the title does not rename the ID; '''Save As / Copy…''' with a different filename does.

Choose an ID that does not collide with a built-in map or another installed add-on. An <code>sb_</code>, <code>koth_</code>, or other filename prefix is a naming convention, not a game-mode switch. Choose the mode when hosting. The current Vertex SDK connection uses King of the Hill for its default playtest launch.

== Build a playable space ==

Start with a floor, walls, and a route between spawn areas. See [[Vertex/Editing]] for drawing, clipping, materials, models, terrain, and collision controls.

Use '''Auto''' collision for ordinary geometry and inspect it with '''Shift+C'''. Box or Convex collision can seal a visible doorway. For moving doors and platforms, put their geometry beneath the corresponding entity in the hierarchy so it moves with the entity.

The '''Prefabs''' browser includes a burn barrel and Order/Union spawn-door assemblies. Place an assembly to inspect how its models, triggers, doors, audio, and script host fit together. Linked instances remain editable.

== Place spawns and objectives ==

Use the entity creation controls and give the objects readable, stable names.

{| class="wikitable"
! Purpose !! Entities and setup
|-
| Team spawn || [[Grimwar/Entities/info_player_spawn|info_player_spawn]]. Set Team explicitly; the default is Union. Provide usable spawns for each participating team.
|-
| King of the Hill or capture objectives || [[Grimwar/Entities/game_capture_point|game_capture_point]]. Set the starting owner and capture times.
|-
| Uplink || [[Grimwar/Entities/game_capture_flag|game_capture_flag]]. Configure the prerequisite graph and exactly one middle flag.
|-
| Blitz || [[Grimwar/Entities/game_blitz_tank|game_blitz_tank]] with path points and child [[Grimwar/Entities/game_blitz_checkpoint|checkpoints]].
|-
| Gravewar facilities || [[Grimwar/Entities/trigger_gravewar_skull_deposit|Skull deposit]] and [[Grimwar/Entities/trigger_gravewar_upgrade_zone|upgrade zone]].
|-
| Supplies || [[Grimwar/Entities/item_pickup|item_pickup]] or [[Grimwar/Entities/func_resupply|func_resupply]].
|}

The [[Grimwar/Entities|entity reference]] lists all 32 types. Its individual pages include placement, settings, defaults, and script signals.

Volumes use their authored orientation and size. Keep a trigger large enough to overlap a player, and check its team/activator filters. A new <code>trigger_multiple</code> has '''Allowed Teams: None''', which blocks participants until you select the intended teams.

== Add logic and media ==

Vertex associates a <code>.vsig</code> script with the map. Use the Code workspace to connect entity outputs to inputs, such as a trigger opening a door. [[Grimwar/VSig]] gives a complete example.

For C# behavior tied to this map, use '''Map → SDK resources → VMod → Create…''' or attach an existing resource inside the source folder. The map build includes it; you do not need a second installed package. See [[Grimwar/VMod#Attach a VMod to a map|map-bound VMods]].

Use '''Map → Content…''' for custom sounds, models, textures, and data. References to another installed package become dependencies. See [[Grimwar/Custom content]].

== Set lighting and a thumbnail ==

Set the sky, sun, ambient light, and fog in Map Environment. Place <code>env_light</code> entities for local lights. Use Mixed or Dynamic lighting for animated or scripted lights; Area lights are baked only.

Choose a lightmap quality for your test. '''None''' skips lightmap/APV baking but does not skip Grimwar's required navigation, spatial, and occlusion work. Check the compiled lighting in the game.

In '''Map → Thumbnail''', choose a PNG or JPEG. Vertex uses it for the add-on thumbnail and in-game map image. Use 1920 × 1080 for release artwork. Vertex copies an image from outside the source folder beside the map, so include that copy when sharing the source.

== Compile and play ==

# Save the map and any externally edited script or media files.
# Select '''Preview''' and your desktop target in Build.
# Select '''Play in Game'''. Vertex captures the inputs, compiles, installs the add-on, and launches Grimwar.
# In '''Addons''', confirm the package is valid and enabled. Choose '''Use This Copy''' if a Workshop or older local copy is selected.
# Open '''Host''', select the map and intended game mode, and use '''Local''' access for an unpublished build.
# Test collision, spawns, objectives, sounds, scripts, and more than one round. Reload the map to check initialization again.

'''Export add-on''' performs the build without launching the game. '''Open current output''' shows the generated package. Close a running playtest before replacing its loaded bundles.

The default install location is Grimwar's user add-on library; [[Grimwar/Addons#Install a local package|Using add-ons]] lists the platform paths. You can choose a separate output folder in Build's Advanced settings for isolated tests.

== Build for publishing ==

Choose '''Release''' and export the map. Release includes Windows client, macOS client, and Linux dedicated-server output. Install every required Unity target module and resolve all build errors before publishing.

Keep the generated folder intact. It contains <code>addon.json</code>, platform files, and build receipts used to verify the package. Editing generated files breaks that verification; change the source and rebuild instead.

Publish from Grimwar's Addons screen following [[Grimwar/Steam Workshop addons]]. Publish required media packs first. An unpublished local package has no download source for other players and is restricted to local testing.

[[Category:Grimwar]] [[Category:Mapping]]