Vellocet Developer Community - User contributions [en]

Vertex/Integrating your game

2026-10-09T20:38:00Z

DocumentationBot: Expand game integration guide with step-by-step build, content, and SDK instructions

{{VertexNav}}

You can use Vertex to make levels for your own game. Start by importing geometry. Add a game connection when you want your materials, entities, and build commands inside the editor.

Unity has a working integration package. Other engines can read Vertex's map format, but need their own engine adapter for compilation and playtesting. A game profile alone does not add support for another engine.

For Grimwar maps, follow [[Grimwar/SDK setup|Grimwar SDK setup]] and use the supplied <code>Grimwar.vertexsdk</code>. The steps below are for connecting a game you are developing.

== First level in Unity ==

You need a matching Vertex build and the <code>com.vellocet.vertex</code> Unity package. The Grimwar SDK includes that package under <code>Compiler/Packages/com.vellocet.vertex/</code>; copy it to a stable location for your project so a Steam update cannot replace it. Use Unity 6.3 for this integration; each finished SDK pins the exact editor version it builds with. Grimwar's SDK pins <code>6000.3.17f1</code>.

# Add the Vertex package through '''Window → Package Manager → Add package from disk…''' and select its <code>package.json</code>. Keep the package folder available to the project.
# Create a small map in Vertex without a game connection. Use plain brush geometry for the first import.
# Choose '''File → Export compiled meshes…''' and save a <code>.vertexmesh</code> under your Unity project's <code>Assets/GameContent/Maps/arena_mycustommap/</code> folder.
# Unity imports it as a prefab. Place it in a scene and assign material bindings on the imported asset where needed. Enable the placed root if it is inactive.
# Add your game's player, camera, and startup objects, then test movement and collision.

Keep the <code>.vertex</code> source beside the export. Re-export after editing; preserve the map and object IDs so Unity can retain references to imported objects. OBJ and FBX export are also available when you only need a model, but they omit entity and collision data.

This gives you an editable level and a repeatable import before you build an SDK for other creators.

After creating the connection below, you can go straight to [[#Add build and play actions|Add build and play actions]] for a first scene build. Materials, entities, scripts, and custom media can be added one at a time afterward.


== Create a .vertexsdk file ==

Create two plain-text JSON files with a text editor such as VS Code or Notepad:

* <code>MyGame.vertexgame</code> describes your game: its name, identifier, Unity version, and available content.
* <code>MyGame.local.vertexsdk</code> tells Vertex where that description and your Unity project are saved. This is the file you select in '''File → Open game SDK…'''.

Start with an existing Unity project and the Vertex Unity package installed as described in [[#First level in Unity|First level in Unity]]. The examples below make a local connection to that project. You can add materials, entities, and build actions after the connection works.

=== 1. Choose where to save the files ===

Find your Unity project folder: it contains <code>Assets</code>, <code>Packages</code>, and <code>ProjectSettings</code>. Go up one folder and create an <code>Authoring</code> folder there. The two new files will fit into this layout:

<syntaxhighlight lang="text">
MyGame/
MyGame.local.vertexsdk
Authoring/
MyGame.vertexgame
UnityProject/
Assets/
Packages/
ProjectSettings/
ProjectVersion.txt
</syntaxhighlight>

Here, <code>MyGame</code> is the parent folder and <code>UnityProject</code> is your existing Unity project. Keep your current folder names; step 3 explains how to use them in the connection file.

=== 2. Create MyGame.vertexgame ===

Create a file in <code>Authoring</code>, paste the following JSON, and save it as <code>MyGame.vertexgame</code>. Save as plain text and check the full filename: it must end in <code>.vertexgame</code>, with no extra <code>.txt</code> extension.

<syntaxhighlight lang="json">
{
"formatVersion": 1,
"id": "com.example.mygame",
"name": "My Game",
"version": "1",
"engineId": "unity",
"engineVersion": "6000.3.17f1",
"coordinates": "right-handed-y-up",
"defaultMetersPerUnit": 1,
"entityCatalogs": [],
"assetCatalogs": []
}
</syntaxhighlight>

Before saving, set these values for your game:

{| class="wikitable"
! Field !! What to enter
|-
| <code>id</code> || An identifier you choose, such as <code>com.yourstudio.yourgame</code>. Keep it stable once maps use it.
|-
| <code>name</code> || The name Vertex should display, such as <code>My Game</code>.
|-
| <code>version</code> || Your game profile version. You can start with <code>"1"</code>; this is separate from the Unity version.
|-
| <code>engineVersion</code> || Your project's exact Unity version. Open <code>ProjectSettings/ProjectVersion.txt</code> and copy the value after <code>m_EditorVersion:</code>. Replace <code>6000.3.17f1</code> if your project uses another supported version.
|}

For this first connection, keep <code>entityCatalogs</code> and <code>assetCatalogs</code> as empty lists (<code>[]</code>). They will list your entities, materials, and models later. The sample uses one map unit per metre; <code>defaultMetersPerUnit</code> can be <code>0.0254</code> for inches. Keep <code>coordinates</code> as shown: Vertex's Unity importer handles the coordinate conversion.

=== 3. Create MyGame.local.vertexsdk ===

Create another plain-text file in the parent folder, next to <code>Authoring</code> and your Unity project folder. Paste this JSON and save it as <code>MyGame.local.vertexsdk</code>, with no extra <code>.txt</code> extension. The <code>.local</code> part is a naming convention for this developer connection; the file extension is <code>.vertexsdk</code>.

<syntaxhighlight lang="json">
{
"formatVersion": 1,
"game": {
"id": "com.example.mygame",
"version": "1",
"path": "Authoring/MyGame.vertexgame"
},
"compilerProject": "UnityProject",
"editorProject": "UnityProject"
}
</syntaxhighlight>

Set <code>game.id</code> and <code>game.version</code> to exactly match the <code>id</code> and <code>version</code> you saved in <code>MyGame.vertexgame</code>.

{| class="wikitable"
! Path !! What it points to
|-
| <code>game.path</code> || The game description from step 2. <code>Authoring/MyGame.vertexgame</code> means open the <code>Authoring</code> folder beside this <code>.vertexsdk</code> file, then read <code>MyGame.vertexgame</code>.
|-
| <code>compilerProject</code> || Your Unity project folder, which supplies the source for map builds.
|-
| <code>editorProject</code> || Your local Unity project for saving maps into the editor. Use the same folder as <code>compilerProject</code> for this setup.
|}

If your Unity project folder is named <code>SpaceGame</code>, replace '''both''' <code>"UnityProject"</code> values with <code>"SpaceGame"</code>. If you change the game description's filename or folder, update <code>game.path</code> too.

All three paths start from the folder containing <code>MyGame.local.vertexsdk</code>. Use forward slashes (<code>/</code>) even on Windows, and keep the referenced files and folders below that folder. Absolute paths and <code>../</code> are not accepted here.

=== 4. Open and check the connection ===

# In Vertex, choose '''File → Open game SDK…'''.
# Select <code>MyGame.local.vertexsdk</code>.
# Check the status message. It should start with '''My Game connected.''' (using the <code>name</code> from your game description).
# When creating a new map, select your game. Existing maps retain their own game connections.

Vertex now knows your game's identity, units, and project paths. You can continue the geometry import steps in [[#First level in Unity|First level in Unity]].

The empty catalog lists add no game-specific materials, models, or entities yet. Continue with [[#Expose materials and models|Expose materials and models]] and [[#Add an entity type|Add an entity type]] to supply them. '''Save to Unity''' and map builds also need the code described in [[#Add build and play actions|Add build and play actions]]; creating these two files does not implement those actions.

After editing either file, use '''Settings → Game and resources → Reload resources''' in Vertex. Keep this local developer connection out of public SDK distributions.

=== If the connection does not open ===

{| class="wikitable"
! Problem !! Check
|-
| The file does not appear in the SDK chooser || Show filename extensions in your file manager. The file must end in <code>.vertexsdk</code>, not <code>.vertexsdk.txt</code>.
|-
| Invalid JSON || Save plain text, use straight double quotes, and check commas and brackets against the examples. Copy only the JSON, without surrounding wiki text.
|-
| Missing file or compiler project || Check paths from the folder containing <code>.vertexsdk</code>. The project path must reach the existing Unity project containing <code>Assets</code>, <code>Packages</code>, and <code>ProjectSettings</code>.
|-
| Unity version mismatch || Match <code>engineVersion</code> to <code>m_EditorVersion</code> in that project's <code>ProjectSettings/ProjectVersion.txt</code>, including the patch version and suffix.
|-
| Game ID or version mismatch || Match <code>game.id</code> and <code>game.version</code> in <code>.vertexsdk</code> to <code>id</code> and <code>version</code> in <code>.vertexgame</code> exactly.
|}

== Expose materials and models ==

An asset catalog is the list of Unity materials and models Vertex can offer in its pickers. It also contains previews, so Vertex can show the content without running Unity. Start with one material and one prefab you can recognize.

=== 1. Choose the Unity assets ===

# In your Unity project's '''Project''' window, create <code>Assets/GameContent/VertexLibrary</code> and put the test material and prefab there.
# Create <code>Assets/Editor</code> if it does not exist. Inside it, right-click and choose '''Create → Vertex → Asset catalog profile'''. Name the asset <code>VertexAssets</code>, giving it the path <code>Assets/Editor/VertexAssets.asset</code>.
# Select the asset. Set '''Catalog Id''' to <code>mygame.base</code> and '''Catalog Version''' to <code>1</code>.
# Add one entry to '''Folders'''. Set '''Folder''' to <code>Assets/GameContent/VertexLibrary</code>, with forward slashes and no trailing slash. Enable '''Materials''', '''Models''', and '''Prefabs''' for the types you want to expose.
# Set '''Ownership''' to <code>base</code> for assets that your installed game already supplies. Use <code>custom</code> for creator-owned assets that your package builder is allowed to include in an add-on.

Folder rules include subfolders. Keep the first rule narrow: pointing it at all of <code>Assets</code> can expose unrelated content. Preserve the assets' <code>.meta</code> files; their GUIDs form part of the keys saved in maps.

=== 2. Add an export menu in Unity ===

Create <code>UnityProject/Assets/Editor/MyGameCatalogExport.cs</code> and paste this complete script. It uses the folder layout from [[#Create a .vertexsdk file|Create a .vertexsdk file]]. It exports the catalog next to your game description and updates that description without removing its other settings.

<syntaxhighlight lang="csharp">
using System.IO;
using System.Linq;
using UnityEditor;
using UnityEngine;
using Vertex.Contracts;
using Vertex.Unity.Editor;

public static class MyGameCatalogExport
{
[MenuItem("Tools/My Game/Export Vertex assets")]
public static void Export()
{
var profile = AssetDatabase.LoadAssetAtPath<VertexAssetCatalogProfile>(
"Assets/Editor/VertexAssets.asset");
if (!profile)
throw new FileNotFoundException("Create Assets/Editor/VertexAssets.asset first.");

var authoring = Path.GetFullPath(Path.Combine(Application.dataPath, "../../Authoring"));
var gamePath = Path.Combine(authoring, "MyGame.vertexgame");
var game = GameProfile.Load(gamePath);
var catalog = VertexAssetCatalogExporter.Export(profile,
Path.Combine(authoring, "MyGame.vertexassets"));
game.AssetCatalogs = game.AssetCatalogs
.Where(reference => reference.Id != catalog.Id)
.Append(new ProfileReference
{
Id = catalog.Id,
Version = catalog.Version,
Path = "MyGame.vertexassets"
}).ToArray();
VertexAssetCatalogExporter.Publish(gamePath, game.Serialize());
Debug.Log("Vertex assets exported to " + authoring);
}
}
</syntaxhighlight>

If you used different filenames, change the two <code>MyGame.vertexgame</code>/<code>MyGame.vertexassets</code> paths in the script. The <code>Assets/Editor</code> location makes this an editor script; do not attach it to a GameObject.

=== 3. Export and check the pickers ===

# Wait for Unity to compile the script. Resolve any red Console errors before continuing.
# Choose '''Tools → My Game → Export Vertex assets''' in Unity.
# Check that <code>Authoring/MyGame.vertexassets</code> and the exported preview files exist. The Console should report the export folder.
# In Vertex, choose '''Settings → Game and resources → Reload resources'''.
# Open the material picker and look for your test material. Apply it to a brush. Check the model/prefab picker for the test prefab and place it.
# Export a <code>.vertexmesh</code> into Unity again. Check that it resolves to the original material and prefab, rather than just matching the preview image.

Re-run the export menu after changing assets. Keep the catalog and its preview files together when distributing them. If a material is missing, check its folder rule and '''Materials''' checkbox. If it appears but imports incorrectly, check that the compiler project contains the same assets, <code>.meta</code> files, and catalog profile. Custom shaders may also need a project-specific material preview provider.

For automated releases with several catalogs, <code>VertexGameProfileExporter.Export</code> publishes the catalogs and game description together. The menu above is sufficient for this first local catalog.

== Add an entity type ==

An entity definition adds a choice to Vertex. A Unity importer turns that choice into a working game object. This example adds a point light so you can see the result without writing a player or trigger system.

=== 1. Create the entity catalog ===

Save the following as <code>Authoring/MyGame.vertexentities.json</code>. Change <code>sdkId</code> if you changed the example game's identifier.

<syntaxhighlight lang="json">
{
"formatVersion": 1,
"sdkId": "com.example.mygame",
"sdkVersion": "1",
"entities": [
{
"id": "point_light",
"name": "Point light",
"category": "My Game",
"placement": "point",
"geometry": "none",
"importable": true,
"properties": [],
"signals": [],
"capabilities": 0
}
],
"globals": [],
"diagnostics": []
}
</syntaxhighlight>

In <code>MyGame.vertexgame</code>, replace the existing <code>entityCatalogs</code> value (<code>[]</code>) with this array. These paths start beside <code>MyGame.vertexgame</code>, so there is no <code>Authoring/</code> prefix here.

<syntaxhighlight lang="json">
[
{
"id": "com.example.mygame",
"version": "1",
"path": "MyGame.vertexentities.json"
}
]
</syntaxhighlight>

=== 2. Add the Unity importer ===

Save this as <code>UnityProject/Assets/Editor/MyGameEntityImport.cs</code>. The registration ID must match the catalog's <code>sdkId</code>.

<syntaxhighlight lang="csharp">
using System.IO;
using UnityEditor;
using UnityEngine;
using Vertex.Unity.Editor;

[InitializeOnLoad]
public static class MyGameEntityImport
{
static MyGameEntityImport()
{
VertexSdkRegistry.Register("com.example.mygame", Import);
}

private static void Import(VertexEntityBuildContext context)
{
foreach (var entity in context.Entities)
{
if (entity.Entity.TypeId != "point_light")
throw new InvalidDataException("Unknown entity: " + entity.Entity.TypeId);
var light = context.Objects[entity.Id].AddComponent<Light>();
light.type = LightType.Point;
light.range = 10;
light.intensity = 2;
}
}
}
</syntaxhighlight>

Vertex has already created and positioned each object's transform. The importer adds the native component to that object. The range above is in Unity metres. Changing these values changes future imports; this first entity has no editable properties in Vertex yet.

=== 3. Place and test it ===

# Wait for Unity's scripts to compile, then reload resources in Vertex.
# In '''Create''', choose '''Point light''' under '''My Game''' and place it near a floor or wall.
# Export a <code>.vertexmesh</code> into your Unity project and place the imported prefab in a scene. Enable its root if it is inactive.
# Expand the hierarchy and select the entity. It should have a Unity '''Light''' component with range <code>10</code> and intensity <code>2</code>. Check it with Scene lighting enabled.

If the entity appears in Vertex but Unity says its SDK is missing, the catalog was loaded but the importer was not registered. Check the <code>Assets/Editor</code> script, Unity Console errors, and the exact registration ID.

Next, add catalog properties such as range or color and read their validated values in the importer. Use <code>context.ResolveAsset</code> for asset-key properties. Keep entity and property IDs stable: maps store them. Add signals only when the runtime implements them; declaring an <code>open</code> input does not give a door any behavior.

== Run map scripts ==

Do this after an entity imports correctly and its game behavior works without scripting. Vertex supplies the VSig language and runtime; your game must connect script inputs and outputs to its components. The point-light example above does not yet supply script bindings.

=== 1. Define and implement one signal ===

# Choose one behavior, such as enabling a light or opening a door. Add the input's name, value type, and authority to that entity's catalog definition.
# In your game's runtime code, implement <code>IEntitySignalRuntime</code> for that component. Its input handling must call the actual game behavior.
# Create an <code>EntityDescriptor</code> for each imported entity, using its persistent map/object IDs and the catalog's signal contract. Keep a dictionary from those descriptors to their runtime bindings.
# Re-export/reload the catalog. Follow [[Vertex/VSig|Map logic]] to write a small script that calls the input from <code>map.ready</code>.

The expected result at this stage is a valid script in Vertex. Runtime behavior still depends on the next two steps.

=== 2. Compile the script with the map ===

# Extend your Unity compiler to read the captured entry script at <code>context.PathFor(context.Job.Script)</code> and its declared source dependencies.
# Parse with <code>VSigParser</code> and validate with <code>VSigProgramValidator</code>, using the same entity descriptors and global-event catalog your game exposes. Stop the build on errors.
# Convert the valid program with <code>VSigCompiledProgram.FromProgram</code> and store its serialized data with the built map, using a game-owned component or asset. A <code>.vsig</code> file beside a scene is not automatically executed.

Resolve imports from the captured source set, so the build uses the versions captured when it started. Do not read an unrelated live script folder halfway through a build.

=== 3. Start the runtime and check the result ===

# When your game loads the map, create or enable a GameObject with <code>VertexScriptHost</code>. It must be active before initialization.
# Call <code>Initialize(compiledProgram, bindings, capabilities)</code> after the entity bindings exist. The arguments are the saved compiled program, your descriptor-to-runtime dictionary, and the <code>VSigHost</code> containing your game's allowed operations and globals.
# Call <code>MarkReady()</code> once the map is ready for scripts. This emits <code>map.ready</code>.
# Load the test map and confirm that the chosen light or door responds. Then deliberately misspell the input in the source: the next build should fail with a useful error.

The host advances automatically using Unity time. If your game owns the simulation clock, pass <code>automaticTick: false</code> and call <code>Tick(seconds)</code> from that clock instead. Disabling or destroying the host disposes its runtime; re-enabling requires initialization again.

For multiplayer, derive authority from the running server/client roles. Global events other than <code>map.ready</code>, console commands, and variables need game-owned bindings. Grimwar's round events and VMod API are not supplied to another game by installing Vertex.

== Add build and play actions ==

Start with a '''scene build''': Vertex captures your map, runs Unity in a separate project, and produces a <code>.unity</code> scene you can inspect. This checks your connection and compiler before you implement an installable add-on or a game launcher.

Building a map does not build your game's executable. You still build your game with Unity's normal player build. '''Play in Game''' later loads a built map into an existing game executable.

=== 1. Understand the three actions ===

{| class="wikitable"
! Action !! Where it runs !! What you must supply
|-
| '''Build scene''' / your export label || A separate Unity process using a private copy of the compiler project || A <code>build</code> object in <code>.vertexgame</code> and an editor script registered with <code>VertexSdkRegistry.RegisterCompiler</code>. Steps 2–5 below provide a first example.
|-
| '''Save to Unity''' / '''Save & Compile to Unity''' || Your already-open Unity editor || An <code>editorProject</code> connection, <code>build.editorSaveLabel</code>, and a separate <code>VertexEditorBridge.Register</code> callback. See step 6.
|-
| '''Play in Game''' || The package compiler, then your installed game || Working package export, <code>build.launchArguments</code>, and a game that can load the package. See steps 7–8.
|}

The JSON supplies names and supported choices. It does not contain C# or a shell command, and it does not generate the Unity implementation. Put the implementation in your own <code>Assets/Editor</code> scripts; keep the supplied Vertex package unchanged.

=== 2. Add build settings to MyGame.vertexgame ===

Open <code>Authoring/MyGame.vertexgame</code>. Keep the existing identity, engine version, and catalogs. Add a comma after the last existing field, then add the <code>build</code> field shown here before the final closing brace. This block shows only the new field; it is not a replacement for the whole game description.

<syntaxhighlight lang="json">
{
"build": {
"profiles": ["Preview"],
"targets": [
{ "id": "StandaloneWindows64", "name": "Windows", "platform": "windows" },
{ "id": "StandaloneOSX", "name": "macOS", "platform": "macos" },
{ "id": "StandaloneLinux64", "name": "Linux", "platform": "linux" }
],
"exportLabel": "Build scene"
}
}
</syntaxhighlight>

<code>profiles</code> is the list shown in the build profile selector. <code>Preview</code> is a name passed to your compiler, not an automatic choice of lighting quality. The target IDs above are the supported Unity build targets; their <code>name</code> values are the labels shown to users. Remove targets your game will not support.

Leave <code>packageFormat</code>, <code>launchArguments</code>, and <code>editorSaveLabel</code> absent for now. This example produces a scene and does not advertise an unimplemented save or play action. Keep <code>MyGame.local.vertexsdk</code> as created earlier.

=== 3. Register a first scene compiler ===

Create <code>UnityProject/Assets/Editor/MyGameVertexBuild.cs</code> and paste the following. Replace the registration's <code>com.example.mygame</code> and <code>1</code> if you changed the game ID or version. Both must match <code>MyGame.vertexgame</code> exactly.

<syntaxhighlight lang="csharp">
using System.IO;
using System.Linq;
using UnityEditor;
using UnityEditor.SceneManagement;
using UnityEngine;
using Vertex.Unity.Editor;

[InitializeOnLoad]
public static class MyGameVertexBuild
{
static MyGameVertexBuild()
{
VertexSdkRegistry.RegisterCompiler("com.example.mygame", "1", Compile);
}

private static void Compile(VertexBuildContext context)
{
if (context.Job.Package)
throw new InvalidDataException("This example builds scenes, not add-on packages.");
if (context.Job.Game.Baking != null ||
(context.Job.Resources?.Length ?? 0) != 0 ||
(context.Job.Content?.Length ?? 0) != 0)
throw new InvalidDataException("Add baking, resource, and custom-media support before building this map.");
if (File.ReadLines(context.PathFor(context.Job.Script))
.Any(line => line.Trim().Length > 0 && !line.TrimStart().StartsWith("#")))
throw new InvalidDataException("This first compiler needs a map with no VSig script.");

context.CheckCanceled();
context.Policy = "mygame.scene-only.v1";
const string scenePath = "Assets/VertexBuild/Output/Map.unity";
context.PrepareScenePath(scenePath);
var prefab = AssetDatabase.LoadAssetAtPath<GameObject>(context.Job.Map);
if (!prefab)
throw new InvalidDataException("Map import failed; inspect the Unity build log.");

var scene = EditorSceneManager.NewScene(NewSceneSetup.EmptyScene, NewSceneMode.Single);
var map = (GameObject)PrefabUtility.InstantiatePrefab(prefab, scene);
map.SetActive(true);
context.Report(0.8, "Saving the imported map scene…");
if (!EditorSceneManager.SaveScene(scene, scenePath))
throw new IOException("Could not save " + scenePath);
context.Complete(scenePath, new[] { "geometry-import" });
}
}
</syntaxhighlight>

Wait for Unity to compile it and check the Console for errors. There is no component to attach or menu to click: <code>InitializeOnLoad</code> registers the callback whenever this Unity project loads, including in Vertex's build process.

The example imports geometry and any entities whose importers you registered. It deliberately rejects scripts, custom media, resource attachments, package jobs, and declared bake policies until you implement them. It adds no player, camera, or game bootstrap. Use a small test map with a floor and walls for the first build.

Vertex starts Unity through the fixed <code>Vertex.Unity.Editor.VertexBuildCompiler.Run</code> entry point. That code verifies the captured inputs, imports the map as a prefab, and then calls your registered <code>Compile</code> method. You do not put that method name in the JSON.

=== 4. Configure the machine and build ===

# In Unity Hub, install the exact editor version recorded in <code>engineVersion</code>, with the build support module for your chosen target. Activate its Unity license. The current Unity build entry point also requires a graphics-capable machine, even for this simple scene example.
# In Vertex, reload resources. Create or open a map connected to '''My Game''', then save it as <code>arena_test.vertex</code> in a folder you own.
# Open '''Build'''. You should now see '''Build scene''', the '''Preview''' profile, and the targets you declared.
# Expand '''Advanced settings'''. Check '''Engine executable''': it must be the matching Unity editor executable or <code>Unity.app</code>, not Unity Hub or your game's executable.
# Check '''Compiler template''': it must point to your <code>UnityProject</code> folder, containing the new compiler script and the Vertex package. The local SDK connection normally fills this in.
# Set '''Build directory''' to a separate writable location, such as <code>MyGame/VertexBuilds</code>. Do not use your Unity project itself or a folder inside it.
# Choose your machine's target for the first test, select '''Preview''', and click '''Build scene'''. Watch the progress and diagnostics in the Build panel.

Unity works on a captured copy of the project. The first build can take longer while Unity imports that copy. Save changes to your Unity scripts and assets before starting; changes made after the snapshot belong to the next build.

=== 5. Find and inspect the result ===

# Wait for the successful build result. Choose '''Open current output'''. For this scene-only example, it opens the retained build workspace.
# Find <code>Assets/VertexBuild/Output/Map.unity</code> inside it. The captured input is <code>Assets/VertexBuild/Input/Map.vertexmesh</code>; logs and result information are under <code>VertexJob</code>.
# After the build process has exited, open that workspace as a separate project with the matching Unity version. Open <code>Map.unity</code>, select the map root, and press '''F''' in the Scene view to frame it.
# Check the meshes, materials, and colliders. Add your game's player/camera/bootstrap creation to your compiler when you are ready to make this scene playable.

Keep the whole workspace when inspecting it: the scene references imported assets elsewhere in the project. It is a build result, not the folder to distribute to players. Make further edits to the original <code>.vertex</code> map and compiler code, then rebuild.

Once this works, add your required validation, VSig compilation, navigation, lighting, and other bake steps. Set a policy identifier that describes the checks your compiler actually performs, and report only completed passes in <code>Complete</code>. Reporting a pass name does not perform that pass.

If your game exposes collision filters, register <code>VertexSdkRegistry.RegisterCollisionPolicy(id, resolve)</code> during editor initialization. The resolver maps your game's collision categories to Unity layers; the importer needs that registration to apply the filters saved in a map.

=== 6. Optionally save into the open Unity project ===

This is a separate integration for developers working on base-game maps. It avoids opening a separate output project each time.

# Keep <code>editorProject</code> in the local <code>.vertexsdk</code> pointing to your development project. Add <code>"editorSaveLabel": "Save to Unity"</code> inside the game's <code>build</code> object.
# In an <code>Assets/Editor</code> script, register <code>VertexEditorBridge.Register(gameId, version, save)</code> during initialization. The <code>save</code> callback takes a <code>VertexEditorMapContext</code> and must return the path of a saved Unity scene, starting with <code>Assets/</code>.
# In that callback, use <code>context.Job</code> and <code>context.PathFor(...)</code> to read the captured map and source files. Copy the inputs needed by the saved map out of the temporary request directory. For example, organize them below <code>Assets/GameContent/Maps/arena_test/</code> and create <code>Authoring.unity</code> there.
# Inspect <code>context.Compile</code>. For '''Save to Unity''', save the authoring data. For '''Save & Compile to Unity''', also run your game's validation and compilation steps. Return the scene that was actually saved. Preserve previous output if validation or cancellation fails.
# Open the development project, exit Play Mode, and save any modified Unity scenes. Reload resources in Vertex, then try '''Save to Unity'''. Confirm the new scene and its dependencies exist under <code>Assets</code>.

The scene-build callback from step 3 does not implement this callback; adding the label alone is insufficient. Save actions do not need the export platform selector: your normal game player build handles platforms for base-game assets.

=== 7. Implement an installable package ===

Do this before enabling '''Play in Game'''. A standalone Unity game cannot load an arbitrary editor <code>.unity</code> file from disk. Your game needs a supported runtime format, such as an add-on containing built scene bundles, and a loader for it.

# Choose a package format ID, for example <code>mygame.addon.v1</code>. Implement how your game finds, validates, loads, and unloads a map in that format.
# Extend the compiler to handle <code>context.Job.Package</code>. Build the scene, compile its scripts/resources, run required bakes, and build its platform-specific bundles or other runtime data.
# Write the package below <code>VertexPackage/</code> in the private build workspace. Include <code>vertex-package.json</code>, serialized from <code>Vertex.Contracts.PackageManifest</code>. It records the map/game identity, input hash, profile/target, format, file hashes, and asset ownership/bundle membership. This is separate from any manifest your game's loader needs.
# Keep installed base assets out of the package; include permitted custom assets and generated map data with their required dependencies. Audit the actual output and bundle membership rather than recording the intended contents.
# Finish with <code>context.Complete(scenePath, completedPasses, packageRelativePath)</code>. The package path must start with <code>VertexPackage/</code>. Vertex checks the manifest and output receipts before replacing the current result.
# Add <code>"packageFormat": "mygame.addon.v1"</code> inside <code>build</code> and change <code>exportLabel</code> to <code>Export add-on</code>. Reload resources and export a small map. Use '''Open current output''' to inspect the package, then '''Install current package''' to test installation.

Do not add <code>packageFormat</code> while still using the scene-only compiler: it changes export requests into package jobs, which that example rejects. A successful export does not upload to Steam Workshop or publish your game.

=== 8. Connect Play in Game ===

After the package loads successfully in your game, add these fields inside the existing <code>build</code> object. Keep its profiles, targets, export label, and package format. This block again shows only the additional fields.

<syntaxhighlight lang="json">
{
"addonDirectory": "MyStudio/MyGame/addons",
"launchArguments": ["--addon-root", "{addonRoot}", "--map", "{mapId}"]
}
</syntaxhighlight>

<code>--addon-root</code> and <code>--map</code> are example arguments for your game's own command-line parser. Unity and Vertex do not automatically implement them. Use the argument names your game actually handles; put each argument and value in a separate array entry.

{| class="wikitable"
! Substitution !! Value passed to your game
|-
| <code>{addonRoot}</code> || The parent folder containing installed add-on packages.
|-
| <code>{packageRoot}</code> || The specific installed package folder for this map.
|-
| <code>{mapId}</code> || The public map ID derived from the saved filename, such as <code>arena_test</code>.
|}

# Reload resources in Vertex. '''Play in Game''' should now appear.
# In '''Build → Advanced settings''', choose the already-built '''Game executable''' and the '''Add-on folder''' your game reads. <code>addonDirectory</code> supplies a default relative to the user's local application-data folder; it is not relative to the SDK.
# Choose a target matching the machine that will run the game. Close any game instance that still has the old bundles loaded.
# Click '''Play in Game'''. It builds the current inputs, installs the successful package, then launches that executable with the configured arguments.
# Confirm your game opens <code>arena_test</code>. If the game opens its usual menu, check its command-line handling and map-loading logs. Starting the process does not prove that the game loaded the requested map.

Set <code>steamAppId</code> to the '''game's''' Steam app ID only if the game requires Steam; omit it otherwise. Executable paths belong in each user's local settings, not the shared game description. Add a <code>Release</code> profile and <code>allTargetsPackageProfiles</code> only when the compiler implements the corresponding checks and can build every required target.

=== If building does not work ===

{| class="wikitable"
! Symptom !! What to check
|-
| No build choices || The connected game's <code>.vertexgame</code> needs a valid <code>build</code> object. Reload resources, then check that the map is connected to that game.
|-
| Build button disabled || Save the map first. Finish or cancel any running job and resolve any local-settings error shown in Build.
|-
| “Install the compiler binding…” || The compiler script must be inside the project selected as '''Compiler template'''. Resolve Unity compilation errors; match the registered game ID and exact version. A script only present in another open project will not register in this build.
|-
| Unity version, license, target, or graphics error || Match <code>engineVersion</code>, activate that editor, install the selected target's support module, and use a graphics-capable worker. The build entry point rejects <code>-nographics</code>.
|-
| A script, media, or package request is rejected by the example || The first compiler supports scene import only. Test a plain map, then implement the named feature before advertising it in the game profile.
|-
| Waiting for Unity during Save || Open the project named by <code>editorProject</code>, exit Play Mode, save dirty scenes, and check that the separate save callback is registered.
|-
| Play is missing || <code>launchArguments</code> must be present, and they require <code>packageFormat</code>. First get package export and your game's loader working.
|-
| Build fails or is cancelled || Read the first build diagnostic and the retained Unity log. The previous successful output stays available; Play does not launch that older output as a substitute for the failed build.
|}

== Custom media and other resource types ==

These are optional. Add them after the plain-map build works, one type at a time. There are two different lists in <code>MyGame.vertexgame</code>:

* <code>contentTypes</code> describes imported files such as sounds, images, models, and data. They appear in '''Content''' and use stable asset keys.
* <code>resourceTypes</code> describes a source folder with its own JSON manifest and declared files, such as a mission or a game-specific script module. It can be attached to a map and, when supported, authored separately through VSDK.

=== 1. Declare one media type ===

For example, add the following field at the top level of <code>MyGame.vertexgame</code> if your game will support WAV sounds. This is an additional field, not a complete game description.

<syntaxhighlight lang="json">
{
"contentTypes": [
{
"id": "sound",
"name": "Sound",
"kind": "audio",
"extensions": [".wav"],
"maximumBytes": 16777216,
"settings": []
}
]
}
</syntaxhighlight>

# Reload resources. Open '''Content''' and import a small WAV file using the new '''Sound''' type.
# Check the map's source folder: <code>content.json</code> records the asset and its settings, and <code>Content/</code> holds its source file. The example limits one file to 16 MiB.
# Extend your compiler to process the captured catalogs in <code>context.Job.Content</code>, validate the allowed format/size, and include or convert the needed audio data into the runtime package.
# Add an asset-key property to an entity, or a game API that accepts the sound key. Implement how the runtime resolves and plays it.
# Build, load the map, and trigger the sound. Merely seeing it in Content confirms authoring registration, not runtime playback.

Use additional <code>settings</code> entries for game-owned choices such as volume or looping. Your importer and runtime must interpret them. See [[Vertex/Content|Custom content]] for the creator's import, replacement, and dependency workflow.

=== 2. Add a manifest-based resource when needed ===

# Choose a stable resource ID, for example <code>mission</code>, and define the format your game will read.
# Add a <code>resourceTypes</code> entry to <code>.vertexgame</code>. It needs <code>id</code>, <code>name</code>, <code>manifest</code>, <code>filesProperty</code>, and <code>template</code>. For a mission, these could be <code>mission</code>, <code>Mission</code>, <code>mission.json</code>, and <code>sourceFiles</code>.
# Supply the template as an array of <code>path</code>/<code>content</code> objects, including the manifest itself and every starter source file. The manifest's <code>sourceFiles</code> array lists relative filenames; <code><nowiki>{{id}}</nowiki></code> in template text is replaced with the new resource ID.
# Register <code>VertexSdkRegistry.RegisterResource("mission", validator)</code> in your Unity editor integration. In your compiler, call <code>VertexSdkRegistry.CaptureResources(context.Job, context.Root)</code> to obtain validated captured resources, then compile/store them in your map's runtime format. Registration alone does not add this call to a custom compiler.
# Reload resources and use '''Settings → Game and resources → Mission → Create''' to make a test resource. Edit and save its declared files, then build the map. Check that invalid input fails validation and that valid input reaches your game.

For standalone authoring, also implement a resource worker executable and add its paths under <code>resourceTools</code> in <code>.vertexsdk</code>, one per supported desktop runtime. Set the resource type's <code>standalone</code> flag only when that workflow is supported. VSDK uses the worker for validate/build/test actions; the game still decides when the resource starts and stops.

== Ship an SDK ==

Do this after building and loading a map works on your development machine. The release must also work for someone who has none of your project folders. A <code>.vertexsdk</code> file is the entry point to the distribution; it does not contain the compiler or catalogs itself.

These steps package your own game integration. Creators should install Vertex/VSDK from Vellocet's official distribution. Bundling Vellocet's tools, Unity package, or source with your SDK requires prior written permission; the license's compiled-runtime exception covers finished games and projects. Credit <code>Software by Vellocet Corporation</code> as required by the included license.

=== 1. Assemble a separate distribution folder ===

# Create a clean compiler project containing your registered compiler, entity importers, needed Unity packages, catalog profiles, and authorized build assets. Keep local caches, credentials, and unrelated game source out of that project.
# Copy the game description, entity/asset catalogs, and preview files into <code>Authoring/</code>, preserving the relative paths recorded in the game description.
# Document the matching Vertex/VSDK versions creators must install. Include your own resource workers for the platforms you support, and document how to install any dependencies you cannot bundle.
# Generate <code>Compiler.inputs.json</code> from the finished compiler tree using <code>Vertex.Contracts.BuildInputs</code>. Each file entry records its relative <code>path</code>, byte count, and SHA-256 hash. Generate it in your release tooling; do not hand-maintain hashes or include the compiler's generated <code>Library</code> directory.
# Create a public <code>MyGame.vertexsdk</code> using the example below. Include <code>resourceTools</code> too if your game provides workers. Keep the developer-only <code>MyGame.local.vertexsdk</code> out of this distribution.

<syntaxhighlight lang="text">
MyGameSDK/
MyGame.vertexsdk
Compiler.inputs.json
Authoring/
MyGame.vertexgame
MyGame.vertexassets
MyGame.vertexentities.json
previews/
Compiler/
Assets/
Packages/
ProjectSettings/
</syntaxhighlight>

The catalog/preview filenames above correspond to the earlier examples; keep the actual exported preview folders.

<syntaxhighlight lang="json">
{
"formatVersion": 1,
"game": {
"id": "com.example.mygame",
"version": "1",
"path": "Authoring/MyGame.vertexgame"
},
"compilerProject": "Compiler",
"compilerInputs": "Compiler.inputs.json"
}
</syntaxhighlight>

The public connection omits <code>editorProject</code>, because a creator does not have your development checkout. Remove <code>build.editorSaveLabel</code> from its game description as well. The inventory lets Vertex verify and prepare the compiler cache; regenerate it whenever any compiler file changes.

Review what your release tooling copies. The Vertex application is compiled, but copying a Unity package directory can include that package's C# source. A public compiler project should contain only the code and assets you intend and have permission to distribute.

=== 2. Test it as a creator ===

# Copy the distribution to a fresh location or machine. Make your development checkout unavailable to the test so missing dependencies cannot resolve accidentally.
# Install the pinned Unity version and required modules, then open the SDK through VSDK or '''File → Open game SDK…''' in Vertex.
# Create a new map outside the SDK folder. Test the supplied material, entity, script, and custom-media workflows.
# Build every supported target/profile, install the result, and launch the actual game. Confirm it loads the newly built map.
# Introduce an invalid source, then cancel a separate build. Both should preserve the last successful output; a failed play request must not launch an older package.
# Replace the SDK with a new release, reload resources, and rebuild the same map. Its authored sources and stable asset/entity references should still work.

Record the matching editor, package, compiler, and catalog versions in your release process. Ship them together rather than replacing one executable in an older SDK.

=== Using another engine ===

The JSON can describe another engine, but it cannot install one into Vertex. An engine developer must implement <code>IEngineAdapter</code> in a trusted engine assembly and register it in the desktop application. Reuse the portable <code>Vertex.Contracts</code> and <code>Vertex.VSig</code> libraries, and convert coordinates and units at that boundary. There is no finished production Godot adapter in the current distribution.

[[Category:Vertex]]

Vertex

2026-10-09T18:30:58Z

DocumentationBot: Link directly to the Vertex game connection walkthrough

{{VertexNav}}

Vertex is a level editor for brush geometry, terrain, models, entities, and map scripts. It runs on Windows and macOS. A game's SDK supplies its assets, entity types, compiler, and playtesting tools.

== Start here ==

{| class="wikitable"
! You want to… !! Guide
|-
| Open the editor and save a map || [[Vertex/Getting started]]
|-
| Build geometry, apply materials, and place objects || [[Vertex/Editing]]
|-
| Add sounds, music, textures, models, or shared assets || [[Vertex/Content|Custom content]]
|-
| Connect entity events to actions || [[Vertex/VSig]]
|-
| Use Vertex with a game you are making || [[Vertex/Integrating your game]]
|-
| Create a <code>.vertexsdk</code> connection for your own game || [[Vertex/Integrating your game#Create a .vertexsdk file|Create a .vertexsdk file]]
|-
| Make something for Grimwar || [[Grimwar/Getting started|Grimwar modding]]
|}

== Vertex and your game ==

You can draw geometry and export models without a game SDK. To place game entities or build a playable map, open the SDK supplied by that game's author. Vertex reads the available tools from that connection; installing a different SDK changes the assets and entity types you can use.

For Grimwar, install the Grimwar SDK from Steam's Tools library. Its VSDK launcher sets up the compiler and opens Vertex. Follow [[Grimwar/SDK setup|SDK setup]] before the first map build.

Keep your editable <code>.vertex</code> file, scripts, and imported media together. The exported add-on is a separate build that players install. [[Vertex/Getting started#Keep the source|Keep the source]] even after publishing.

[[Category:Vertex]]

Vertex/Getting started

2026-10-09T18:29:57Z

DocumentationBot: Link directly to the Vertex game connection walkthrough

{{VertexNav}}

Start Vertex from your game's SDK launcher, or open a standalone Vertex installation. The editor does not need a separate .NET installation.

== Connect a game ==

If the SDK launcher has already registered your game, select that game when creating a map. Otherwise choose '''File → Open game SDK…''' and select the installation's <code>.vertexsdk</code> file. Keep the full SDK folder intact: the connection refers to its catalogs and compiler.

You can also choose an SDK under '''Settings → Game and resources'''. The game connection supplies the materials, models, entities, and build actions. An unavailable catalog leaves existing map data in place, but you must reconnect it before editing those properties or building.

Grimwar users should follow [[Grimwar/SDK setup#Install the SDK|Grimwar SDK setup]]. Other games supply their own setup requirements.

For a game you are developing, follow [[Vertex/Integrating your game#Create a .vertexsdk file|Create a .vertexsdk file]]. That guide shows which two text files to create, where to save them, and how to connect them to your Unity project.

== Create or find a map ==

# Create a new map from the welcome screen.
# Save it in a folder you own, outside the SDK installation. Choose a readable filename such as <code>arena_mycustommap.vertex</code>.
# Under '''Settings → Map details''', set '''Title''' to the name players should see, such as <code>My Custom Map</code>.
# Start with a floor and a few walls, then follow [[Vertex/Editing|Editing]].

To find maps in an existing checkout, choose '''File → Welcome… → Open repository…''' and select its root folder. Vertex scans for valid editable maps and adds them to the list. It skips generated builds, backups, and invalid files. This scans local files; it does not download a repository.

Use '''Open''' for an individual <code>.vertex</code> file. A built Unity scene or installed add-on folder is not the editable Vertex source.

== Names and IDs ==

The filename determines the public map ID. <code>arena_mycustommap.vertex</code> uses <code>arena_mycustommap</code>; underscores stay underscores. Use lowercase letters, numbers, and underscores. Spaces and punctuation are normalized to underscores.

'''Title''' is the display name and can change without changing the ID. '''Save As / Copy…''' lets you choose another filename and therefore another map ID. Treat that as a new map when an existing release or another package already depends on the old ID.

Objects inside a map also have persistent internal IDs. Vertex manages those for copying, references, and prefab updates. Give entities readable names in the hierarchy for your scripts.

== Keep the source ==

A typical source folder contains:

<syntaxhighlight lang="text">
arena_mycustommap/
arena_mycustommap.vertex
arena_mycustommap.vsig
thumbnail.png
content.json
Content/
</syntaxhighlight>

The script, thumbnail, and content files appear when you use those features. Keep any attached SDK resources and local prefabs in this folder too. Share or back up the folder, not just the map file. '''Save As''' carries supported companion sources with the map.

Reusable materials, models, and sounds can stay in shared libraries outside this folder. See [[Grimwar/Custom content|Grimwar custom content]] for those workflows; maps reference the library assets they use.

Vertex keeps protected save backups and offers '''File → Recovery and diagnostics…''' for recovery. Recovery snapshots do not include unsaved script edits. Save your scripts before closing the editor or moving the source folder.

Machine-specific SDK and executable paths stay in local preferences or <code><map>.vertex.local.json</code>. Collaborators choose their own installed SDK and game paths.

== Build and play ==

Use the '''Build''' controls supplied by the selected SDK. '''Play in Game''' builds the current source, installs the result, and launches the configured game. '''Export add-on''' builds without launching it. '''Open current output''' finds the generated package.

A failed or cancelled build leaves the previous output available and does not launch it as though the new build succeeded. Read the first build error, correct the source or setup, and build again.

See [[Grimwar/Mapping|Grimwar mapping]] for that game's targets and playtest steps.

[[Category:Vertex]] [[Category:Getting started]]

Vertex/Integrating your game

2026-10-09T18:28:20Z

DocumentationBot: Explain creating a Vertex game connection step by step

Vertex/Integrating your game

2026-10-04T16:30:18Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

Vertex/Getting started

2026-10-04T16:30:15Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

{{VertexNav}}

Start Vertex from your game's SDK launcher, or open a standalone Vertex installation. The editor does not need a separate .NET installation.

== Connect a game ==

If the SDK launcher has already registered your game, select that game when creating a map. Otherwise choose '''File → Open game SDK…''' and select the installation's <code>.vertexsdk</code> file. Keep the full SDK folder intact: the connection refers to its catalogs and compiler.

You can also choose an SDK under '''Settings → Game and resources'''. The game connection supplies the materials, models, entities, and build actions. An unavailable catalog leaves existing map data in place, but you must reconnect it before editing those properties or building.

Grimwar users should follow [[Grimwar/SDK setup#Install the SDK|Grimwar SDK setup]]. Other games supply their own setup requirements.

== Create or find a map ==

# Create a new map from the welcome screen.
# Save it in a folder you own, outside the SDK installation. Choose a readable filename such as <code>arena_mycustommap.vertex</code>.
# Under '''Settings → Map details''', set '''Title''' to the name players should see, such as <code>My Custom Map</code>.
# Start with a floor and a few walls, then follow [[Vertex/Editing|Editing]].

To find maps in an existing checkout, choose '''File → Welcome… → Open repository…''' and select its root folder. Vertex scans for valid editable maps and adds them to the list. It skips generated builds, backups, and invalid files. This scans local files; it does not download a repository.

Use '''Open''' for an individual <code>.vertex</code> file. A built Unity scene or installed add-on folder is not the editable Vertex source.

== Names and IDs ==

The filename determines the public map ID. <code>arena_mycustommap.vertex</code> uses <code>arena_mycustommap</code>; underscores stay underscores. Use lowercase letters, numbers, and underscores. Spaces and punctuation are normalized to underscores.

'''Title''' is the display name and can change without changing the ID. '''Save As / Copy…''' lets you choose another filename and therefore another map ID. Treat that as a new map when an existing release or another package already depends on the old ID.

Objects inside a map also have persistent internal IDs. Vertex manages those for copying, references, and prefab updates. Give entities readable names in the hierarchy for your scripts.

== Keep the source ==

A typical source folder contains:

<syntaxhighlight lang="text">
arena_mycustommap/
arena_mycustommap.vertex
arena_mycustommap.vsig
thumbnail.png
content.json
Content/
</syntaxhighlight>

The script, thumbnail, and content files appear when you use those features. Keep any attached SDK resources and local prefabs in this folder too. Share or back up the folder, not just the map file. '''Save As''' carries supported companion sources with the map.

Reusable materials, models, and sounds can stay in shared libraries outside this folder. See [[Grimwar/Custom content|Grimwar custom content]] for those workflows; maps reference the library assets they use.

Vertex keeps protected save backups and offers '''File → Recovery and diagnostics…''' for recovery. Recovery snapshots do not include unsaved script edits. Save your scripts before closing the editor or moving the source folder.

Machine-specific SDK and executable paths stay in local preferences or <code><map>.vertex.local.json</code>. Collaborators choose their own installed SDK and game paths.

== Build and play ==

Use the '''Build''' controls supplied by the selected SDK. '''Play in Game''' builds the current source, installs the result, and launches the configured game. '''Export add-on''' builds without launching it. '''Open current output''' finds the generated package.

A failed or cancelled build leaves the previous output available and does not launch it as though the new build succeeded. Read the first build error, correct the source or setup, and build again.

See [[Grimwar/Mapping|Grimwar mapping]] for that game's targets and playtest steps.

[[Category:Vertex]] [[Category:Getting started]]

Vertex/Content

2026-10-04T16:30:13Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

{{VertexNav}}

'''Content''' manages files owned by a map or SDK resource and references to assets from other packages. The connected game decides which file types it supports and how those files become usable in the game.

For Grimwar, start with the asset you want to add:

{| class="wikitable"
! Asset !! Guide
|-
| Sounds and music || [[Grimwar/Custom content#Sounds and music|Import audio, choose its playback type, and play it in a map]].
|-
| Textures and materials || [[Grimwar/Custom content/Materials and models#3. Create a wall material|Create a Unity material]].
|-
| Models and prefabs || [[Grimwar/Custom content/Materials and models#4. Import a model and save a prefab|Import a model and save a prefab]].
|-
| Shared libraries and supported formats || [[Grimwar/Custom content|Browse all custom content workflows]].
|}

== Import your files ==

# Save the map, then open '''Settings → Map details → Content…'''. For a standalone resource, open its '''Content…''' controls in VSDK.
# Choose a content type and select '''Import files'''.
# Review the imported names and settings. The SDK may offer controls such as audio playback type or volume.
# Select the new asset in the appropriate material, model, entity, or script field.

Vertex keeps imported source under <code>Content/</code> and records it in <code>content.json</code>. Keep both beside the map or resource manifest. Importing a file makes it available; you still need to place it or reference it.

An asset key identifies the package and asset, for example <code>asset:shared_sounds/my_wind_loop_01</code>. Display names can change without changing that key. Use '''Replace media''' to replace a file while retaining its references. Reimporting it as a new asset creates a different entry.

Models may have companion materials and textures. Keep those files together when importing. '''Rebuild model previews''' refreshes the editor preview after external changes; the game compiler still builds the runtime model.

== Sounds and music ==

Grimwar's '''Sound''' import type accepts WAV, Ogg Vorbis, and MP3. Use it for effects, ambience, announcements, or music. The [[Grimwar/Custom content#Sounds and music|sound walkthrough]] covers playback settings, volume, and selecting a sound on an <code>env_ambient</code> entity. To keep reusable audio outside map folders, [[Grimwar/Custom content#Make a reusable media pack|create a shared media pack]] and use its sound from each map.

== Materials and prefabs authored in Unity ==

For a general selection of custom assets across Grimwar maps, follow [[Grimwar/Custom content/Materials and models|Unity materials and models for Vertex]]. Keep one personal SDK copy in a shared library folder outside your map projects, create assets beneath its <code>Compiler/Assets/CustomContent/</code>, and export its catalog. Connect each map to that same library to select its assets in the Materials and Models browsers. The guide covers each folder and setting with a wall material and a crate prefab. Dropping files into a Unity folder alone does not add them to Vertex, and Content's file importer does not accept <code>.mat</code> or <code>.prefab</code> files.

== Use an installed package ==

Select an installed asset in Content and choose '''Use this package'''. Vertex records the provider's add-on ID and references the asset by key. The resulting build depends on that package and does not include another copy of its files.

The provider must be installed and enabled in the game. Publish and distribute the provider as well as the map or mod that uses it. A different display title or Workshop item number does not replace the stable package ID.

'''Copy files into this package''' creates an owned copy when you want to distribute and maintain the files yourself. References to other packages that you keep using remain dependencies. Check that the asset's terms permit redistribution.

== Check what ships ==

'''Check build contents''' lists selected files, sizes, and the references or inclusion settings that bring them into the build. Use it before publishing a large package.

Enable '''Include in build''' for files used only through dynamically constructed script references. An unchecked asset is still included when the map or another included asset needs it.

Missing providers, cycles, unsupported formats, or changed source files can stop a build. Fix the reported source or dependency and rebuild. Avoid editing the generated package manifest to bypass an error.

For supported formats, a complete sound example, and reusable media packs, see [[Grimwar/Custom content]]. For another game's support, use that game's SDK documentation.

[[Category:Vertex]]

Vertex

2026-10-04T16:30:11Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

{{VertexNav}}

Vertex is a level editor for brush geometry, terrain, models, entities, and map scripts. It runs on Windows and macOS. A game's SDK supplies its assets, entity types, compiler, and playtesting tools.

== Start here ==

{| class="wikitable"
! You want to… !! Guide
|-
| Open the editor and save a map || [[Vertex/Getting started]]
|-
| Build geometry, apply materials, and place objects || [[Vertex/Editing]]
|-
| Add sounds, music, textures, models, or shared assets || [[Vertex/Content|Custom content]]
|-
| Connect entity events to actions || [[Vertex/VSig]]
|-
| Use Vertex with a game you are making || [[Vertex/Integrating your game]]
|-
| Make something for Grimwar || [[Grimwar/Getting started|Grimwar modding]]
|}

== Vertex and your game ==

You can draw geometry and export models without a game SDK. To place game entities or build a playable map, open the SDK supplied by that game's author. Vertex reads the available tools from that connection; installing a different SDK changes the assets and entity types you can use.

For Grimwar, install the Grimwar SDK from Steam's Tools library. Its VSDK launcher sets up the compiler and opens Vertex. Follow [[Grimwar/SDK setup|SDK setup]] before the first map build.

Keep your editable <code>.vertex</code> file, scripts, and imported media together. The exported add-on is a separate build that players install. [[Vertex/Getting started#Keep the source|Keep the source]] even after publishing.

[[Category:Vertex]]

Template:VertexNav

2026-10-04T16:30:09Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

Template:GameNav

2026-10-04T16:30:07Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

Help:Contents

2026-10-04T16:30:02Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

== Reading the wiki ==

Choose [[Vertex]] for editor controls and game integration, [[Grimwar]] for maps and mods, or [[ANEURISM IV]] for community hosting. The sidebar switches products and has direct Grimwar SDK links for maps, custom content, sounds, and materials/models. Links above each guide lead to related topics. Parent-page links below the title take you back up the product hierarchy. Use [[Grimwar/Entities|the entity index]] to look up an exact Grimwar class or search for its name.

For assets, start at [[Grimwar/Custom content]]. Its topic index links to [[Grimwar/Custom content#Sounds and music|sounds and music]], [[Grimwar/Custom content/Materials and models|materials and models]], shared libraries, supported formats, and naming examples. The materials/models guide is a child of Custom content, so its parent link returns to that index.

Start pages cover the usual workflow. VSig and VMod have separate detailed references for larger scripts. Every page has a history showing who changed it and when.

== Editing ==

Staff and approved editors can use either the visual editor or the wikitext editor. Use preview before saving, provide a concise edit summary, and keep each change focused.

== Discussions ==

Use the associated talk page to discuss documentation changes. Sign talk-page comments with <code><nowiki>~~~~</nowiki></code>.

== Common maintenance pages ==

* [[Special:RecentChanges|Recent changes]]
* [[Special:AllPages|All pages]]
* [[Special:Categories|Categories]]
* [[Special:ListFiles|Uploaded files]]
* [[Special:Version|Wiki software and extensions]]

Grimwar/Unity custom content

2026-10-04T16:29:59Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

#REDIRECT [[Grimwar/Custom content/Materials and models]]

Grimwar/SDK setup

2026-10-04T16:29:58Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

{{GameNav}}

The Grimwar SDK includes Vertex for maps, VSDK for setup and standalone resources, and Grimwar's assets and compiler. This wiki is the maintained source for Vellocet SDK guidance.

== Install the SDK ==

# In Steam's Library, enable the '''Tools''' filter and install '''Grimwar SDK'''. Install Grimwar too if you want to playtest.
# Launch the SDK to open VSDK.
# For map builds, install and activate Unity <code>6000.3.17f1</code> through Unity Hub. Add build support for the targets you will use. VSDK detects standard installations; choose the Unity executable if detection misses yours.
# Choose your installed Grimwar executable or macOS app for playtesting.
# Select '''Finish setup and open Vertex'''. Setup prepares a writable compiler cache and registers the game.
# Create a map and save it outside the SDK installation.

Map compilation runs Unity through the SDK. You author in Vertex and play in Grimwar. You do not need to create a Unity project or install a Unity package by hand for this workflow.

A VMod containing only scripts, sounds, or ordinary data can be validated and built without Unity. Imported models, materials, textures, fonts, and video use the Unity compiler. Map lighting also needs a working graphics device.

== Choose a workflow ==

{| class="wikitable"
! What you are making !! Start here
|-
| Map || Open Vertex, then [[Grimwar/Mapping|make a map]].
|-
| Map logic || Open the map's Code workspace and follow [[Grimwar/VSig|VSig]].
|-
| Standalone server mod || In VSDK, select '''VMod''' and '''Create…'''. See [[Grimwar/VMod]].
|-
| C# behavior attached to one map || Use '''Map → SDK resources → VMod → Create…''' in Vertex.
|-
| Reusable media || In VSDK, select '''Media pack''', create it, and open '''Content…'''. See [[Grimwar/Custom content]].
|-
| Sounds, ambience, or music || Follow [[Grimwar/Custom content#Sounds and music|Sounds and music]] for importing audio, sharing it across maps, and playing it in the game.
|-
| Shared custom materials, models, and prefabs || Follow [[Grimwar/Custom content/Materials and models]] to keep one asset library outside your map folders. Author assets in its <code>Compiler/Assets/CustomContent/</code> and connect your maps to the same Materials and Models selection.
|}

== Files and updates ==

Keep your maps, scripts, thumbnails, <code>content.json</code>, and imported files together in a source folder you control. Keep build output separate. Steam can replace SDK files during an update.

Update the complete SDK through Steam and launch VSDK again. Do not mix an editor executable from one SDK release with the catalogs or compiler from another. Your source files and local preferences stay outside the installation.

In Vertex, use '''Settings → Game and resources → Reload resources''' after changing or refreshing the game connection. Engine and game executable paths are under '''Build → Advanced'''. Standalone Vertex can open the same installation through '''File → Open game SDK…'''.

== Build profiles ==

Vertex's '''Preview''' profile builds for local testing on the selected platform. VSDK calls its local standalone-resource output a Development package. These packages are for testing and cannot be published to Workshop.

'''Release''' map exports include Windows client, macOS client, and Linux dedicated-server artifacts. Install the matching Unity build modules. The SDK enforces the required navigation, spatial, occlusion, and lighting policy.

Choose a 1920 × 1080 thumbnail before publishing. Vertex maps accept PNG or JPEG through '''Map → Thumbnail'''; standalone VMods use a PNG path in <code>mod.json.thumbnail</code>. A map can compile without artwork, but Workshop publication requires it. See [[Grimwar/Steam Workshop addons]].

== If you are integrating your own game ==

Read [[Vertex/Integrating your game]]. Your game supplies its own catalogs, entity behavior, compiler, and runtime loader. A local developer connection can offer '''Save to Unity''' for that game project. Grimwar's public SDK supplies a compiler, so its community workflow is '''Export add-on''' and '''Play in Game'''.

[[Category:Grimwar]]

Grimwar/Mapping

2026-10-04T16:29:56Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

{{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/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>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. 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 ==

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 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.

== 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 ==

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]].

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 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]]

Grimwar/Getting started

2026-10-04T16:29:55Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

{{GameNav}}

Install the [[Grimwar/SDK setup|Grimwar SDK]], then choose a small first project.

== A first map ==

# Open Vertex from VSDK and save a map as <code>arena_mycustommap.vertex</code> in your own source folder.
# Draw a floor and a few walls. Apply a material from the Grimwar catalog.
# Add <code>info_player_spawn</code> points for Order and Union. Keep them above the floor with room to stand.
# For a first King of the Hill test, add a neutral <code>game_capture_point</code>.
# Open Build, choose '''Preview''' and your platform, then '''Play in Game'''.
# In Grimwar, host the map with '''Local''' access and test movement, spawns, and the capture point.

Continue with [[Grimwar/Mapping|Mapping]] for map naming, entities, thumbnails, and Release builds. [[Vertex/Editing]] covers the editor controls.

== A custom sound ==

Open '''Map → Content…''', choose '''Sound''', and import a WAV, Ogg Vorbis, or MP3 file. Select an appropriate playback type, then assign it to an <code>env_ambient</code> entity's '''Custom Cue'''. Build and play the map to hear it.

[[Grimwar/Custom content]] explains looping sounds, reusable packs, dependencies, and using the same media from a VMod.

== A server mod ==

In VSDK, select '''VMod''' and '''Create…'''. Edit the generated source, validate it, then build and playtest. A script-only VMod does not need Unity. Follow [[Grimwar/VMod]] for a working command example and map-bound scripts.

== Share your work ==

Keep the editable source. Distribute the generated add-on folder, or build Release and publish it through Grimwar's Addons screen. See [[Grimwar/Steam Workshop addons|Workshop publishing]].

[[Category:Grimwar]] [[Category:Getting started]]

Grimwar/Custom content

2026-10-04T16:29:52Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

{{GameNav}}

Custom content includes '''sounds and music, textures and materials, models and prefabs''', plus fonts, video, and data. Start with the kind of asset you want to add:

{| class="wikitable"
! Content !! Guide
|-
| Sounds, ambient audio, and music || [[#Sounds and music|Import and play audio]], including playback types and volume.
|-
| Textures and Unity materials || [[Grimwar/Custom content/Materials and models#3. Create a wall material|Create a material]] in your shared asset library.
|-
| Models and prefabs || [[Grimwar/Custom content/Materials and models#4. Import a model and save a prefab|Import a model, assign materials, and add collision]].
|-
| One Materials and Models selection for all your maps || [[Grimwar/Custom content/Materials and models|Set up a shared Unity asset library]] outside map folders.
|-
| Shared sounds and other imported media || [[#Make a reusable media pack|Create a media pack]] and reference it from your maps or mods.
|-
| Audio and data in C# mods || [[#Use media in a VMod|Use media in a VMod]].
|-
| File extensions, size limits, and naming || [[#Supported imports|Supported imports]] and [[#Naming examples|naming examples]].
|}

Keep reusable source assets in a general library outside your map folders. Use a Unity asset library for authored materials and prefabs, or a media pack for imported sounds and other supported files. Vertex's map Content window also supports files owned by one map. The SDK builds the required assets and records package dependencies.

== Sounds and music ==

Import audio through the '''Sound''' type in Vertex or VSDK. It accepts '''WAV, Ogg Vorbis, and MP3''', with a 32 MiB limit per source. Playback settings cover sound effects, ambience, announcements, and music; you do not need to create Unity materials or export a model catalog for audio.

For sounds shared across maps, first [[#Make a reusable media pack|create a media pack]] in your general source library, then select its sound in the map's Content window and choose '''Use this package'''. Place an <code>env_ambient</code> entity and select that sound in '''Custom Cue''', as in the placement steps below. Your original audio stays in the pack's source folder.

The following example imports a sound owned by one map. The same playback and entity controls apply when selecting a sound from a shared pack.

=== Add a sound to a map ===

# Save the map, for example <code>arena_mycustommap.vertex</code>.
# Open '''Settings → Map details → Content…''', choose '''Sound''', then '''Import files'''. Select <code>my_wind_loop_01.wav</code>.
# Set '''Playback''' to '''AmbientLoop''' for a looping sound with a world position. Adjust '''Volume''' between 0 and 1.
# Place an [[Grimwar/Entities/env_ambient|env_ambient]] entity and select the imported sound in '''Custom Cue'''. Leave '''Play On Start''' enabled to hear it when the map loads.
# Build with '''Play in Game''' and check the volume and placement in Grimwar.

The imported sound has a key such as <code>asset:arena_mycustommap/my_wind_loop_01</code>. Custom Cue takes priority over the entity's base-game Event Name. You do not need to build Wwise banks or write an audio manifest.

The source stays under <code>Content/</code>, with its settings in <code>content.json</code>. Keep both with the map. Use '''Replace media''' to update the sound without changing its key.

=== Pick the playback type ===

{| class="wikitable"
! Type !! Use
|-
| Announcer || Non-spatial announcements.
|-
| Sfx2D || A non-spatial one-shot sound.
|-
| Sfx3D || A one-shot sound at a world position.
|-
| AmbientLoop || A looping sound at a world position.
|-
| MusicLoop || Looping music.
|-
| Ambience2DLoop || Looping non-spatial ambience.
|}

For a sound that starts from a door or objective, disable Play On Start and call the ambient entity from a client VSig handler. See [[Grimwar/VSig#Server and client logic|Server and client logic]].

An ambient entity's '''Audible Distance''' is its emitter radius, not a guaranteed cutoff distance. Point mode stays at the marker. Volumetric mode follows the nearest boundary of its oriented box when the listener is outside and plays in 2D inside.

For Grimwar's built-in loading and gameplay score, see [[Grimwar/Mapping#Optional map settings and music|Map Settings and music]]. Importing an audio file does not add it to the built-in Music Set choices.

== Make a reusable media pack ==

# Open VSDK and select '''Media pack''', then '''Create…'''. Choose a new source folder outside the SDK installation, such as <code>shared_sounds</code>. The folder name becomes the pack's stable ID.
# Open '''Content…''' and set its title, author, and version.
# Import your files and choose their settings. Mark assets intended for other packages with '''Include in build'''.
# Select '''Check build contents''' and review the file list and size.
# Build into Grimwar's add-on folder and enable the package in the game.

In another map or VMod's Content window, select an installed asset from this pack and choose '''Use this package'''. A reference such as <code>asset:shared_sounds/my_wind_loop_01</code> points to the provider. The consuming build records <code>shared_sounds</code> as a requirement and leaves the sound bytes in the provider's package.

Install and enable both packages to test them. Publish the media pack first, then the map or mod that depends on it. Keep the provider ID and asset keys stable in updates. Removing or renaming a published key can break consumers even if the pack's display title stays the same.

Choose '''Copy files into this package''' when you want an independent copy you can edit and distribute. Check the creator's redistribution terms first. Other external references still keep their own dependencies.

== Use media in a VMod ==

Open the VMod's '''Content…''' controls in VSDK. For an attached VMod, select it under the map's SDK resources and use that resource's Content button. Importing there gives the script local names for its own assets.

For a sound imported as <code>my_round_start_01</code> with the Announcer or Sfx2D playback type:

<syntaxhighlight lang="csharp">
var result = context.Audio.PlayToAll("my_round_start_01");
if (!result.Success)
context.Log.Warn(result.Message);
</syntaxhighlight>

Use a full asset key for a sound from a shared pack:

<syntaxhighlight lang="csharp">
var result = context.Audio.PlayFromPlayer(
playerId, "asset:shared_sounds/my_wind_loop_01", 0.5f);
</syntaxhighlight>

Here <code>context</code> is the <code>IModContext</code> saved in <code>OnLoad</code>, and <code>playerId</code> identifies a connected player. This second example needs an AmbientLoop or Sfx3D cue. <code>PlayFromPlayer</code> uses the player's authoritative pawn position. Save <code>result.Value</code> from a successful play if you need to stop it later with <code>context.Audio.Stop</code>.

<code>PlayToAll</code> and <code>PlayToPlayer</code> accept non-spatial cue types. <code>PlayAt</code> and <code>PlayFromPlayer</code> accept Sfx3D and AmbientLoop. Playback gain multiplies the cue's own volume.

Use '''Use this package''' to record a selected provider. When declaring a dependency directly in a VMod manifest, put its add-on ID in <code>requires</code>. <code>dependencies</code> instead lists VMod IDs for script load order.

API 15 also exposes declared text/data through <code>Content</code>:

<syntaxhighlight lang="csharp">
string rules;
if (context.Content.TryReadText("rules", out rules))
context.Log.Write(rules);
</syntaxhighlight>

Import the file through the resource's Content window and keep it included in the build. <code>Content.Describe(key)</code> reads asset metadata. These APIs operate on declared assets; they do not give a VMod access to arbitrary files.

== Supported imports ==

{| class="wikitable"
! Type !! Source formats !! Notes
|-
| Sound || WAV, Ogg Vorbis, MP3 || Up to 32 MiB per source. Set the playback type and volume.
|-
| Surface material || PNG, JPG/JPEG, TGA || Creates a surface material from an image. Up to 16 MiB per source.
|-
| Image / texture || PNG, JPG/JPEG, TGA || Up to 16 MiB per source. Select the type the consuming field expects.
|-
| Model || FBX, OBJ || Import supported MTL and image companions alongside it. Review scale and collision.
|-
| Font || TTF, OTF || Requires a supported game consumer.
|-
| Video || MP4, WebM, MOV || Requires a supported game consumer; importing a clip does not place a video screen.
|-
| Text / data || TXT, JSON, CSV, Markdown || Up to 8 MiB per source; usable through the VMod Content API.
|-
| Binary data || BIN || Packaged data for supported consumers, not executable code.
|}

Native Unity media, including models, materials, textures, fonts, and video, needs the SDK's pinned Unity compiler and target modules. Sounds and ordinary data use platform-independent files. Import support does not imply that every entity or VMod service can consume every type.

== Naming examples ==

Use lowercase names with underscores for map and custom asset files. Give asset variants a numbered suffix such as <code>_01</code>. These examples use the same names throughout the guides:

{| class="wikitable"
! Asset !! Example
|-
| Map and companion script || <code>arena_mycustommap.vertex</code> and <code>arena_mycustommap.vsig</code>
|-
| Wall material || <code>my_brick_wall_01.mat</code>
|-
| Color texture || <code>my_brick_wall_01_basecolor.png</code>
|-
| Crate material, model, and prefab || <code>my_crate_01.mat</code>, <code>my_crate_01.fbx</code>, and <code>my_crate_01.prefab</code>
|-
| Ambient sound || <code>my_wind_loop_01.wav</code>
|-
| Catalog profile and exported catalog || <code>my_custom_assets.asset</code> and <code>my_custom_assets.vertexassets</code>
|}

The map filename determines its ID: <code>arena_mycustommap.vertex</code> exports as <code>arena_mycustommap</code>. A readable display title such as '''My Custom Map''' is separate. Keep existing asset keys, catalog IDs, and Unity <code>.meta</code> files stable when updating published work. Keep supplied SDK files and folders at their installed names.

== Keep builds small and repeatable ==

Use '''Check build contents''' to see what is included and why. Unreferenced files can stay in your source folder without shipping. '''Include in build''' keeps an asset available when code chooses its key at runtime; a referenced asset is included even if that checkbox is off.

Keep model companion files together. Use '''Rebuild model previews''' after editing a model externally. Rebuild the package after any source change; the compiler reuses matching verified output where it can.

Avoid copying the same large library into every map. Put shared assets in a media pack when you want a common update and dependency. Use an owned copy when a map needs to keep its own version.

== Artwork and distribution ==

Set a media pack's title, author, version, and PNG thumbnail in Content. Use a 1920 × 1080 thumbnail for Release. Enable '''Release package''' in VSDK, build, and publish the result as '''Content''' from Grimwar's Addons screen.

Keep the entire output folder, including its generated <code>addon.json</code> and catalogs. The editable <code>content.json</code> is source; it is not an installable package by itself. See [[Grimwar/Steam Workshop addons]] for dependencies and updates.

[[Category:Grimwar]] [[Category:Addons]]

Grimwar/Addons

2026-10-04T16:29:51Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

{{GameNav}}

An add-on is a complete package folder containing <code>addon.json</code> and its declared files. It can provide a map, a VMod, audio, other media, or a supported combination. Install the whole folder; a loose <code>.vertex</code>, scene, script, or resource manifest is not an installed add-on.

== Install from Workshop ==

# Launch Grimwar through Steam.
# Open '''Addons → Browse Steam Workshop''', or visit [https://steamcommunity.com/app/4219460/workshop/ Grimwar Workshop].
# Subscribe to the item and wait for Steam to finish installing it.
# Return to Addons and confirm the package is valid and enabled.
# Install and enable its required packages too. For a map, open Host and select it.

Steam manages subscribed files. Keep your own editable source outside those folders. When joining a server, Grimwar checks the required add-on IDs and exact build IDs before completing the join.

== Install a local package ==

Copy the built package folder into the user add-on library, or build there directly from Vertex/VSDK:

{| class="wikitable"
! Platform !! Default library
|-
| Windows || <code>%LOCALAPPDATA%/Vellocet/Grimwar/addons</code>
|-
| macOS || <code>~/Library/Application Support/Vellocet/Grimwar/addons</code>
|-
| Linux || <code>$XDG_DATA_HOME/Vellocet/Grimwar/addons</code>, or <code>~/.local/share/Vellocet/Grimwar/addons</code> when XDG_DATA_HOME is unset.
|}

For example, the installed manifest for <code>arena_mycustommap</code> is <code>addons/arena_mycustommap/addon.json</code>. Choose the parent add-on library as a build output root, not the package's child folder.

A separate test library can be supplied with <code>--addon-root</code> or <code>GRIMWAR_ADDON_ROOT</code>. Vertex's Play in Game supplies the configured library. A custom data root changes the normal user-library location; server operators can use <code>vmod_runtime_paths</code> to find it.

== Use the Addons screen ==

{| class="wikitable"
! Action !! Result
|-
| Enable / Disable || Allow or prevent mounting the package.
|-
| Use This Copy || Select a particular local or Workshop copy with the same add-on ID.
|-
| Open Folder || Find an installed disk-backed package.
|-
| Download/Update || Request the current Workshop build.
|-
| View on Steam || Open its Workshop page.
|-
| Publish / Update || Publish an eligible local Release package.
|}

Grimwar groups copies by the stable add-on ID. An external test folder normally takes priority over Workshop, which takes priority over the manual library. Use This Copy overrides that choice. Only one copy of an ID is mounted.

If your latest edit does not appear, check which copy is selected. Built-in map IDs cannot be replaced by an add-on. Give a new map its own readable filename and ID.

== Test an unpublished map ==

Build Preview in Vertex and select '''Play in Game'''. In Grimwar, confirm the local package is selected, then open '''Host'''. Returning to Host rescans the folders.

An unpublished map has no guest download source. Grimwar uses '''Local''' access and '''Test Map''' for that session. Publish a Release package to Workshop before inviting players who need to acquire it.

== Dependencies and shared assets ==

A package's <code>requires</code> entries are stable add-on IDs. The required providers must be installed, valid, and enabled. Missing packages, dependency cycles, and conflicting copies prevent loading.

Use Content in Vertex or VSDK to select an installed asset and choose '''Use this package'''. It records the requirement and keeps the provider's media in that provider. See [[Grimwar/Custom content#Make a reusable media pack|reusable media packs]].

In a VMod manifest, <code>requires</code> means add-on content dependencies. <code>dependencies</code> means VMod load order. Neither field takes Steam Workshop numbers or generated build IDs.

== Browse reusable content ==

Use the Content window while authoring. In Grimwar, the console command <code>audio_browser</code> opens the mounted audio catalog. <code>content_browser audio</code> opens the same view.

Use KIND, FILTER, and SOURCE to find a cue. Select it to inspect the provider, version, build, and source; Preview plays supported audio. Copy reference gives its cue/event reference, and Copy dependency gives its provider add-on ID. Refresh after changing mounted packages.

This game browser shows mounted content. It does not import files. Use Vertex/VSDK Content to import your own files. Base-game <code>Play_amb...</code> events can be used by ambient entities; internal <code>Play_User_...</code> routes are not custom cue IDs.

== VMods and dedicated servers ==

Standalone VMods run for the server session. Attached VMods load and unload with their map. Both execute on the server, even when a client carries the source in a Workshop download.

For a manual server install, copy the complete package into the server's add-on directory. Restart, or use <code>vmod_runtime_reload</code> after unloading map-bound scripts and leaving scripted game modes. Check <code>vmod_runtime_list</code> for failures.

Dedicated servers acquire Workshop items through <code>config/server-addons.json</code>. Use <code>items</code> for direct item IDs, <code>collections</code> for Workshop collections, and <code>manualItems</code> only for manually staged packages that need a matching Workshop identity. See [[Grimwar/Dedicated servers#Install Workshop add-ons|server setup]].

== Package errors ==

Keep the build output intact. Generated manifests record file sizes, hashes, and platform artifacts. If a package was edited, partially copied, or built for an unsupported version, rebuild or reinstall it.

For a local map, check the chosen copy, required packages, and target platform first. [[Grimwar/Troubleshooting]] covers build and runtime failures.

[[Category:Grimwar]] [[Category:Addons]]

Grimwar

2026-10-04T16:29:50Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

{{GameNav}}

Find guides for using add-ons, making maps and mods, and hosting Grimwar servers.

== Create maps and mods ==

Start with [[Grimwar/SDK setup|SDK setup]], then follow [[Grimwar/Getting started|your first project]]. The Grimwar SDK includes [[Vertex]], game assets, entities, and build tools.

{| class="wikitable"
! Goal !! Guide
|-
| Build and play a map || [[Grimwar/Mapping]]
|-
| Browse custom asset workflows and supported formats || [[Grimwar/Custom content]]
|-
| Add sounds, ambience, or music || [[Grimwar/Custom content#Sounds and music|Sounds and music]]
|-
| Create textures, materials, models, or prefabs || [[Grimwar/Custom content/Materials and models|Materials and models]]
|-
| Share audio and other imported files across maps || [[Grimwar/Custom content#Make a reusable media pack|Media packs]]
|-
| Look up an entity and its settings || [[Grimwar/Entities]]
|-
| Connect triggers, doors, and round events || [[Grimwar/VSig]]
|-
| Write server commands or a custom game mode || [[Grimwar/VMod]]
|-
| Publish a map, VMod, or content pack || [[Grimwar/Steam Workshop addons]]
|}

== Play and host ==

{| class="wikitable"
! Goal !! Guide
|-
| Install maps and mods, manage dependencies, or select a local build || [[Grimwar/Addons|Using add-ons]]
|-
| Run a community server || [[Grimwar/Dedicated servers]]
|}

== Get help ==

If a setup, build, or playtest fails, start with [[Grimwar/Troubleshooting]].

These guides describe the SDK with Vertex and VMod API 15. Update the game and SDK together. The SDK launcher reports the required Unity version; current Grimwar map builds use <code>6000.3.17f1</code>.

[[Category:Grimwar]]

Grimwar/Custom content/Materials and models

2026-10-04T16:29:48Z

DocumentationBot: Clarify custom content navigation and standardize asset examples

{{GameNav}}

[[Grimwar/Custom content|← All custom content]] · [[Grimwar/Custom content#Sounds and music|Sounds and music]] · [[Grimwar/Custom content#Make a reusable media pack|Shared media packs]]

Build one personal asset library for Vertex's '''Materials''' and '''Models''' browsers. Every map connected to that library can select the same custom materials, models, and prefabs. This walkthrough adds a wall material and a crate prefab to that shared selection.

For custom sounds, ambient audio, and music, follow [[Grimwar/Custom content#Sounds and music|Sounds and music]]. Audio uses the '''Sound''' import type and can live in a shared media pack outside your map folders.

'''Keep the library in <code>Documents/GrimwarLibrary/</code>, and create your assets under its <code>Compiler/Assets/CustomContent/</code> folder.''' Keep map projects separately, for example under <code>Documents/GrimwarMaps/</code>. Set up the library once, export its catalog, and connect your maps to the same SDK copy. A folder alone does not register its contents with Vertex.

Use this library for textures, Unity <code>.mat</code> files, models, and <code>.prefab</code> files that you want in your general selection. Vertex's '''Settings → Map details → Content…''' imports files into the map's own source folder; those imports are covered separately by [[Grimwar/Custom content]]. Content's file importer does not accept <code>.mat</code> or <code>.prefab</code> files.

== 1. Set up your shared asset library ==

# Complete [[Grimwar/SDK setup|SDK setup]]. Install Unity <code>6000.3.17f1</code> and the build modules you need.
# In Steam, open Grimwar SDK's '''Manage → Browse local files'''. Locate <code>Grimwar.vertexsdk</code> and its sibling <code>Compiler</code> and <code>Authoring</code> folders.
# Copy that SDK folder, with all its contents, to <code>Documents/GrimwarLibrary/</code> outside Steam. This is your shared working copy for all your maps; create it once.
# Keep your Vertex maps in separate folders, for example <code>Documents/GrimwarMaps/arena_mycustommap/arena_mycustommap.vertex</code> and <code>Documents/GrimwarMaps/arena_mysecondmap/arena_mysecondmap.vertex</code>. Both will use the same library.
# In Unity Hub, add the existing project at <code>Documents/GrimwarLibrary/Compiler</code> and open it with the pinned Unity version. Select '''Compiler''', not its parent folder or its <code>Assets</code> folder. Let package resolution, script compilation, and asset imports finish.
# For Unity's scene and material previews, open '''Edit → Project Settings → Graphics'''. If '''Default Render Pipeline''' is empty, assign the supplied <code>Assets/VertexSdk/Rendering/Pipeline.asset</code>. Keep the SDK's quality settings. See [https://docs.unity3d.com/6000.3/Documentation/Manual/srp-setting-render-pipeline-asset.html Unity's render pipeline settings].

'''Checkpoint:''' Unity's Project window shows <code>Assets</code>, including <code>CustomContent</code> and <code>VertexSdk</code>. Resolve any Console errors before continuing. This is the SDK's asset-authoring and compiler project; playtest the map in Grimwar.

The Steam installation and Vertex's generated compiler cache are replaceable. Neither is a place to keep your original work. Keep the SDK's supplied packages and base assets intact in your working copy.

== 2. Create the content folders ==

In Unity's '''Project''' window, expand <code>Assets/CustomContent</code>. Right-click it and use '''Create → Folder''' to create <code>Textures</code>, <code>Materials</code>, <code>Models</code>, and <code>Prefabs</code> directly inside it. These folders belong to your general asset library. You can add subfolders for themes or asset packs as the library grows.

After completing the guide, your files will look like this. Unity also creates <code>.meta</code> files beside assets and folders; keep those files.

<pre>
Documents/
GrimwarMaps/
arena_mycustommap/
arena_mycustommap.vertex
arena_mysecondmap/
arena_mysecondmap.vertex
GrimwarLibrary/ shared by both maps
Grimwar.vertexsdk
Authoring/
Grimwar.vertexgame
my_custom_assets.vertexassets exported catalog
previews/ generated catalog previews
Compiler/ open this folder in Unity Hub
Assets/
CustomContent/
my_custom_assets.asset catalog profile created in step 5
Textures/
my_brick_wall_01_basecolor.png
my_crate_01_basecolor.png
Materials/
my_brick_wall_01.mat
my_crate_01.mat
Models/
my_crate_01.fbx
Prefabs/
my_crate_01.prefab
VertexSdk/ supplied SDK assets
Packages/
ProjectSettings/
</pre>

<code>Assets/CustomContent</code> is the path '''inside Unity'''. <code>Documents/GrimwarLibrary/Compiler/Assets/CustomContent</code> is the same folder on disk. <code>Authoring</code> is outside the Unity project's <code>Assets</code> folder. Neither map folder contains the library's source assets.

A '''texture''' is an image. A '''material''' combines a shader, textures, and surface settings. A '''model''' supplies meshes. A '''prefab''' saves a model's hierarchy, assigned materials, and components such as colliders. Vertex uses the material on a brush face and the model or prefab as a placed object.

Use lowercase names with underscores and numbered asset variants, as shown in the [[Grimwar/Custom content#Naming examples|naming examples]]. Keep the supplied SDK filenames and folder names unchanged.

== 3. Create a wall material ==

# Drag <code>my_brick_wall_01_basecolor.png</code> from your file manager into <code>Assets/CustomContent/Textures</code> in Unity's Project window. Wait for import to finish.
# Right-click the <code>Materials</code> folder and choose '''Create → Material'''. Name it <code>my_brick_wall_01</code>; Unity saves <code>my_brick_wall_01.mat</code> there.
# Select the material. In the Inspector, set '''Shader''' to '''Universal Render Pipeline/Lit'''. Use '''Surface Type: Opaque''' for an ordinary solid wall.
# Drag the imported image into '''Base Map''' under Surface Inputs. Leave the adjacent color white to use the image's original colors.
# For a plain non-metallic wall, start with '''Metallic: 0''' and '''Smoothness: 0'''. Increase Smoothness only if you want a shinier surface. For a matte surface without specular shine, also disable '''Specular Highlights''' and '''Environment Reflections''' under Advanced Options.
# If you have a normal map, import it into <code>Textures</code>, select that texture, set '''Texture Type: Normal map''', and click '''Apply'''. Assign it to the material's '''Normal Map''' field. A normal map is optional.
# Save your project changes. The asset you will choose in Vertex is '''my_brick_wall_01''', the material, rather than the raw PNG.

Use an SDK-supported shader such as URP/Lit. A custom material can use that shader with your own textures and settings; add-on maps cannot bring arbitrary custom shaders or Shader Graph shaders from <code>Assets</code>.

'''Checkpoint:''' <code>Materials/my_brick_wall_01.mat</code> exists and its Base Map references your texture. Vertex's preview shows basic color and transparency; judge normal maps, reflections, and final lighting in the compiled game. For the remaining material controls, see [https://docs.unity3d.com/6000.3/Documentation/Manual/urp/lit-shader.html Unity's URP Lit reference].

== 4. Import a model and save a prefab ==

# Export a model such as <code>my_crate_01.fbx</code> from your modeling tool. Use metres, a deliberate pivot, and UVs for the material. Put its image files in your <code>Textures</code> folder and the model in <code>Models</code>.
# Select <code>my_crate_01.fbx</code> in Unity's Project window. Check its import scale and orientation. Apply changed import settings. As a size check, compare it with a Unity cube, which is one unit across at scale 1; one Unity unit represents one metre here.
# Create <code>Materials/my_crate_01.mat</code> using the material steps above and its own Base Map. If the model already contains embedded materials, its '''Materials''' import tab can '''Extract Materials…''' into your <code>Materials</code> folder. Check extracted materials' shaders and texture assignments. See [https://docs.unity3d.com/6000.3/Documentation/Manual/FBXImporter-Materials.html Unity's model material settings].
# Drag <code>my_crate_01.fbx</code> from the Project window into a temporary scene. On each relevant Mesh Renderer, assign <code>my_crate_01.mat</code> to its '''Materials''' slots. For a model with several submeshes, assign the material for each slot.
# For a solid crate, add a '''Box Collider''' and adjust its Center and Size to fit. A renderer alone does not make an object solid. Keep the example a static prop; arbitrary custom C# components are not a substitute for supported Grimwar entities or map scripts.
# Name the scene object <code>my_crate_01</code>. Drag it from the '''Hierarchy''' into <code>Assets/CustomContent/Prefabs</code> in the '''Project''' window. If Unity asks whether to create an Original Prefab or Prefab Variant, choose '''Original Prefab''' for this example. This creates <code>my_crate_01.prefab</code>. See [https://docs.unity3d.com/6000.3/Documentation/Manual/CreatingPrefabs.html Unity's prefab creation guide].
# Select the saved prefab in the Project window and confirm it contains the renderer's material assignments and the collider. Later changes must be saved to this prefab, not left only on a scene instance.

'''Checkpoint:''' <code>Prefabs/my_crate_01.prefab</code> is the assembled prop you will place in Vertex. The raw <code>Models/my_crate_01.fbx</code> can also appear in the browser, but choosing it does not include overrides or colliders that you added only to the prefab.

Keep the model, prefab, materials, and textures beneath <code>Assets/CustomContent</code>. To reuse a model's material on brush faces, use a separate <code>.mat</code> file: embedded model materials are hidden from Vertex's material picker.

== 5. Export a catalog for Vertex ==

A catalog tells Vertex which assets exist and provides their previews. The original Unity assets remain in <code>Compiler/Assets</code> for the map compiler to use.

# In the Project window, right-click <code>Assets/CustomContent</code> and choose '''Create → Vertex → Asset catalog profile'''. Name the asset <code>my_custom_assets</code>.
# Select it and set '''Catalog Id''' to <code>my_library.assets</code> and '''Catalog Version''' to <code>1</code>. Keep these values stable as you edit this asset library.
# Expand '''Folders''' in the Inspector and add one element. Set that element's '''Folder''' to <code>Assets/CustomContent</code> and '''Ownership''' to <code>custom</code>.
# Enable '''Materials''', '''Models''', '''Prefabs''', and '''Textures''' for that element. Leave '''Material Dependencies Only''' disabled so your standalone materials appear in the picker. Leave the other settings at their defaults.
# Save the project. With <code>my_custom_assets</code> still selected, choose '''Tools → Vertex → Export Selected Asset Catalog'''.
# In the save dialog, navigate out of <code>Compiler</code> to your copy's <code>Authoring</code> folder. Save as <code>my_custom_assets.vertexassets</code>. The exporter also writes a <code>previews</code> folder beside it.

'''Checkpoint:''' Both <code>GrimwarLibrary/Authoring/my_custom_assets.vertexassets</code> and its preview files exist. Keep the catalog and previews together. Do not replace the supplied <code>Assets/VertexSdk/Assets.asset</code> profile or the base-game catalog.

Use <code>custom</code> ownership for your own files. <code>base</code> means the asset already ships with Grimwar; it does not mean “shared between my maps.” Incorrectly marking a new asset as base prevents the map from carrying the asset players need. You do not need to add your files to the base game's Addressables groups.

== 6. Connect your maps to the shared library ==

Edit the library's connection once, then choose it for each map. Two small JSON edits connect its editable Unity project and exported catalog. Use a plain-text editor, preserve the other fields, and keep the original files as backups outside the Unity <code>Assets</code> folder.

=== Tell Vertex to build from your Unity project ===

Open <code>Documents/GrimwarLibrary/Grimwar.vertexsdk</code> in a text editor.

# Keep <code>"compilerProject": "Compiler"</code>.
# Remove the <code>compilerInputs</code> property and its value. That inventory describes the unmodified distributed SDK.
# Add <code>"editorProject": "Compiler"</code> alongside <code>compilerProject</code>.
# Preserve <code>formatVersion</code>, <code>game</code>, and any <code>resourceTools</code> entries exactly as supplied. Separate neighboring properties with commas and leave no trailing comma before <code>}</code>.

The two project properties should now read as follows. This fragment shows only those properties; '''do not replace the whole file''' with it.

<syntaxhighlight lang="json">
{
"compilerProject": "Compiler",
"editorProject": "Compiler"
}
</syntaxhighlight>

This makes the copy a local developer connection: Vertex captures the saved assets from your <code>Compiler</code> project when building. Leaving the distributed connection unchanged would use its prepared compiler cache instead.

=== Add your catalog to the game's asset list ===

Open <code>Documents/GrimwarLibrary/Authoring/Grimwar.vertexgame</code>. Find the <code>assetCatalogs</code> array. Keep every existing entry, including <code>grimwar.base</code>. Add a comma after its last existing entry, then insert this additional object before the array's closing <code>]</code>:

<syntaxhighlight lang="json">
{
"id": "my_library.assets",
"version": "1",
"path": "my_custom_assets.vertexassets"
}
</syntaxhighlight>

The path is relative to <code>Authoring/Grimwar.vertexgame</code>, so do not prepend <code>Authoring/</code> again. Keep the game's ID, version, entity catalogs, and build configuration unchanged. The new entry's ID and version must match the Unity catalog profile from step 5.

=== Choose this connection in Vertex ===

# Save both JSON files and your Unity asset changes. Let Unity finish importing.
# Open your map in Vertex. Under '''Settings → Game and resources''', select '''Choose game SDK…'''. Choose <code>Documents/GrimwarLibrary/Grimwar.vertexsdk</code>, the file in your shared library. '''File → Open game SDK…''' opens the same chooser.
# Save the map. Open your other maps and choose that same connection. Saved maps remember their own SDK connection; each map can reference this one library without another SDK copy or asset import.
# Use '''Settings → Game and resources → Reload resources''' after subsequent catalog exports.

'''Checkpoint:''' Open either example map. Its '''Materials''' browser contains <code>my_brick_wall_01</code> and its '''Models''' browser contains your crate entries. Both maps select from the same library. Base-game materials and entities should still be available. If the base assets disappear, restore the original entries in <code>assetCatalogs</code>.

Do not use '''Load engine assets…''' as a substitute for this setup. Loading a loose preview catalog does not connect a map's compiler to the Unity source assets.

== 7. Use the assets and test the add-on ==

# In Vertex's material browser, search for <code>my_brick_wall_01</code>. Drag it onto a brush face; hold '''Shift''' while dropping to apply it to the whole brush. Adjust the face's texture scale and alignment as needed.
# In the model browser, search for <code>my_crate_01</code>. Choose the entry whose source is <code>Prefabs/my_crate_01.prefab</code> and drag it into a viewport. Place it, then check its size and orientation.
# Save the map. In Build, select '''Preview''' and your desktop platform, then '''Play in Game'''. If requested, select the pinned Unity executable and your Grimwar installation in the build settings.
# Walk around the crate in Grimwar to check collision. Inspect the wall's tiling, material, and lighting. Test the actual game even when the Vertex preview looks correct.
# When ready, use '''Export add-on''' with the Release profile and follow [[Grimwar/Steam Workshop addons|the publication guide]].

The build includes referenced custom Unity assets and their required custom dependencies. The exported catalog is a browser index, not an installable add-on; distribute the built add-on rather than loose <code>.mat</code>, <code>.prefab</code>, or <code>.vertexassets</code> files. Players do not need your Unity project to play the compiled map.

Grimwar's SDK still uses '''Play in Game''' and '''Export add-on''' with this connection. It does not provide the base game's playable Unity project or a '''Save to Unity''' workflow.

== Updating assets, sharing source, and SDK updates ==

For each edit: '''change the Unity asset → save/apply it → export my_custom_assets to the same my_custom_assets.vertexassets file → Reload resources in Vertex → rebuild and playtest'''. All connected maps use this library update when reloaded; rebuild each map you want to distribute with the changed asset. Editing only the PNG or prefab on disk does not refresh an already exported catalog. Changing a prefab instance in a temporary scene does not update the prefab until you apply or save those changes.

Keep existing <code>.meta</code> files and the catalog ID. Vertex references Unity assets by their GUID and local file ID, not just by filename. Move assets inside Unity when reorganizing; deleting and recreating an asset can break map references even if you reuse its name.

To hand editable source to another creator, share the map and scripts plus the library's custom asset folder with all <code>.meta</code> files and its catalog profile, the catalog with its previews, and the connection setup for the matching SDK release. They can keep the library in their own general asset folder and connect the map to it. A <code>.vertex</code> map alone does not contain these Unity source assets.

If you already created a library inside a map project, move its complete SDK folder to a general location such as <code>Documents/GrimwarLibrary</code>, then choose its new <code>.vertexsdk</code> location in each map. Keep its existing catalog ID, asset names, and <code>.meta</code> files; you do not need to rename existing assets to match this guide's example names.

Your personal SDK copy does not update when Steam updates. For a new SDK release, make a fresh working copy, transfer your custom folder with its <code>.meta</code> files, repeat the connection edits on the newly supplied files, and re-export the catalog with the required Unity version. Keep the old working copy until your map builds and playtests successfully. Do not overwrite new SDK packages or the new game profile with old versions.

Your editable source stays in the shared library. An exported add-on includes the custom assets its map references and their required dependencies; selecting one crate does not bundle the whole library. Referenced custom assets can therefore appear in more than one built add-on. The SDK's shared developer materials are already base-game assets. For reusable imported media distributed once as a separate dependency, see [[Grimwar/Custom content#Make a reusable media pack|media packs]]; the file importer there still accepts the formats listed on that page, not arbitrary Unity prefabs or materials.

== If something is missing or wrong ==

{| class="wikitable"
! What you see !! What to check
|-
| Asset exists in Unity but is absent from Vertex || Confirm the file is under the catalog's folder rule, its type is enabled, and you exported the selected custom profile. Confirm the custom catalog entry is in the connected copy's <code>Authoring/Grimwar.vertexgame</code>, then reload resources.
|-
| Model appears, but its material cannot be chosen for a brush || Extract or create a standalone <code>.mat</code>. Embedded materials are hidden. Disable Material Dependencies Only on your custom folder rule and remove a <code>VertexHidden</code> asset label if you intentionally added one.
|-
| Asset previews correctly, but the build says the asset or profile is missing || Check the map's chosen <code>.vertexsdk</code>. Its local <code>Compiler</code> project must contain both the original assets and <code>my_custom_assets.asset</code>. A copied catalog alone is insufficient. Check the <code>editorProject</code> edit and preserve <code>.meta</code> files.
|-
| Material is pink, gray, or missing a texture || Check the shader and renderer material slots in Unity, and confirm all texture references resolve. Use URP/Lit and check Unity's render pipeline assignment from step 1, then save, export, reload, and rebuild. A Vertex preview does not prove that an unsupported shader can run in the game.
|-
| Crate looks correct but the player walks through it || Check the saved prefab's enabled collider, the placed model's collision setting in Vertex, and whether you placed the prefab rather than the raw model. Test collision in Grimwar.
|-
| Crate is too large, too small, or rotated incorrectly || Correct the model import scale/orientation or the saved prefab transform in Unity. Apply, re-export, reload, and rebuild. Compare against a one-metre cube.
|-
| Connection fails after editing JSON || Check commas and brackets, preserve the supplied fields, and match the catalog's ID/version exactly. The catalog path is relative to the game profile; both project paths are relative to <code>Grimwar.vertexsdk</code>.
|-
| Compiler setup reports unresolved packages or missing package-resolution data || Open the copied <code>Compiler</code> project in the pinned Unity editor and let Package Manager and asset import finish successfully before building from Vertex.
|}

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

Grimwar/Mapping

2026-10-04T16:11:50Z

DocumentationBot: Keep custom assets in one library shared across maps

{{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 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.

== 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 ==

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]].

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 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]]

Grimwar/SDK setup

2026-10-04T16:11:49Z

DocumentationBot: Keep custom assets in one library shared across maps

{{GameNav}}

The Grimwar SDK includes Vertex for maps, VSDK for setup and standalone resources, and Grimwar's assets and compiler. This wiki is the maintained source for Vellocet SDK guidance.

== Install the SDK ==

# In Steam's Library, enable the '''Tools''' filter and install '''Grimwar SDK'''. Install Grimwar too if you want to playtest.
# Launch the SDK to open VSDK.
# For map builds, install and activate Unity <code>6000.3.17f1</code> through Unity Hub. Add build support for the targets you will use. VSDK detects standard installations; choose the Unity executable if detection misses yours.
# Choose your installed Grimwar executable or macOS app for playtesting.
# Select '''Finish setup and open Vertex'''. Setup prepares a writable compiler cache and registers the game.
# Create a map and save it outside the SDK installation.

Map compilation runs Unity through the SDK. You author in Vertex and play in Grimwar. You do not need to create a Unity project or install a Unity package by hand for this workflow.

A VMod containing only scripts, sounds, or ordinary data can be validated and built without Unity. Imported models, materials, textures, fonts, and video use the Unity compiler. Map lighting also needs a working graphics device.

== Choose a workflow ==

{| class="wikitable"
! What you are making !! Start here
|-
| Map || Open Vertex, then [[Grimwar/Mapping|make a map]].
|-
| Map logic || Open the map's Code workspace and follow [[Grimwar/VSig|VSig]].
|-
| Standalone server mod || In VSDK, select '''VMod''' and '''Create…'''. See [[Grimwar/VMod]].
|-
| C# behavior attached to one map || Use '''Map → SDK resources → VMod → Create…''' in Vertex.
|-
| Reusable media || In VSDK, select '''Media pack''', create it, and open '''Content…'''. See [[Grimwar/Custom content]].
|-
| Shared custom materials, models, and prefabs || Follow [[Grimwar/Unity custom content]] to keep one asset library outside your map folders. Author assets in its <code>Compiler/Assets/CustomContent/</code> and connect your maps to the same Materials and Models selection.
|}

== Files and updates ==

Keep your maps, scripts, thumbnails, <code>content.json</code>, and imported files together in a source folder you control. Keep build output separate. Steam can replace SDK files during an update.

Update the complete SDK through Steam and launch VSDK again. Do not mix an editor executable from one SDK release with the catalogs or compiler from another. Your source files and local preferences stay outside the installation.

In Vertex, use '''Settings → Game and resources → Reload resources''' after changing or refreshing the game connection. Engine and game executable paths are under '''Build → Advanced'''. Standalone Vertex can open the same installation through '''File → Open game SDK…'''.

== Build profiles ==

Vertex's '''Preview''' profile builds for local testing on the selected platform. VSDK calls its local standalone-resource output a Development package. These packages are for testing and cannot be published to Workshop.

'''Release''' map exports include Windows client, macOS client, and Linux dedicated-server artifacts. Install the matching Unity build modules. The SDK enforces the required navigation, spatial, occlusion, and lighting policy.

Choose a 1920 × 1080 thumbnail before publishing. Vertex maps accept PNG or JPEG through '''Map → Thumbnail'''; standalone VMods use a PNG path in <code>mod.json.thumbnail</code>. A map can compile without artwork, but Workshop publication requires it. See [[Grimwar/Steam Workshop addons]].

== If you are integrating your own game ==

Read [[Vertex/Integrating your game]]. Your game supplies its own catalogs, entity behavior, compiler, and runtime loader. A local developer connection can offer '''Save to Unity''' for that game project. Grimwar's public SDK supplies a compiler, so its community workflow is '''Export add-on''' and '''Play in Game'''.

[[Category:Grimwar]]

Vertex/Content

2026-10-04T16:11:48Z

DocumentationBot: Keep custom assets in one library shared across maps

{{VertexNav}}

'''Content''' manages files owned by a map or SDK resource and references to assets from other packages. The connected game decides which file types it supports and how those files become usable in the game.

== Import your files ==

# Save the map, then open '''Settings → Map details → Content…'''. For a standalone resource, open its '''Content…''' controls in VSDK.
# Choose a content type and select '''Import files'''.
# Review the imported names and settings. The SDK may offer controls such as audio playback type or volume.
# Select the new asset in the appropriate material, model, entity, or script field.

Vertex keeps imported source under <code>Content/</code> and records it in <code>content.json</code>. Keep both beside the map or resource manifest. Importing a file makes it available; you still need to place it or reference it.

An asset key identifies the package and asset, for example <code>asset:shared_sounds/wind_loop</code>. Display names can change without changing that key. Use '''Replace media''' to replace a file while retaining its references. Reimporting it as a new asset creates a different entry.

Models may have companion materials and textures. Keep those files together when importing. '''Rebuild model previews''' refreshes the editor preview after external changes; the game compiler still builds the runtime model.

== Materials and prefabs authored in Unity ==

For a general selection of custom assets across Grimwar maps, follow [[Grimwar/Unity custom content|Unity materials and models for Vertex]]. Keep one personal SDK copy in a shared library folder outside your map projects, create assets beneath its <code>Compiler/Assets/CustomContent/</code>, and export its catalog. Connect each map to that same library to select its assets in the Materials and Models browsers. The guide covers each folder and setting with a wall material and a crate prefab. Dropping files into a Unity folder alone does not add them to Vertex, and Content's file importer does not accept <code>.mat</code> or <code>.prefab</code> files.

== Use an installed package ==

Select an installed asset in Content and choose '''Use this package'''. Vertex records the provider's add-on ID and references the asset by key. The resulting build depends on that package and does not include another copy of its files.

The provider must be installed and enabled in the game. Publish and distribute the provider as well as the map or mod that uses it. A different display title or Workshop item number does not replace the stable package ID.

'''Copy files into this package''' creates an owned copy when you want to distribute and maintain the files yourself. References to other packages that you keep using remain dependencies. Check that the asset's terms permit redistribution.

== Check what ships ==

'''Check build contents''' lists selected files, sizes, and the references or inclusion settings that bring them into the build. Use it before publishing a large package.

Enable '''Include in build''' for files used only through dynamically constructed script references. An unchecked asset is still included when the map or another included asset needs it.

Missing providers, cycles, unsupported formats, or changed source files can stop a build. Fix the reported source or dependency and rebuild. Avoid editing the generated package manifest to bypass an error.

For supported formats, a complete sound example, and reusable media packs, see [[Grimwar/Custom content]]. For another game's support, use that game's SDK documentation.

[[Category:Vertex]]

Grimwar/Custom content

2026-10-04T16:11:47Z

DocumentationBot: Keep custom assets in one library shared across maps

{{GameNav}}

Use Content in Vertex or VSDK to import your own media. A map or VMod can own its files, or reference assets from another installed add-on. The SDK builds the required files and records those dependencies.

'''For custom assets shared across maps,''' follow [[Grimwar/Unity custom content|Unity materials and models for Vertex]]. Keep one shared library outside your map folders, create your textures, <code>.mat</code> files, models, and <code>.prefab</code> files there, and connect each map to its catalog. They appear in your general Materials and Models selection. The file-import workflow on this page owns files within the map or resource; it does not import Unity <code>.mat</code> or <code>.prefab</code> files.

== Add a sound to a map ==

# Save the map, for example <code>my_arena.vertex</code>.
# Open '''Settings → Map details → Content…''', choose '''Sound''', then '''Import files'''. Select <code>wind_loop.wav</code>.
# Set '''Playback''' to '''AmbientLoop''' for a looping sound with a world position. Adjust '''Volume''' between 0 and 1.
# Place an [[Grimwar/Entities/env_ambient|env_ambient]] entity and select the imported sound in '''Custom Cue'''. Leave '''Play On Start''' enabled to hear it when the map loads.
# Build with '''Play in Game''' and check the volume and placement in Grimwar.

The imported sound has a key such as <code>asset:my_arena/wind_loop</code>. Custom Cue takes priority over the entity's base-game Event Name. You do not need to build Wwise banks or write an audio manifest.

The source stays under <code>Content/</code>, with its settings in <code>content.json</code>. Keep both with the map. Use '''Replace media''' to update the sound without changing its key.

=== Pick the playback type ===

{| class="wikitable"
! Type !! Use
|-
| Announcer || Non-spatial announcements.
|-
| Sfx2D || A non-spatial one-shot sound.
|-
| Sfx3D || A one-shot sound at a world position.
|-
| AmbientLoop || A looping sound at a world position.
|-
| MusicLoop || Looping music.
|-
| Ambience2DLoop || Looping non-spatial ambience.
|}

For a sound that starts from a door or objective, disable Play On Start and call the ambient entity from a client VSig handler. See [[Grimwar/VSig#Server and client logic|Server and client logic]].

An ambient entity's '''Audible Distance''' is its emitter radius, not a guaranteed cutoff distance. Point mode stays at the marker. Volumetric mode follows the nearest boundary of its oriented box when the listener is outside and plays in 2D inside.

== Make a reusable media pack ==

# Open VSDK and select '''Media pack''', then '''Create…'''. Choose a new source folder outside the SDK installation, such as <code>shared_sounds</code>. The folder name becomes the pack's stable ID.
# Open '''Content…''' and set its title, author, and version.
# Import your files and choose their settings. Mark assets intended for other packages with '''Include in build'''.
# Select '''Check build contents''' and review the file list and size.
# Build into Grimwar's add-on folder and enable the package in the game.

In another map or VMod's Content window, select an installed asset from this pack and choose '''Use this package'''. A reference such as <code>asset:shared_sounds/wind_loop</code> points to the provider. The consuming build records <code>shared_sounds</code> as a requirement and leaves the sound bytes in the provider's package.

Install and enable both packages to test them. Publish the media pack first, then the map or mod that depends on it. Keep the provider ID and asset keys stable in updates. Removing or renaming a published key can break consumers even if the pack's display title stays the same.

Choose '''Copy files into this package''' when you want an independent copy you can edit and distribute. Check the creator's redistribution terms first. Other external references still keep their own dependencies.

== Use media in a VMod ==

Open the VMod's '''Content…''' controls in VSDK. For an attached VMod, select it under the map's SDK resources and use that resource's Content button. Importing there gives the script local names for its own assets.

For a sound imported as <code>round_start</code> with the Announcer or Sfx2D playback type:

<syntaxhighlight lang="csharp">
var result = context.Audio.PlayToAll("round_start");
if (!result.Success)
context.Log.Warn(result.Message);
</syntaxhighlight>

Use a full asset key for a sound from a shared pack:

<syntaxhighlight lang="csharp">
var result = context.Audio.PlayFromPlayer(
playerId, "asset:shared_sounds/wind_loop", 0.5f);
</syntaxhighlight>

Here <code>context</code> is the <code>IModContext</code> saved in <code>OnLoad</code>, and <code>playerId</code> identifies a connected player. This second example needs an AmbientLoop or Sfx3D cue. <code>PlayFromPlayer</code> uses the player's authoritative pawn position. Save <code>result.Value</code> from a successful play if you need to stop it later with <code>context.Audio.Stop</code>.

<code>PlayToAll</code> and <code>PlayToPlayer</code> accept non-spatial cue types. <code>PlayAt</code> and <code>PlayFromPlayer</code> accept Sfx3D and AmbientLoop. Playback gain multiplies the cue's own volume.

Use '''Use this package''' to record a selected provider. When declaring a dependency directly in a VMod manifest, put its add-on ID in <code>requires</code>. <code>dependencies</code> instead lists VMod IDs for script load order.

API 15 also exposes declared text/data through <code>Content</code>:

<syntaxhighlight lang="csharp">
string rules;
if (context.Content.TryReadText("rules", out rules))
context.Log.Write(rules);
</syntaxhighlight>

Import the file through the resource's Content window and keep it included in the build. <code>Content.Describe(key)</code> reads asset metadata. These APIs operate on declared assets; they do not give a VMod access to arbitrary files.

== Supported imports ==

{| class="wikitable"
! Type !! Source formats !! Notes
|-
| Sound || WAV, Ogg Vorbis, MP3 || Up to 32 MiB per source. Set the playback type and volume.
|-
| Surface material || PNG, JPG/JPEG, TGA || Creates a surface material from an image. Up to 16 MiB per source.
|-
| Image / texture || PNG, JPG/JPEG, TGA || Up to 16 MiB per source. Select the type the consuming field expects.
|-
| Model || FBX, OBJ || Import supported MTL and image companions alongside it. Review scale and collision.
|-
| Font || TTF, OTF || Requires a supported game consumer.
|-
| Video || MP4, WebM, MOV || Requires a supported game consumer; importing a clip does not place a video screen.
|-
| Text / data || TXT, JSON, CSV, Markdown || Up to 8 MiB per source; usable through the VMod Content API.
|-
| Binary data || BIN || Packaged data for supported consumers, not executable code.
|}

Native Unity media, including models, materials, textures, fonts, and video, needs the SDK's pinned Unity compiler and target modules. Sounds and ordinary data use platform-independent files. Import support does not imply that every entity or VMod service can consume every type.

== Keep builds small and repeatable ==

Use '''Check build contents''' to see what is included and why. Unreferenced files can stay in your source folder without shipping. '''Include in build''' keeps an asset available when code chooses its key at runtime; a referenced asset is included even if that checkbox is off.

Keep model companion files together. Use '''Rebuild model previews''' after editing a model externally. Rebuild the package after any source change; the compiler reuses matching verified output where it can.

Avoid copying the same large library into every map. Put shared assets in a media pack when you want a common update and dependency. Use an owned copy when a map needs to keep its own version.

== Artwork and distribution ==

Set a media pack's title, author, version, and PNG thumbnail in Content. Use a 1920 × 1080 thumbnail for Release. Enable '''Release package''' in VSDK, build, and publish the result as '''Content''' from Grimwar's Addons screen.

Keep the entire output folder, including its generated <code>addon.json</code> and catalogs. The editable <code>content.json</code> is source; it is not an installable package by itself. See [[Grimwar/Steam Workshop addons]] for dependencies and updates.

[[Category:Grimwar]] [[Category:Addons]]

Grimwar/Unity custom content

2026-10-04T16:11:45Z

DocumentationBot: Keep custom assets in one library shared across maps

{{GameNav}}

Build one personal asset library for Vertex's '''Materials''' and '''Models''' browsers. Every map connected to that library can select the same custom materials, models, and prefabs. This walkthrough adds a wall material and a crate prefab to that shared selection.

'''Keep the library in <code>Documents/GrimwarLibrary/</code>, and create your assets under its <code>Compiler/Assets/CustomContent/</code> folder.''' Keep map projects separately, for example under <code>Documents/GrimwarMaps/</code>. Set up the library once, export its catalog, and connect your maps to the same SDK copy. A folder alone does not register its contents with Vertex.

Use this library for textures, Unity <code>.mat</code> files, models, and <code>.prefab</code> files that you want in your general selection. Vertex's '''Settings → Map details → Content…''' imports files into the map's own source folder; those imports are covered separately by [[Grimwar/Custom content]]. Content's file importer does not accept <code>.mat</code> or <code>.prefab</code> files.

== 1. Set up your shared asset library ==

# Complete [[Grimwar/SDK setup|SDK setup]]. Install Unity <code>6000.3.17f1</code> and the build modules you need.
# In Steam, open Grimwar SDK's '''Manage → Browse local files'''. Locate <code>Grimwar.vertexsdk</code> and its sibling <code>Compiler</code> and <code>Authoring</code> folders.
# Copy that SDK folder, with all its contents, to <code>Documents/GrimwarLibrary/</code> outside Steam. This is your shared working copy for all your maps; create it once.
# Keep your Vertex maps in separate folders, for example <code>Documents/GrimwarMaps/MyArena/my_arena.vertex</code> and <code>Documents/GrimwarMaps/MyOutpost/my_outpost.vertex</code>. Both will use the same library.
# In Unity Hub, add the existing project at <code>Documents/GrimwarLibrary/Compiler</code> and open it with the pinned Unity version. Select '''Compiler''', not its parent folder or its <code>Assets</code> folder. Let package resolution, script compilation, and asset imports finish.
# For Unity's scene and material previews, open '''Edit → Project Settings → Graphics'''. If '''Default Render Pipeline''' is empty, assign the supplied <code>Assets/VertexSdk/Rendering/Pipeline.asset</code>. Keep the SDK's quality settings. See [https://docs.unity3d.com/6000.3/Documentation/Manual/srp-setting-render-pipeline-asset.html Unity's render pipeline settings].

'''Checkpoint:''' Unity's Project window shows <code>Assets</code>, including <code>CustomContent</code> and <code>VertexSdk</code>. Resolve any Console errors before continuing. This is the SDK's asset-authoring and compiler project; playtest the map in Grimwar.

The Steam installation and Vertex's generated compiler cache are replaceable. Neither is a place to keep your original work. Keep the SDK's supplied packages and base assets intact in your working copy.

== 2. Create the content folders ==

In Unity's '''Project''' window, expand <code>Assets/CustomContent</code>. Right-click it and use '''Create → Folder''' to create <code>Textures</code>, <code>Materials</code>, <code>Models</code>, and <code>Prefabs</code> directly inside it. These folders belong to your general asset library. You can add subfolders for themes or asset packs as the library grows.

After completing the guide, your files will look like this. Unity also creates <code>.meta</code> files beside assets and folders; keep those files.

<pre>
Documents/
GrimwarMaps/
MyArena/
my_arena.vertex
MyOutpost/
my_outpost.vertex
GrimwarLibrary/ shared by both maps
Grimwar.vertexsdk
Authoring/
Grimwar.vertexgame
CustomAssets.vertexassets exported catalog
previews/ generated catalog previews
Compiler/ open this folder in Unity Hub
Assets/
CustomContent/
CustomAssets.asset catalog profile created in step 5
Textures/
BrickWall_BaseColor.png
Crate_BaseColor.png
Materials/
BrickWall.mat
Crate.mat
Models/
Crate.fbx
Prefabs/
Crate.prefab
VertexSdk/ supplied SDK assets
Packages/
ProjectSettings/
</pre>

<code>Assets/CustomContent</code> is the path '''inside Unity'''. <code>Documents/GrimwarLibrary/Compiler/Assets/CustomContent</code> is the same folder on disk. <code>Authoring</code> is outside the Unity project's <code>Assets</code> folder. Neither map folder contains the library's source assets.

A '''texture''' is an image. A '''material''' combines a shader, textures, and surface settings. A '''model''' supplies meshes. A '''prefab''' saves a model's hierarchy, assigned materials, and components such as colliders. Vertex uses the material on a brush face and the model or prefab as a placed object.

== 3. Create a wall material ==

# Drag <code>BrickWall_BaseColor.png</code> from your file manager into <code>Assets/CustomContent/Textures</code> in Unity's Project window. Wait for import to finish.
# Right-click the <code>Materials</code> folder and choose '''Create → Material'''. Name it <code>BrickWall</code>; Unity saves <code>BrickWall.mat</code> there.
# Select the material. In the Inspector, set '''Shader''' to '''Universal Render Pipeline/Lit'''. Use '''Surface Type: Opaque''' for an ordinary solid wall.
# Drag the imported image into '''Base Map''' under Surface Inputs. Leave the adjacent color white to use the image's original colors.
# For a plain non-metallic wall, start with '''Metallic: 0''' and '''Smoothness: 0'''. Increase Smoothness only if you want a shinier surface. For a matte surface without specular shine, also disable '''Specular Highlights''' and '''Environment Reflections''' under Advanced Options.
# If you have a normal map, import it into <code>Textures</code>, select that texture, set '''Texture Type: Normal map''', and click '''Apply'''. Assign it to the material's '''Normal Map''' field. A normal map is optional.
# Save your project changes. The asset you will choose in Vertex is '''BrickWall''', the material, rather than the raw PNG.

Use an SDK-supported shader such as URP/Lit. A custom material can use that shader with your own textures and settings; add-on maps cannot bring arbitrary custom shaders or Shader Graph shaders from <code>Assets</code>.

'''Checkpoint:''' <code>Materials/BrickWall.mat</code> exists and its Base Map references your texture. Vertex's preview shows basic color and transparency; judge normal maps, reflections, and final lighting in the compiled game. For the remaining material controls, see [https://docs.unity3d.com/6000.3/Documentation/Manual/urp/lit-shader.html Unity's URP Lit reference].

== 4. Import a model and save a prefab ==

# Export a model such as <code>Crate.fbx</code> from your modeling tool. Use metres, a deliberate pivot, and UVs for the material. Put its image files in your <code>Textures</code> folder and the model in <code>Models</code>.
# Select <code>Crate.fbx</code> in Unity's Project window. Check its import scale and orientation. Apply changed import settings. As a size check, compare it with a Unity cube, which is one unit across at scale 1; one Unity unit represents one metre here.
# Create <code>Materials/Crate.mat</code> using the material steps above and its own Base Map. If the model already contains embedded materials, its '''Materials''' import tab can '''Extract Materials…''' into your <code>Materials</code> folder. Check extracted materials' shaders and texture assignments. See [https://docs.unity3d.com/6000.3/Documentation/Manual/FBXImporter-Materials.html Unity's model material settings].
# Drag <code>Crate.fbx</code> from the Project window into a temporary scene. On each relevant Mesh Renderer, assign <code>Crate.mat</code> to its '''Materials''' slots. For a model with several submeshes, assign the material for each slot.
# For a solid crate, add a '''Box Collider''' and adjust its Center and Size to fit. A renderer alone does not make an object solid. Keep the example a static prop; arbitrary custom C# components are not a substitute for supported Grimwar entities or map scripts.
# Name the scene object <code>Crate</code>. Drag it from the '''Hierarchy''' into <code>Assets/CustomContent/Prefabs</code> in the '''Project''' window. If Unity asks whether to create an Original Prefab or Prefab Variant, choose '''Original Prefab''' for this example. This creates <code>Crate.prefab</code>. See [https://docs.unity3d.com/6000.3/Documentation/Manual/CreatingPrefabs.html Unity's prefab creation guide].
# Select the saved prefab in the Project window and confirm it contains the renderer's material assignments and the collider. Later changes must be saved to this prefab, not left only on a scene instance.

'''Checkpoint:''' <code>Prefabs/Crate.prefab</code> is the assembled prop you will place in Vertex. The raw <code>Models/Crate.fbx</code> can also appear in the browser, but choosing it does not include overrides or colliders that you added only to the prefab.

Keep the model, prefab, materials, and textures beneath <code>Assets/CustomContent</code>. To reuse a model's material on brush faces, use a separate <code>.mat</code> file: embedded model materials are hidden from Vertex's material picker.

== 5. Export a catalog for Vertex ==

A catalog tells Vertex which assets exist and provides their previews. The original Unity assets remain in <code>Compiler/Assets</code> for the map compiler to use.

# In the Project window, right-click <code>Assets/CustomContent</code> and choose '''Create → Vertex → Asset catalog profile'''. Name the asset <code>CustomAssets</code>.
# Select it and set '''Catalog Id''' to <code>my_library.assets</code> and '''Catalog Version''' to <code>1</code>. Keep these values stable as you edit this asset library.
# Expand '''Folders''' in the Inspector and add one element. Set that element's '''Folder''' to <code>Assets/CustomContent</code> and '''Ownership''' to <code>custom</code>.
# Enable '''Materials''', '''Models''', '''Prefabs''', and '''Textures''' for that element. Leave '''Material Dependencies Only''' disabled so your standalone materials appear in the picker. Leave the other settings at their defaults.
# Save the project. With <code>CustomAssets</code> still selected, choose '''Tools → Vertex → Export Selected Asset Catalog'''.
# In the save dialog, navigate out of <code>Compiler</code> to your copy's <code>Authoring</code> folder. Save as <code>CustomAssets.vertexassets</code>. The exporter also writes a <code>previews</code> folder beside it.

'''Checkpoint:''' Both <code>GrimwarLibrary/Authoring/CustomAssets.vertexassets</code> and its preview files exist. Keep the catalog and previews together. Do not replace the supplied <code>Assets/VertexSdk/Assets.asset</code> profile or the base-game catalog.

Use <code>custom</code> ownership for your own files. <code>base</code> means the asset already ships with Grimwar; it does not mean “shared between my maps.” Incorrectly marking a new asset as base prevents the map from carrying the asset players need. You do not need to add your files to the base game's Addressables groups.

== 6. Connect your maps to the shared library ==

Edit the library's connection once, then choose it for each map. Two small JSON edits connect its editable Unity project and exported catalog. Use a plain-text editor, preserve the other fields, and keep the original files as backups outside the Unity <code>Assets</code> folder.

=== Tell Vertex to build from your Unity project ===

Open <code>Documents/GrimwarLibrary/Grimwar.vertexsdk</code> in a text editor.

# Keep <code>"compilerProject": "Compiler"</code>.
# Remove the <code>compilerInputs</code> property and its value. That inventory describes the unmodified distributed SDK.
# Add <code>"editorProject": "Compiler"</code> alongside <code>compilerProject</code>.
# Preserve <code>formatVersion</code>, <code>game</code>, and any <code>resourceTools</code> entries exactly as supplied. Separate neighboring properties with commas and leave no trailing comma before <code>}</code>.

The two project properties should now read as follows. This fragment shows only those properties; '''do not replace the whole file''' with it.

<syntaxhighlight lang="json">
{
"compilerProject": "Compiler",
"editorProject": "Compiler"
}
</syntaxhighlight>

This makes the copy a local developer connection: Vertex captures the saved assets from your <code>Compiler</code> project when building. Leaving the distributed connection unchanged would use its prepared compiler cache instead.

=== Add your catalog to the game's asset list ===

Open <code>Documents/GrimwarLibrary/Authoring/Grimwar.vertexgame</code>. Find the <code>assetCatalogs</code> array. Keep every existing entry, including <code>grimwar.base</code>. Add a comma after its last existing entry, then insert this additional object before the array's closing <code>]</code>:

<syntaxhighlight lang="json">
{
"id": "my_library.assets",
"version": "1",
"path": "CustomAssets.vertexassets"
}
</syntaxhighlight>

The path is relative to <code>Authoring/Grimwar.vertexgame</code>, so do not prepend <code>Authoring/</code> again. Keep the game's ID, version, entity catalogs, and build configuration unchanged. The new entry's ID and version must match the Unity catalog profile from step 5.

=== Choose this connection in Vertex ===

# Save both JSON files and your Unity asset changes. Let Unity finish importing.
# Open your map in Vertex. Under '''Settings → Game and resources''', select '''Choose game SDK…'''. Choose <code>Documents/GrimwarLibrary/Grimwar.vertexsdk</code>, the file in your shared library. '''File → Open game SDK…''' opens the same chooser.
# Save the map. Open your other maps and choose that same connection. Saved maps remember their own SDK connection; each map can reference this one library without another SDK copy or asset import.
# Use '''Settings → Game and resources → Reload resources''' after subsequent catalog exports.

'''Checkpoint:''' Open either example map. Its '''Materials''' browser contains <code>BrickWall</code> and its '''Models''' browser contains your crate entries. Both maps select from the same library. Base-game materials and entities should still be available. If the base assets disappear, restore the original entries in <code>assetCatalogs</code>.

Do not use '''Load engine assets…''' as a substitute for this setup. Loading a loose preview catalog does not connect a map's compiler to the Unity source assets.

== 7. Use the assets and test the add-on ==

# In Vertex's material browser, search for <code>BrickWall</code>. Drag it onto a brush face; hold '''Shift''' while dropping to apply it to the whole brush. Adjust the face's texture scale and alignment as needed.
# In the model browser, search for <code>Crate</code>. Choose the entry whose source is <code>Prefabs/Crate.prefab</code> and drag it into a viewport. Place it, then check its size and orientation.
# Save the map. In Build, select '''Preview''' and your desktop platform, then '''Play in Game'''. If requested, select the pinned Unity executable and your Grimwar installation in the build settings.
# Walk around the crate in Grimwar to check collision. Inspect the wall's tiling, material, and lighting. Test the actual game even when the Vertex preview looks correct.
# When ready, use '''Export add-on''' with the Release profile and follow [[Grimwar/Steam Workshop addons|the publication guide]].

The build includes referenced custom Unity assets and their required custom dependencies. The exported catalog is a browser index, not an installable add-on; distribute the built add-on rather than loose <code>.mat</code>, <code>.prefab</code>, or <code>.vertexassets</code> files. Players do not need your Unity project to play the compiled map.

Grimwar's SDK still uses '''Play in Game''' and '''Export add-on''' with this connection. It does not provide the base game's playable Unity project or a '''Save to Unity''' workflow.

== Updating assets, sharing source, and SDK updates ==

For each edit: '''change the Unity asset → save/apply it → export CustomAssets to the same CustomAssets.vertexassets file → Reload resources in Vertex → rebuild and playtest'''. All connected maps use this library update when reloaded; rebuild each map you want to distribute with the changed asset. Editing only the PNG or prefab on disk does not refresh an already exported catalog. Changing a prefab instance in a temporary scene does not update the prefab until you apply or save those changes.

Keep existing <code>.meta</code> files and the catalog ID. Vertex references Unity assets by their GUID and local file ID, not just by filename. Move assets inside Unity when reorganizing; deleting and recreating an asset can break map references even if you reuse its name.

To hand editable source to another creator, share the map and scripts plus the library's custom asset folder with all <code>.meta</code> files and its catalog profile, the catalog with its previews, and the connection setup for the matching SDK release. They can keep the library in their own general asset folder and connect the map to it. A <code>.vertex</code> map alone does not contain these Unity source assets.

If you already created a library inside a map project, move its complete SDK folder to a general location such as <code>Documents/GrimwarLibrary</code>, then choose its new <code>.vertexsdk</code> location in each map. Keep its existing catalog ID, asset names, and <code>.meta</code> files; you do not need to rename existing assets to match this guide's example names.

Your personal SDK copy does not update when Steam updates. For a new SDK release, make a fresh working copy, transfer your custom folder with its <code>.meta</code> files, repeat the connection edits on the newly supplied files, and re-export the catalog with the required Unity version. Keep the old working copy until your map builds and playtests successfully. Do not overwrite new SDK packages or the new game profile with old versions.

Your editable source stays in the shared library. An exported add-on includes the custom assets its map references and their required dependencies; selecting one crate does not bundle the whole library. Referenced custom assets can therefore appear in more than one built add-on. The SDK's shared developer materials are already base-game assets. For reusable imported media distributed once as a separate dependency, see [[Grimwar/Custom content#Make a reusable media pack|media packs]]; the file importer there still accepts the formats listed on that page, not arbitrary Unity prefabs or materials.

== If something is missing or wrong ==

{| class="wikitable"
! What you see !! What to check
|-
| Asset exists in Unity but is absent from Vertex || Confirm the file is under the catalog's folder rule, its type is enabled, and you exported the selected custom profile. Confirm the custom catalog entry is in the connected copy's <code>Authoring/Grimwar.vertexgame</code>, then reload resources.
|-
| Model appears, but its material cannot be chosen for a brush || Extract or create a standalone <code>.mat</code>. Embedded materials are hidden. Disable Material Dependencies Only on your custom folder rule and remove a <code>VertexHidden</code> asset label if you intentionally added one.
|-
| Asset previews correctly, but the build says the asset or profile is missing || Check the map's chosen <code>.vertexsdk</code>. Its local <code>Compiler</code> project must contain both the original assets and <code>CustomAssets.asset</code>. A copied catalog alone is insufficient. Check the <code>editorProject</code> edit and preserve <code>.meta</code> files.
|-
| Material is pink, gray, or missing a texture || Check the shader and renderer material slots in Unity, and confirm all texture references resolve. Use URP/Lit and check Unity's render pipeline assignment from step 1, then save, export, reload, and rebuild. A Vertex preview does not prove that an unsupported shader can run in the game.
|-
| Crate looks correct but the player walks through it || Check the saved prefab's enabled collider, the placed model's collision setting in Vertex, and whether you placed the prefab rather than the raw model. Test collision in Grimwar.
|-
| Crate is too large, too small, or rotated incorrectly || Correct the model import scale/orientation or the saved prefab transform in Unity. Apply, re-export, reload, and rebuild. Compare against a one-metre cube.
|-
| Connection fails after editing JSON || Check commas and brackets, preserve the supplied fields, and match the catalog's ID/version exactly. The catalog path is relative to the game profile; both project paths are relative to <code>Grimwar.vertexsdk</code>.
|-
| Compiler setup reports unresolved packages or missing package-resolution data || Open the copied <code>Compiler</code> project in the pinned Unity editor and let Package Manager and asset import finish successfully before building from Vertex.
|}

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

Grimwar/Mapping

2026-10-04T15:55:12Z

DocumentationBot: Guide custom Unity materials and models into Vertex

{{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 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.

== 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 ==

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 '''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 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]]

Grimwar/SDK setup

2026-10-04T15:55:11Z

DocumentationBot: Guide custom Unity materials and models into Vertex

{{GameNav}}

The Grimwar SDK includes Vertex for maps, VSDK for setup and standalone resources, and Grimwar's assets and compiler. This wiki is the maintained source for Vellocet SDK guidance.

== Install the SDK ==

# In Steam's Library, enable the '''Tools''' filter and install '''Grimwar SDK'''. Install Grimwar too if you want to playtest.
# Launch the SDK to open VSDK.
# For map builds, install and activate Unity <code>6000.3.17f1</code> through Unity Hub. Add build support for the targets you will use. VSDK detects standard installations; choose the Unity executable if detection misses yours.
# Choose your installed Grimwar executable or macOS app for playtesting.
# Select '''Finish setup and open Vertex'''. Setup prepares a writable compiler cache and registers the game.
# Create a map and save it outside the SDK installation.

Map compilation runs Unity through the SDK. You author in Vertex and play in Grimwar. You do not need to create a Unity project or install a Unity package by hand for this workflow.

A VMod containing only scripts, sounds, or ordinary data can be validated and built without Unity. Imported models, materials, textures, fonts, and video use the Unity compiler. Map lighting also needs a working graphics device.

== Choose a workflow ==

{| class="wikitable"
! What you are making !! Start here
|-
| Map || Open Vertex, then [[Grimwar/Mapping|make a map]].
|-
| Map logic || Open the map's Code workspace and follow [[Grimwar/VSig|VSig]].
|-
| Standalone server mod || In VSDK, select '''VMod''' and '''Create…'''. See [[Grimwar/VMod]].
|-
| C# behavior attached to one map || Use '''Map → SDK resources → VMod → Create…''' in Vertex.
|-
| Reusable media || In VSDK, select '''Media pack''', create it, and open '''Content…'''. See [[Grimwar/Custom content]].
|-
| Unity materials or model prefabs for a map || Follow [[Grimwar/Unity custom content]] to make a personal SDK copy, author assets in <code>Compiler/Assets/CustomContent/</code>, and register them with Vertex.
|}

== Files and updates ==

Keep your maps, scripts, thumbnails, <code>content.json</code>, and imported files together in a source folder you control. Keep build output separate. Steam can replace SDK files during an update.

Update the complete SDK through Steam and launch VSDK again. Do not mix an editor executable from one SDK release with the catalogs or compiler from another. Your source files and local preferences stay outside the installation.

In Vertex, use '''Settings → Game and resources → Reload resources''' after changing or refreshing the game connection. Engine and game executable paths are under '''Build → Advanced'''. Standalone Vertex can open the same installation through '''File → Open game SDK…'''.

== Build profiles ==

Vertex's '''Preview''' profile builds for local testing on the selected platform. VSDK calls its local standalone-resource output a Development package. These packages are for testing and cannot be published to Workshop.

'''Release''' map exports include Windows client, macOS client, and Linux dedicated-server artifacts. Install the matching Unity build modules. The SDK enforces the required navigation, spatial, occlusion, and lighting policy.

Choose a 1920 × 1080 thumbnail before publishing. Vertex maps accept PNG or JPEG through '''Map → Thumbnail'''; standalone VMods use a PNG path in <code>mod.json.thumbnail</code>. A map can compile without artwork, but Workshop publication requires it. See [[Grimwar/Steam Workshop addons]].

== If you are integrating your own game ==

Read [[Vertex/Integrating your game]]. Your game supplies its own catalogs, entity behavior, compiler, and runtime loader. A local developer connection can offer '''Save to Unity''' for that game project. Grimwar's public SDK supplies a compiler, so its community workflow is '''Export add-on''' and '''Play in Game'''.

[[Category:Grimwar]]

Vertex/Content

2026-10-04T15:55:09Z

DocumentationBot: Guide custom Unity materials and models into Vertex

{{VertexNav}}

'''Content''' manages files owned by a map or SDK resource and references to assets from other packages. The connected game decides which file types it supports and how those files become usable in the game.

== Import your files ==

# Save the map, then open '''Settings → Map details → Content…'''. For a standalone resource, open its '''Content…''' controls in VSDK.
# Choose a content type and select '''Import files'''.
# Review the imported names and settings. The SDK may offer controls such as audio playback type or volume.
# Select the new asset in the appropriate material, model, entity, or script field.

Vertex keeps imported source under <code>Content/</code> and records it in <code>content.json</code>. Keep both beside the map or resource manifest. Importing a file makes it available; you still need to place it or reference it.

An asset key identifies the package and asset, for example <code>asset:shared_sounds/wind_loop</code>. Display names can change without changing that key. Use '''Replace media''' to replace a file while retaining its references. Reimporting it as a new asset creates a different entry.

Models may have companion materials and textures. Keep those files together when importing. '''Rebuild model previews''' refreshes the editor preview after external changes; the game compiler still builds the runtime model.

== Materials and prefabs authored in Unity ==

For Grimwar, follow [[Grimwar/Unity custom content|Unity materials and models for Vertex]]. Create the Unity assets beneath <code>Compiler/Assets/CustomContent/</code> in a personal SDK copy, export a catalog, and connect Vertex to that copy. The guide covers each folder and setting with a wall material and a crate prefab. Dropping files into a Unity folder alone does not add them to Vertex, and Content's file importer does not accept <code>.mat</code> or <code>.prefab</code> files.

== Use an installed package ==

Select an installed asset in Content and choose '''Use this package'''. Vertex records the provider's add-on ID and references the asset by key. The resulting build depends on that package and does not include another copy of its files.

The provider must be installed and enabled in the game. Publish and distribute the provider as well as the map or mod that uses it. A different display title or Workshop item number does not replace the stable package ID.

'''Copy files into this package''' creates an owned copy when you want to distribute and maintain the files yourself. References to other packages that you keep using remain dependencies. Check that the asset's terms permit redistribution.

== Check what ships ==

'''Check build contents''' lists selected files, sizes, and the references or inclusion settings that bring them into the build. Use it before publishing a large package.

Enable '''Include in build''' for files used only through dynamically constructed script references. An unchecked asset is still included when the map or another included asset needs it.

Missing providers, cycles, unsupported formats, or changed source files can stop a build. Fix the reported source or dependency and rebuild. Avoid editing the generated package manifest to bypass an error.

For supported formats, a complete sound example, and reusable media packs, see [[Grimwar/Custom content]]. For another game's support, use that game's SDK documentation.

[[Category:Vertex]]

Grimwar/Custom content

2026-10-04T15:55:08Z

DocumentationBot: Guide custom Unity materials and models into Vertex

{{GameNav}}

Use Content in Vertex or VSDK to import your own media. A map or VMod can own its files, or reference assets from another installed add-on. The SDK builds the required files and records those dependencies.

'''Creating materials or model prefabs in Unity?''' Follow [[Grimwar/Unity custom content|Unity materials and models for Vertex]]. It shows exactly where to create your textures, <code>.mat</code> files, models, and <code>.prefab</code> files, how to export their catalog, and how to use them in an add-on map. The file-import workflow on this page creates content from supported source files; it does not import Unity <code>.mat</code> or <code>.prefab</code> files.

== Add a sound to a map ==

# Save the map, for example <code>my_arena.vertex</code>.
# Open '''Settings → Map details → Content…''', choose '''Sound''', then '''Import files'''. Select <code>wind_loop.wav</code>.
# Set '''Playback''' to '''AmbientLoop''' for a looping sound with a world position. Adjust '''Volume''' between 0 and 1.
# Place an [[Grimwar/Entities/env_ambient|env_ambient]] entity and select the imported sound in '''Custom Cue'''. Leave '''Play On Start''' enabled to hear it when the map loads.
# Build with '''Play in Game''' and check the volume and placement in Grimwar.

The imported sound has a key such as <code>asset:my_arena/wind_loop</code>. Custom Cue takes priority over the entity's base-game Event Name. You do not need to build Wwise banks or write an audio manifest.

The source stays under <code>Content/</code>, with its settings in <code>content.json</code>. Keep both with the map. Use '''Replace media''' to update the sound without changing its key.

=== Pick the playback type ===

{| class="wikitable"
! Type !! Use
|-
| Announcer || Non-spatial announcements.
|-
| Sfx2D || A non-spatial one-shot sound.
|-
| Sfx3D || A one-shot sound at a world position.
|-
| AmbientLoop || A looping sound at a world position.
|-
| MusicLoop || Looping music.
|-
| Ambience2DLoop || Looping non-spatial ambience.
|}

For a sound that starts from a door or objective, disable Play On Start and call the ambient entity from a client VSig handler. See [[Grimwar/VSig#Server and client logic|Server and client logic]].

An ambient entity's '''Audible Distance''' is its emitter radius, not a guaranteed cutoff distance. Point mode stays at the marker. Volumetric mode follows the nearest boundary of its oriented box when the listener is outside and plays in 2D inside.

== Make a reusable media pack ==

# Open VSDK and select '''Media pack''', then '''Create…'''. Choose a new source folder outside the SDK installation, such as <code>shared_sounds</code>. The folder name becomes the pack's stable ID.
# Open '''Content…''' and set its title, author, and version.
# Import your files and choose their settings. Mark assets intended for other packages with '''Include in build'''.
# Select '''Check build contents''' and review the file list and size.
# Build into Grimwar's add-on folder and enable the package in the game.

In another map or VMod's Content window, select an installed asset from this pack and choose '''Use this package'''. A reference such as <code>asset:shared_sounds/wind_loop</code> points to the provider. The consuming build records <code>shared_sounds</code> as a requirement and leaves the sound bytes in the provider's package.

Install and enable both packages to test them. Publish the media pack first, then the map or mod that depends on it. Keep the provider ID and asset keys stable in updates. Removing or renaming a published key can break consumers even if the pack's display title stays the same.

Choose '''Copy files into this package''' when you want an independent copy you can edit and distribute. Check the creator's redistribution terms first. Other external references still keep their own dependencies.

== Use media in a VMod ==

Open the VMod's '''Content…''' controls in VSDK. For an attached VMod, select it under the map's SDK resources and use that resource's Content button. Importing there gives the script local names for its own assets.

For a sound imported as <code>round_start</code> with the Announcer or Sfx2D playback type:

<syntaxhighlight lang="csharp">
var result = context.Audio.PlayToAll("round_start");
if (!result.Success)
context.Log.Warn(result.Message);
</syntaxhighlight>

Use a full asset key for a sound from a shared pack:

<syntaxhighlight lang="csharp">
var result = context.Audio.PlayFromPlayer(
playerId, "asset:shared_sounds/wind_loop", 0.5f);
</syntaxhighlight>

Here <code>context</code> is the <code>IModContext</code> saved in <code>OnLoad</code>, and <code>playerId</code> identifies a connected player. This second example needs an AmbientLoop or Sfx3D cue. <code>PlayFromPlayer</code> uses the player's authoritative pawn position. Save <code>result.Value</code> from a successful play if you need to stop it later with <code>context.Audio.Stop</code>.

<code>PlayToAll</code> and <code>PlayToPlayer</code> accept non-spatial cue types. <code>PlayAt</code> and <code>PlayFromPlayer</code> accept Sfx3D and AmbientLoop. Playback gain multiplies the cue's own volume.

Use '''Use this package''' to record a selected provider. When declaring a dependency directly in a VMod manifest, put its add-on ID in <code>requires</code>. <code>dependencies</code> instead lists VMod IDs for script load order.

API 15 also exposes declared text/data through <code>Content</code>:

<syntaxhighlight lang="csharp">
string rules;
if (context.Content.TryReadText("rules", out rules))
context.Log.Write(rules);
</syntaxhighlight>

Import the file through the resource's Content window and keep it included in the build. <code>Content.Describe(key)</code> reads asset metadata. These APIs operate on declared assets; they do not give a VMod access to arbitrary files.

== Supported imports ==

{| class="wikitable"
! Type !! Source formats !! Notes
|-
| Sound || WAV, Ogg Vorbis, MP3 || Up to 32 MiB per source. Set the playback type and volume.
|-
| Surface material || PNG, JPG/JPEG, TGA || Creates a surface material from an image. Up to 16 MiB per source.
|-
| Image / texture || PNG, JPG/JPEG, TGA || Up to 16 MiB per source. Select the type the consuming field expects.
|-
| Model || FBX, OBJ || Import supported MTL and image companions alongside it. Review scale and collision.
|-
| Font || TTF, OTF || Requires a supported game consumer.
|-
| Video || MP4, WebM, MOV || Requires a supported game consumer; importing a clip does not place a video screen.
|-
| Text / data || TXT, JSON, CSV, Markdown || Up to 8 MiB per source; usable through the VMod Content API.
|-
| Binary data || BIN || Packaged data for supported consumers, not executable code.
|}

Native Unity media, including models, materials, textures, fonts, and video, needs the SDK's pinned Unity compiler and target modules. Sounds and ordinary data use platform-independent files. Import support does not imply that every entity or VMod service can consume every type.

== Keep builds small and repeatable ==

Use '''Check build contents''' to see what is included and why. Unreferenced files can stay in your source folder without shipping. '''Include in build''' keeps an asset available when code chooses its key at runtime; a referenced asset is included even if that checkbox is off.

Keep model companion files together. Use '''Rebuild model previews''' after editing a model externally. Rebuild the package after any source change; the compiler reuses matching verified output where it can.

Avoid copying the same large library into every map. Put shared assets in a media pack when you want a common update and dependency. Use an owned copy when a map needs to keep its own version.

== Artwork and distribution ==

Set a media pack's title, author, version, and PNG thumbnail in Content. Use a 1920 × 1080 thumbnail for Release. Enable '''Release package''' in VSDK, build, and publish the result as '''Content''' from Grimwar's Addons screen.

Keep the entire output folder, including its generated <code>addon.json</code> and catalogs. The editable <code>content.json</code> is source; it is not an installable package by itself. See [[Grimwar/Steam Workshop addons]] for dependencies and updates.

[[Category:Grimwar]] [[Category:Addons]]

Grimwar/Unity custom content

2026-10-04T15:55:05Z

DocumentationBot: Guide custom Unity materials and models into Vertex

{{GameNav}}

Create Unity materials and model prefabs for a Grimwar add-on map, then make them available in Vertex. This walkthrough creates a wall material and a crate prefab in a Unity project you own.

'''Put your Unity source assets in <code>Compiler/Assets/CustomContent/MyArena/</code> inside a personal copy of the Grimwar SDK.''' Export a Vertex asset catalog from that project and connect Vertex to that copy. A folder alone does not register its contents with Vertex.

If you only want to import an image as a surface material or an FBX/OBJ with its companion files, use '''Settings → Map details → Content…''' in Vertex instead. That simpler workflow is covered by [[Grimwar/Custom content]]. The walkthrough below is for authored Unity <code>.mat</code> files, material assignments, import settings, and <code>.prefab</code> files. Content's file importer does not accept <code>.mat</code> or <code>.prefab</code> files.

== 1. Make your own working copy ==

# Complete [[Grimwar/SDK setup|SDK setup]]. Install Unity <code>6000.3.17f1</code> and the build modules you need.
# In Steam, open Grimwar SDK's '''Manage → Browse local files'''. Locate <code>Grimwar.vertexsdk</code> and its sibling <code>Compiler</code> and <code>Authoring</code> folders.
# Copy that SDK folder, with all its contents, to a folder you control outside Steam. This guide calls the copy <code>MyArena/GrimwarSDK/</code>. Work in the copy from now on.
# Keep your Vertex maps separately, for example in <code>MyArena/Maps/</code>.
# In Unity Hub, add the existing project at <code>MyArena/GrimwarSDK/Compiler</code> and open it with the pinned Unity version. Select '''Compiler''', not its parent folder or its <code>Assets</code> folder. Let package resolution, script compilation, and asset imports finish.
# For Unity's scene and material previews, open '''Edit → Project Settings → Graphics'''. If '''Default Render Pipeline''' is empty, assign the supplied <code>Assets/VertexSdk/Rendering/Pipeline.asset</code>. Keep the SDK's quality settings. See [https://docs.unity3d.com/6000.3/Documentation/Manual/srp-setting-render-pipeline-asset.html Unity's render pipeline settings].

'''Checkpoint:''' Unity's Project window shows <code>Assets</code>, including <code>CustomContent</code> and <code>VertexSdk</code>. Resolve any Console errors before continuing. This is the SDK's asset-authoring and compiler project; playtest the map in Grimwar.

The Steam installation and Vertex's generated compiler cache are replaceable. Neither is a place to keep your original work. Keep the SDK's supplied packages and base assets intact in your working copy.

== 2. Create the content folders ==

In Unity's '''Project''' window, expand <code>Assets/CustomContent</code>. Right-click it and use '''Create → Folder''' to make <code>MyArena</code>. Inside it, create <code>Textures</code>, <code>Materials</code>, <code>Models</code>, and <code>Prefabs</code>.

After completing the guide, your files will look like this. Unity also creates <code>.meta</code> files beside assets and folders; keep those files.

<pre>
MyArena/
Maps/
my_arena.vertex
GrimwarSDK/
Grimwar.vertexsdk
Authoring/
Grimwar.vertexgame
MyArena.vertexassets exported catalog
previews/ generated catalog previews
Compiler/ open this folder in Unity Hub
Assets/
CustomContent/
MyArena/
MyArenaAssets.asset catalog profile created in step 5
Textures/
BrickWall_BaseColor.png
Crate_BaseColor.png
Materials/
BrickWall.mat
Crate.mat
Models/
Crate.fbx
Prefabs/
Crate.prefab
VertexSdk/ supplied SDK assets
Packages/
ProjectSettings/
</pre>

<code>Assets/CustomContent/MyArena</code> is the path '''inside Unity'''. <code>MyArena/GrimwarSDK/Compiler/Assets/CustomContent/MyArena</code> is the same folder on disk. <code>Authoring</code> is outside the Unity project's <code>Assets</code> folder.

A '''texture''' is an image. A '''material''' combines a shader, textures, and surface settings. A '''model''' supplies meshes. A '''prefab''' saves a model's hierarchy, assigned materials, and components such as colliders. Vertex uses the material on a brush face and the model or prefab as a placed object.

== 3. Create a wall material ==

# Drag <code>BrickWall_BaseColor.png</code> from your file manager into <code>Assets/CustomContent/MyArena/Textures</code> in Unity's Project window. Wait for import to finish.
# Right-click the <code>Materials</code> folder and choose '''Create → Material'''. Name it <code>BrickWall</code>; Unity saves <code>BrickWall.mat</code> there.
# Select the material. In the Inspector, set '''Shader''' to '''Universal Render Pipeline/Lit'''. Use '''Surface Type: Opaque''' for an ordinary solid wall.
# Drag the imported image into '''Base Map''' under Surface Inputs. Leave the adjacent color white to use the image's original colors.
# For a plain non-metallic wall, start with '''Metallic: 0''' and '''Smoothness: 0'''. Increase Smoothness only if you want a shinier surface. For a matte surface without specular shine, also disable '''Specular Highlights''' and '''Environment Reflections''' under Advanced Options.
# If you have a normal map, import it into <code>Textures</code>, select that texture, set '''Texture Type: Normal map''', and click '''Apply'''. Assign it to the material's '''Normal Map''' field. A normal map is optional.
# Save your project changes. The asset you will choose in Vertex is '''BrickWall''', the material, rather than the raw PNG.

Use an SDK-supported shader such as URP/Lit. A custom material can use that shader with your own textures and settings; add-on maps cannot bring arbitrary custom shaders or Shader Graph shaders from <code>Assets</code>.

'''Checkpoint:''' <code>Materials/BrickWall.mat</code> exists and its Base Map references your texture. Vertex's preview shows basic color and transparency; judge normal maps, reflections, and final lighting in the compiled game. For the remaining material controls, see [https://docs.unity3d.com/6000.3/Documentation/Manual/urp/lit-shader.html Unity's URP Lit reference].

== 4. Import a model and save a prefab ==

# Export a model such as <code>Crate.fbx</code> from your modeling tool. Use metres, a deliberate pivot, and UVs for the material. Put its image files in your <code>Textures</code> folder and the model in <code>Models</code>.
# Select <code>Crate.fbx</code> in Unity's Project window. Check its import scale and orientation. Apply changed import settings. As a size check, compare it with a Unity cube, which is one unit across at scale 1; one Unity unit represents one metre here.
# Create <code>Materials/Crate.mat</code> using the material steps above and its own Base Map. If the model already contains embedded materials, its '''Materials''' import tab can '''Extract Materials…''' into your <code>Materials</code> folder. Check extracted materials' shaders and texture assignments. See [https://docs.unity3d.com/6000.3/Documentation/Manual/FBXImporter-Materials.html Unity's model material settings].
# Drag <code>Crate.fbx</code> from the Project window into a temporary scene. On each relevant Mesh Renderer, assign <code>Crate.mat</code> to its '''Materials''' slots. For a model with several submeshes, assign the material for each slot.
# For a solid crate, add a '''Box Collider''' and adjust its Center and Size to fit. A renderer alone does not make an object solid. Keep the example a static prop; arbitrary custom C# components are not a substitute for supported Grimwar entities or map scripts.
# Name the scene object <code>Crate</code>. Drag it from the '''Hierarchy''' into <code>Assets/CustomContent/MyArena/Prefabs</code> in the '''Project''' window. If Unity asks whether to create an Original Prefab or Prefab Variant, choose '''Original Prefab''' for this example. This creates <code>Crate.prefab</code>. See [https://docs.unity3d.com/6000.3/Documentation/Manual/CreatingPrefabs.html Unity's prefab creation guide].
# Select the saved prefab in the Project window and confirm it contains the renderer's material assignments and the collider. Later changes must be saved to this prefab, not left only on a scene instance.

'''Checkpoint:''' <code>Prefabs/Crate.prefab</code> is the assembled prop you will place in Vertex. The raw <code>Models/Crate.fbx</code> can also appear in the browser, but choosing it does not include overrides or colliders that you added only to the prefab.

Keep the model, prefab, materials, and textures beneath <code>Assets/CustomContent/MyArena</code>. To reuse a model's material on brush faces, use a separate <code>.mat</code> file: embedded model materials are hidden from Vertex's material picker.

== 5. Export a catalog for Vertex ==

A catalog tells Vertex which assets exist and provides their previews. The original Unity assets remain in <code>Compiler/Assets</code> for the map compiler to use.

# In the Project window, right-click <code>Assets/CustomContent/MyArena</code> and choose '''Create → Vertex → Asset catalog profile'''. Name the asset <code>MyArenaAssets</code>.
# Select it and set '''Catalog Id''' to <code>my_arena.assets</code> and '''Catalog Version''' to <code>1</code>. Keep these values stable as you edit this asset library.
# Expand '''Folders''' in the Inspector and add one element. Set that element's '''Folder''' to <code>Assets/CustomContent/MyArena</code> and '''Ownership''' to <code>custom</code>.
# Enable '''Materials''', '''Models''', '''Prefabs''', and '''Textures''' for that element. Leave '''Material Dependencies Only''' disabled so your standalone materials appear in the picker. Leave the other settings at their defaults.
# Save the project. With <code>MyArenaAssets</code> still selected, choose '''Tools → Vertex → Export Selected Asset Catalog'''.
# In the save dialog, navigate out of <code>Compiler</code> to your copy's <code>Authoring</code> folder. Save as <code>MyArena.vertexassets</code>. The exporter also writes a <code>previews</code> folder beside it.

'''Checkpoint:''' Both <code>GrimwarSDK/Authoring/MyArena.vertexassets</code> and its preview files exist. Keep the catalog and previews together. Do not replace the supplied <code>Assets/VertexSdk/Assets.asset</code> profile or the base-game catalog.

Use <code>custom</code> ownership for your own files. <code>base</code> means the asset already ships with Grimwar; it does not mean “shared between my maps.” Incorrectly marking a new asset as base prevents the map from carrying the asset players need. You do not need to add your files to the base game's Addressables groups.

== 6. Connect the working copy ==

This is a one-time setup for this SDK copy. Two small JSON edits connect its editable Unity project and exported catalog. Use a plain-text editor, preserve the other fields, and keep the original files as backups outside the Unity <code>Assets</code> folder.

=== Tell Vertex to build from your Unity project ===

Open <code>MyArena/GrimwarSDK/Grimwar.vertexsdk</code> in a text editor.

# Keep <code>"compilerProject": "Compiler"</code>.
# Remove the <code>compilerInputs</code> property and its value. That inventory describes the unmodified distributed SDK.
# Add <code>"editorProject": "Compiler"</code> alongside <code>compilerProject</code>.
# Preserve <code>formatVersion</code>, <code>game</code>, and any <code>resourceTools</code> entries exactly as supplied. Separate neighboring properties with commas and leave no trailing comma before <code>}</code>.

The two project properties should now read as follows. This fragment shows only those properties; '''do not replace the whole file''' with it.

<syntaxhighlight lang="json">
{
"compilerProject": "Compiler",
"editorProject": "Compiler"
}
</syntaxhighlight>

This makes the copy a local developer connection: Vertex captures the saved assets from your <code>Compiler</code> project when building. Leaving the distributed connection unchanged would use its prepared compiler cache instead.

=== Add your catalog to the game's asset list ===

Open <code>MyArena/GrimwarSDK/Authoring/Grimwar.vertexgame</code>. Find the <code>assetCatalogs</code> array. Keep every existing entry, including <code>grimwar.base</code>. Add a comma after its last existing entry, then insert this additional object before the array's closing <code>]</code>:

<syntaxhighlight lang="json">
{
"id": "my_arena.assets",
"version": "1",
"path": "MyArena.vertexassets"
}
</syntaxhighlight>

The path is relative to <code>Authoring/Grimwar.vertexgame</code>, so do not prepend <code>Authoring/</code> again. Keep the game's ID, version, entity catalogs, and build configuration unchanged. The new entry's ID and version must match the Unity catalog profile from step 5.

=== Choose this connection in Vertex ===

# Save both JSON files and your Unity asset changes. Let Unity finish importing.
# Open your map in Vertex. Under '''Settings → Game and resources''', select '''Choose game SDK…'''. Choose <code>MyArena/GrimwarSDK/Grimwar.vertexsdk</code>, the file in your personal copy. '''File → Open game SDK…''' opens the same chooser.
# Save the map. Saved maps remember their own SDK connection, so repeat the chooser step for an existing map that still uses the Steam SDK.
# Use '''Settings → Game and resources → Reload resources''' after subsequent catalog exports.

'''Checkpoint:''' The material browser contains <code>BrickWall</code> and the model browser contains your crate entries. Base-game materials and entities should still be available. If the base assets disappear, restore the original entries in <code>assetCatalogs</code>.

Do not use '''Load engine assets…''' as a substitute for this setup. Loading a loose preview catalog does not connect a map's compiler to the Unity source assets.

== 7. Use the assets and test the add-on ==

# In Vertex's material browser, search for <code>BrickWall</code>. Drag it onto a brush face; hold '''Shift''' while dropping to apply it to the whole brush. Adjust the face's texture scale and alignment as needed.
# In the model browser, search for <code>Crate</code>. Choose the entry whose source is <code>Prefabs/Crate.prefab</code> and drag it into a viewport. Place it, then check its size and orientation.
# Save the map. In Build, select '''Preview''' and your desktop platform, then '''Play in Game'''. If requested, select the pinned Unity executable and your Grimwar installation in the build settings.
# Walk around the crate in Grimwar to check collision. Inspect the wall's tiling, material, and lighting. Test the actual game even when the Vertex preview looks correct.
# When ready, use '''Export add-on''' with the Release profile and follow [[Grimwar/Steam Workshop addons|the publication guide]].

The build includes referenced custom Unity assets and their required custom dependencies. The exported catalog is a browser index, not an installable add-on; distribute the built add-on rather than loose <code>.mat</code>, <code>.prefab</code>, or <code>.vertexassets</code> files. Players do not need your Unity project to play the compiled map.

Grimwar's SDK still uses '''Play in Game''' and '''Export add-on''' with this connection. It does not provide the base game's playable Unity project or a '''Save to Unity''' workflow.

== Updating assets, sharing source, and SDK updates ==

For each edit: '''change the Unity asset → save/apply it → export MyArenaAssets to the same MyArena.vertexassets file → Reload resources in Vertex → rebuild and playtest'''. Editing only the PNG or prefab on disk does not refresh an already exported catalog. Changing a prefab instance in a temporary scene does not update the prefab until you apply or save those changes.

Keep existing <code>.meta</code> files and the catalog ID. Vertex references Unity assets by their GUID and local file ID, not just by filename. Move assets inside Unity when reorganizing; deleting and recreating an asset can break map references even if you reuse its name.

To hand editable source to another creator, include the map and scripts, the custom asset folder with all <code>.meta</code> files and its catalog profile, the catalog with its previews, and the connection setup for the matching SDK release. A <code>.vertex</code> map alone does not contain these Unity source assets.

Your personal SDK copy does not update when Steam updates. For a new SDK release, make a fresh working copy, transfer your custom folder with its <code>.meta</code> files, repeat the connection edits on the newly supplied files, and re-export the catalog with the required Unity version. Keep the old working copy until your map builds and playtests successfully. Do not overwrite new SDK packages or the new game profile with old versions.

Reusing this custom library across maps makes authoring convenient, but referenced custom assets are still packaged with each consuming map. The SDK's shared developer materials are already base-game assets. For reusable imported media distributed once as a separate dependency, see [[Grimwar/Custom content#Make a reusable media pack|media packs]]; the file importer there still accepts the formats listed on that page, not arbitrary Unity prefabs or materials.

== If something is missing or wrong ==

{| class="wikitable"
! What you see !! What to check
|-
| Asset exists in Unity but is absent from Vertex || Confirm the file is under the catalog's folder rule, its type is enabled, and you exported the selected custom profile. Confirm the custom catalog entry is in the connected copy's <code>Authoring/Grimwar.vertexgame</code>, then reload resources.
|-
| Model appears, but its material cannot be chosen for a brush || Extract or create a standalone <code>.mat</code>. Embedded materials are hidden. Disable Material Dependencies Only on your custom folder rule and remove a <code>VertexHidden</code> asset label if you intentionally added one.
|-
| Asset previews correctly, but the build says the asset or profile is missing || Check the map's chosen <code>.vertexsdk</code>. Its local <code>Compiler</code> project must contain both the original assets and <code>MyArenaAssets.asset</code>. A copied catalog alone is insufficient. Check the <code>editorProject</code> edit and preserve <code>.meta</code> files.
|-
| Material is pink, gray, or missing a texture || Check the shader and renderer material slots in Unity, and confirm all texture references resolve. Use URP/Lit and check Unity's render pipeline assignment from step 1, then save, export, reload, and rebuild. A Vertex preview does not prove that an unsupported shader can run in the game.
|-
| Crate looks correct but the player walks through it || Check the saved prefab's enabled collider, the placed model's collision setting in Vertex, and whether you placed the prefab rather than the raw model. Test collision in Grimwar.
|-
| Crate is too large, too small, or rotated incorrectly || Correct the model import scale/orientation or the saved prefab transform in Unity. Apply, re-export, reload, and rebuild. Compare against a one-metre cube.
|-
| Connection fails after editing JSON || Check commas and brackets, preserve the supplied fields, and match the catalog's ID/version exactly. The catalog path is relative to the game profile; both project paths are relative to <code>Grimwar.vertexsdk</code>.
|-
| Compiler setup reports unresolved packages or missing package-resolution data || Open the copied <code>Compiler</code> project in the pinned Unity editor and let Package Manager and asset import finish successfully before building from Vertex.
|}

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

Vertex/Editing

2026-10-03T02:40:49Z

DocumentationBot: Document shared matte developer materials

{{VertexNav}}

Build a small room and test its scale and collision in your game before adding detail. The active game profile sets the map's units; changing the connected profile does not rescale an existing map.

== Move around and select ==

{| class="wikitable"
! Input !! Action
|-
| <kbd>Z</kbd>, then <kbd>WASD</kbd> / <kbd>Q</kbd> / <kbd>E</kbd> || Enter free camera and move. Hold Shift to move faster; Escape exits.
|-
| <kbd>F</kbd> || Frame the selection.
|-
| <kbd>1</kbd>–<kbd>4</kbd> / Space || Choose a view / maximize the view.
|-
| <kbd>S</kbd> / <kbd>G</kbd> / <kbd>R</kbd> / <kbd>T</kbd> || Select / move / rotate / scale.
|-
| <kbd>V</kbd> / <kbd>E</kbd> / <kbd>H</kbd> || Edit vertices / edges / faces.
|-
| <kbd>B</kbd> / <kbd>Shift+A</kbd> || Draw / texture tools.
|-
| <kbd>[</kbd> / <kbd>]</kbd> || Decrease / increase the grid size.
|-
| <kbd>I</kbd> / <kbd>Shift+C</kbd> || Isolate the selection / preview collision.
|}

Shortcuts yield to text fields and free camera. Select an object before selecting its vertices, edges, or faces. Delete in a component tool removes those components; deleting in the hierarchy removes whole objects.

Switch '''Global / Local''' above the views to choose transform axes. Local follows the active object or selected face. Numeric fields accept arithmetic, so you can enter a value such as <code>128*2</code>.

== Draw geometry ==

# Choose the draw tool and a shape.
# Set the grid and depth, then drag out the footprint.
# Apply the preview with Enter or '''Apply'''. Escape cancels.
# Use Move, Rotate, and Scale to position it. Keep large structural pieces on the grid.

Drawing on an existing collider starts the new shape on that surface. Empty space uses the draw plane. Hold Shift while drawing for equal width, height, and depth. Stairs fit the drawn bounds; adjust their step count in the creation settings.

Parametric shapes retain their settings. Use '''Convert to brush''' when you need to edit individual components. That conversion gives up the original shape controls.

=== Geometry shortcuts ===

The contextual bar above the viewports shows actions for the current tool and selection: Extrude and Inset for faces, Bevel for edges, Weld for vertices, and construction actions for objects. Each action has an icon and label, with its shortcut in the tooltip, and starts the same live adjustment as the keyboard. Unavailable actions stay disabled.

Select faces, edges, or objects, press the operation's shortcut, then '''drag the +/− handle in any viewport''' or type a value. Release the mouse to pause; grab the handle in another view to continue the same preview. Moving between views does not change the amount. All views show the same value. '''Enter or a click in empty viewport space applies; Escape or right-click cancels.''' The entire operation, including drags in different views, is one Undo.

Mouse adjustments snap to the grid. '''[ / ]''' changes the grid during an operation without leaving the preview or changing mouse sensitivity. Hold '''Shift''' for slower adjustment and a finer grid step, or '''Ctrl/Cmd''' to bypass snapping. Typed values and calculations such as <code>128/3</code> stay exact. Backspace edits the input; clearing it returns to mouse adjustment. Invalid input must be corrected or canceled before applying.

Every viewport shows a '''+/− adjustment gizmo''' that follows its view direction. Drag along the arrow to increase the amount, or back toward − to decrease it. Extrude and offset follow the face normal; inset points inward from a face edge. An axis viewed head-on, and operations without a single direction, use a horizontal guide. Movement across the guide does not change the amount.

Mouse sensitivity follows the view's world scale, independently of grid spacing; copy counts use 10 pixels per copy. The pointer wraps at viewport edges while dragging and is free as soon as you release it. On desktops without pointer warping, release and re-grab the handle to continue.

You can right-drag to orbit or pan, middle-drag to pan, scroll to zoom, frame the selection, and maximize or restore a viewport without ending the operation. '''Z''' enters free camera while keeping the preview and exact input. Mouse look and '''WASD/QE''' move the camera; '''Z or Escape''' returns to adjustment. Escape after leaving free camera cancels the operation. During bevel, scroll changes segments; '''Ctrl/Cmd+scroll''' zooms instead. Linear and radial copy shortcuts adjust the number of additional copies, using the configured spacing or angle.

{| class="wikitable"
! Shortcut !! Operation
|-
| Shift+E / Alt+E || Extrude individual faces / extrude a region
|-
| Shift+I / Shift+B / Shift+H || Inset faces / bevel edges / hollow walls
|-
| Alt+F || Offset faces along their normals
|-
| Ctrl/Cmd+J / Shift+S || Combine objects / subtract last selected
|-
| Shift+W / Shift+K || Weld vertices / connect vertices
|-
| Shift+X / Shift+D || Split edges / dissolve edges
|-
| Shift+F / Shift+J || Cap holes / bridge boundaries
|-
| Alt+Delete / Alt+R || Delete selected faces / repair mesh seams
|-
| Alt+T / Alt+W || Convert a face to terrain / sew terrain patches
|-
| Shift+T / Alt+Shift+T || Sculpt terrain / toggle terrain and surface
|-
| Alt+B / Alt+Shift+B || Convert to brush / split into brushes
|-
| Alt+A || Create an editable array
|-
| Alt+Shift+A / Alt+Shift+R || Make linear / radial copies
|-
| Alt+M / Alt+Shift+M || Create symmetry / unlink selection
|-
| Alt+Shift+C / Alt+Shift+W || Clip at symmetry planes / weld independent symmetry
|-
| Alt+Shift+U || Remove all symmetry links
|-
| Alt+P / Alt+X / Alt+L || Pick pivot / use face axes / align to another face
|}

Commands without a numeric adjustment apply immediately; picking, alignment, and sculpting enter their existing tools. Shortcuts appear in the Geometry menu and inspector button tooltips. They only edit the map from the Level workspace, and yield to text fields and free camera.

Press '''C''' to draw a clipping plane, then Enter to apply it. While clipping, '''Alt+C''' toggles Slice (keep both sides) and '''Alt+F''' flips the kept side, including an existing preview. Alt+Left/Right, Alt+Up/Down, and Alt+Page Up/Down flip the selection along the focused view's axes.

You can still use the inspector. '''Enter in a construction numeric field''' creates and applies the operation directly. Changing a distance during an active preview updates that preview; Enter applies and Escape cancels. Enter in an open surface's extrusion field uses region extrusion. Preview buttons remain available when you want to inspect a result first.

=== Doorways and windows ===

For a doorway through a solid wall, place a box cutter through the wall, select the wall and then the cutter, and apply '''Subtract last selected'''. The operation removes the cutter.

For a framed opening, use '''Inset faces''', apply it, scale the selected inner face, and delete that face. A thick wall needs openings on both sides. '''Bridge boundaries''' joins compatible open rims to form the inside surfaces.

Choose '''Auto''' or '''Exact''' collision for a wall with an opening. Box and Convex collision can fill that opening even when the rendered wall looks correct.

== Materials, models, and prefabs ==

The '''Built-in''' material folder provides Developer Gray, Orange, Blue, White, and Red. These grid textures use matte materials without shine. Maps reference the game's shared developer materials instead of bundling their own copies. Existing compiled maps need rebuilding to replace the older embedded materials.

Drag a material from '''Materials''' onto a face. Hold Shift during the drop to apply it to the whole brush. These drops preserve the existing UV alignment.

In Texture mode, left-click samples a face's material and alignment; right-drag paints them. Adjust texture size and offsets in the inspector. Texture lock keeps the mapping attached while moving or resizing geometry.

Drag models from '''Models''' into a view, or use '''Place at pivot'''. Game models retain references to the SDK assets. For your own models or textures, use [[Vertex/Content|Content import]].

'''Prefabs''' contains reusable assemblies supplied by the game. They can include geometry, models, entities, and scripts. Linked instances retain local changes when refreshed. '''Unpack''' removes the source link. Save your own selections with '''File → Save selection as prefab…'''.

== Terrain ==

Select one four-sided face and press '''Alt+T''' (or choose '''Convert to terrain'''). Type the subdivision count and press Enter. The terrain replaces that brush with an open patch, so duplicate the brush first if you need to keep the solid.

Choose '''Base texture''' and '''Paint texture''' in the Terrain inspector. '''Paint textures''' reveals the second texture; Shift erases back to the base. '''Sculpt terrain''' raises, lowers, or smooths the surface. Use enough subdivisions for the shape you need, and inspect collision after sculpting.

In paint and sculpt modes, '''scroll up to enlarge the brush and down to shrink it'''. '''Shift+scroll''' adjusts strength; '''Ctrl/Cmd+scroll''' zooms the view. The brush outline and radius field update immediately. Changing brush settings does not paint or create an Undo step.

== Collision and lighting ==

The '''Collision''' section controls whether an object blocks movement, its collision shape, and its filters. Start with Auto. Use '''Create collision proxy''' when a simpler invisible shape would make movement smoother, such as a ramp over stairs. Creating a proxy disables the original collider; deleting the proxy does not restore it.

Set the sun, sky, ambient light, and fog in '''Map Environment'''. Game SDKs decide which lighting and spatial bakes are required. Inspect the built map in the game: the Vertex viewport does not reproduce every game shader or baked lighting effect.

== Entities and logic ==

Choose an entity in the creation controls, place it, and edit its properties in the inspector. A point has a position and direction. A bounds entity defines a volume. A brush entity owns geometry placed under it in the hierarchy.

Name entities before wiring them in [[Vertex/VSig|VSig]]. Game-specific reference pages explain their behavior; Grimwar's [[Grimwar/Entities|entity index]] covers every supplied type.

== Validate and export ==

Use '''File → Validate map''' to find geometry, reference, asset, and collision problems. Validation reports problems without repairing the map.

'''Export compiled meshes…''' writes <code>.vertexmesh</code> for engine import. '''Export selection as model…''' writes OBJ or FBX geometry for other tools. Model export does not carry game entities, engine model placements, or collision. Use the game's Build controls for a playable package.

Hidden objects still export. Hide and isolate are editing aids; delete an object or change its output settings when it should not ship.

[[Category:Vertex]] [[Category:Mapping]]

Vertex/Editing

2026-10-02T23:23:18Z

DocumentationBot: Document free camera during geometry adjustments

{{VertexNav}}

Build a small room and test its scale and collision in your game before adding detail. The active game profile sets the map's units; changing the connected profile does not rescale an existing map.

== Move around and select ==

{| class="wikitable"
! Input !! Action
|-
| <kbd>Z</kbd>, then <kbd>WASD</kbd> / <kbd>Q</kbd> / <kbd>E</kbd> || Enter free camera and move. Hold Shift to move faster; Escape exits.
|-
| <kbd>F</kbd> || Frame the selection.
|-
| <kbd>1</kbd>–<kbd>4</kbd> / Space || Choose a view / maximize the view.
|-
| <kbd>S</kbd> / <kbd>G</kbd> / <kbd>R</kbd> / <kbd>T</kbd> || Select / move / rotate / scale.
|-
| <kbd>V</kbd> / <kbd>E</kbd> / <kbd>H</kbd> || Edit vertices / edges / faces.
|-
| <kbd>B</kbd> / <kbd>Shift+A</kbd> || Draw / texture tools.
|-
| <kbd>[</kbd> / <kbd>]</kbd> || Decrease / increase the grid size.
|-
| <kbd>I</kbd> / <kbd>Shift+C</kbd> || Isolate the selection / preview collision.
|}

Shortcuts yield to text fields and free camera. Select an object before selecting its vertices, edges, or faces. Delete in a component tool removes those components; deleting in the hierarchy removes whole objects.

Switch '''Global / Local''' above the views to choose transform axes. Local follows the active object or selected face. Numeric fields accept arithmetic, so you can enter a value such as <code>128*2</code>.

== Draw geometry ==

# Choose the draw tool and a shape.
# Set the grid and depth, then drag out the footprint.
# Apply the preview with Enter or '''Apply'''. Escape cancels.
# Use Move, Rotate, and Scale to position it. Keep large structural pieces on the grid.

Drawing on an existing collider starts the new shape on that surface. Empty space uses the draw plane. Hold Shift while drawing for equal width, height, and depth. Stairs fit the drawn bounds; adjust their step count in the creation settings.

Parametric shapes retain their settings. Use '''Convert to brush''' when you need to edit individual components. That conversion gives up the original shape controls.

=== Geometry shortcuts ===

The contextual bar above the viewports shows actions for the current tool and selection: Extrude and Inset for faces, Bevel for edges, Weld for vertices, and construction actions for objects. Each action has an icon and label, with its shortcut in the tooltip, and starts the same live adjustment as the keyboard. Unavailable actions stay disabled.

Select faces, edges, or objects, press the operation's shortcut, then '''drag the +/− handle in any viewport''' or type a value. Release the mouse to pause; grab the handle in another view to continue the same preview. Moving between views does not change the amount. All views show the same value. '''Enter or a click in empty viewport space applies; Escape or right-click cancels.''' The entire operation, including drags in different views, is one Undo.

Mouse adjustments snap to the grid. '''[ / ]''' changes the grid during an operation without leaving the preview or changing mouse sensitivity. Hold '''Shift''' for slower adjustment and a finer grid step, or '''Ctrl/Cmd''' to bypass snapping. Typed values and calculations such as <code>128/3</code> stay exact. Backspace edits the input; clearing it returns to mouse adjustment. Invalid input must be corrected or canceled before applying.

Every viewport shows a '''+/− adjustment gizmo''' that follows its view direction. Drag along the arrow to increase the amount, or back toward − to decrease it. Extrude and offset follow the face normal; inset points inward from a face edge. An axis viewed head-on, and operations without a single direction, use a horizontal guide. Movement across the guide does not change the amount.

Mouse sensitivity follows the view's world scale, independently of grid spacing; copy counts use 10 pixels per copy. The pointer wraps at viewport edges while dragging and is free as soon as you release it. On desktops without pointer warping, release and re-grab the handle to continue.

You can right-drag to orbit or pan, middle-drag to pan, scroll to zoom, frame the selection, and maximize or restore a viewport without ending the operation. '''Z''' enters free camera while keeping the preview and exact input. Mouse look and '''WASD/QE''' move the camera; '''Z or Escape''' returns to adjustment. Escape after leaving free camera cancels the operation. During bevel, scroll changes segments; '''Ctrl/Cmd+scroll''' zooms instead. Linear and radial copy shortcuts adjust the number of additional copies, using the configured spacing or angle.

{| class="wikitable"
! Shortcut !! Operation
|-
| Shift+E / Alt+E || Extrude individual faces / extrude a region
|-
| Shift+I / Shift+B / Shift+H || Inset faces / bevel edges / hollow walls
|-
| Alt+F || Offset faces along their normals
|-
| Ctrl/Cmd+J / Shift+S || Combine objects / subtract last selected
|-
| Shift+W / Shift+K || Weld vertices / connect vertices
|-
| Shift+X / Shift+D || Split edges / dissolve edges
|-
| Shift+F / Shift+J || Cap holes / bridge boundaries
|-
| Alt+Delete / Alt+R || Delete selected faces / repair mesh seams
|-
| Alt+T / Alt+W || Convert a face to terrain / sew terrain patches
|-
| Shift+T / Alt+Shift+T || Sculpt terrain / toggle terrain and surface
|-
| Alt+B / Alt+Shift+B || Convert to brush / split into brushes
|-
| Alt+A || Create an editable array
|-
| Alt+Shift+A / Alt+Shift+R || Make linear / radial copies
|-
| Alt+M / Alt+Shift+M || Create symmetry / unlink selection
|-
| Alt+Shift+C / Alt+Shift+W || Clip at symmetry planes / weld independent symmetry
|-
| Alt+Shift+U || Remove all symmetry links
|-
| Alt+P / Alt+X / Alt+L || Pick pivot / use face axes / align to another face
|}

Commands without a numeric adjustment apply immediately; picking, alignment, and sculpting enter their existing tools. Shortcuts appear in the Geometry menu and inspector button tooltips. They only edit the map from the Level workspace, and yield to text fields and free camera.

Press '''C''' to draw a clipping plane, then Enter to apply it. While clipping, '''Alt+C''' toggles Slice (keep both sides) and '''Alt+F''' flips the kept side, including an existing preview. Alt+Left/Right, Alt+Up/Down, and Alt+Page Up/Down flip the selection along the focused view's axes.

You can still use the inspector. '''Enter in a construction numeric field''' creates and applies the operation directly. Changing a distance during an active preview updates that preview; Enter applies and Escape cancels. Enter in an open surface's extrusion field uses region extrusion. Preview buttons remain available when you want to inspect a result first.

=== Doorways and windows ===

For a doorway through a solid wall, place a box cutter through the wall, select the wall and then the cutter, and apply '''Subtract last selected'''. The operation removes the cutter.

For a framed opening, use '''Inset faces''', apply it, scale the selected inner face, and delete that face. A thick wall needs openings on both sides. '''Bridge boundaries''' joins compatible open rims to form the inside surfaces.

Choose '''Auto''' or '''Exact''' collision for a wall with an opening. Box and Convex collision can fill that opening even when the rendered wall looks correct.

== Materials, models, and prefabs ==

Drag a material from '''Materials''' onto a face. Hold Shift during the drop to apply it to the whole brush. These drops preserve the existing UV alignment.

In Texture mode, left-click samples a face's material and alignment; right-drag paints them. Adjust texture size and offsets in the inspector. Texture lock keeps the mapping attached while moving or resizing geometry.

Drag models from '''Models''' into a view, or use '''Place at pivot'''. Game models retain references to the SDK assets. For your own models or textures, use [[Vertex/Content|Content import]].

'''Prefabs''' contains reusable assemblies supplied by the game. They can include geometry, models, entities, and scripts. Linked instances retain local changes when refreshed. '''Unpack''' removes the source link. Save your own selections with '''File → Save selection as prefab…'''.

== Terrain ==

Select one four-sided face and press '''Alt+T''' (or choose '''Convert to terrain'''). Type the subdivision count and press Enter. The terrain replaces that brush with an open patch, so duplicate the brush first if you need to keep the solid.

Choose '''Base texture''' and '''Paint texture''' in the Terrain inspector. '''Paint textures''' reveals the second texture; Shift erases back to the base. '''Sculpt terrain''' raises, lowers, or smooths the surface. Use enough subdivisions for the shape you need, and inspect collision after sculpting.

In paint and sculpt modes, '''scroll up to enlarge the brush and down to shrink it'''. '''Shift+scroll''' adjusts strength; '''Ctrl/Cmd+scroll''' zooms the view. The brush outline and radius field update immediately. Changing brush settings does not paint or create an Undo step.

== Collision and lighting ==

The '''Collision''' section controls whether an object blocks movement, its collision shape, and its filters. Start with Auto. Use '''Create collision proxy''' when a simpler invisible shape would make movement smoother, such as a ramp over stairs. Creating a proxy disables the original collider; deleting the proxy does not restore it.

Set the sun, sky, ambient light, and fog in '''Map Environment'''. Game SDKs decide which lighting and spatial bakes are required. Inspect the built map in the game: the Vertex viewport does not reproduce every game shader or baked lighting effect.

== Entities and logic ==

Choose an entity in the creation controls, place it, and edit its properties in the inspector. A point has a position and direction. A bounds entity defines a volume. A brush entity owns geometry placed under it in the hierarchy.

Name entities before wiring them in [[Vertex/VSig|VSig]]. Game-specific reference pages explain their behavior; Grimwar's [[Grimwar/Entities|entity index]] covers every supplied type.

== Validate and export ==

Use '''File → Validate map''' to find geometry, reference, asset, and collision problems. Validation reports problems without repairing the map.

'''Export compiled meshes…''' writes <code>.vertexmesh</code> for engine import. '''Export selection as model…''' writes OBJ or FBX geometry for other tools. Model export does not carry game entities, engine model placements, or collision. Use the game's Build controls for a playable package.

Hidden objects still export. Hide and isolate are editing aids; delete an object or change its output settings when it should not ship.

[[Category:Vertex]] [[Category:Mapping]]

Vertex/Editing

2026-10-02T23:04:18Z

DocumentationBot: Document shared geometry handles and adjustment across viewports

{{VertexNav}}

Build a small room and test its scale and collision in your game before adding detail. The active game profile sets the map's units; changing the connected profile does not rescale an existing map.

== Move around and select ==

{| class="wikitable"
! Input !! Action
|-
| <kbd>Z</kbd>, then <kbd>WASD</kbd> / <kbd>Q</kbd> / <kbd>E</kbd> || Enter free camera and move. Hold Shift to move faster; Escape exits.
|-
| <kbd>F</kbd> || Frame the selection.
|-
| <kbd>1</kbd>–<kbd>4</kbd> / Space || Choose a view / maximize the view.
|-
| <kbd>S</kbd> / <kbd>G</kbd> / <kbd>R</kbd> / <kbd>T</kbd> || Select / move / rotate / scale.
|-
| <kbd>V</kbd> / <kbd>E</kbd> / <kbd>H</kbd> || Edit vertices / edges / faces.
|-
| <kbd>B</kbd> / <kbd>Shift+A</kbd> || Draw / texture tools.
|-
| <kbd>[</kbd> / <kbd>]</kbd> || Decrease / increase the grid size.
|-
| <kbd>I</kbd> / <kbd>Shift+C</kbd> || Isolate the selection / preview collision.
|}

Shortcuts yield to text fields and free camera. Select an object before selecting its vertices, edges, or faces. Delete in a component tool removes those components; deleting in the hierarchy removes whole objects.

Switch '''Global / Local''' above the views to choose transform axes. Local follows the active object or selected face. Numeric fields accept arithmetic, so you can enter a value such as <code>128*2</code>.

== Draw geometry ==

# Choose the draw tool and a shape.
# Set the grid and depth, then drag out the footprint.
# Apply the preview with Enter or '''Apply'''. Escape cancels.
# Use Move, Rotate, and Scale to position it. Keep large structural pieces on the grid.

Drawing on an existing collider starts the new shape on that surface. Empty space uses the draw plane. Hold Shift while drawing for equal width, height, and depth. Stairs fit the drawn bounds; adjust their step count in the creation settings.

Parametric shapes retain their settings. Use '''Convert to brush''' when you need to edit individual components. That conversion gives up the original shape controls.

=== Geometry shortcuts ===

The contextual bar above the viewports shows actions for the current tool and selection: Extrude and Inset for faces, Bevel for edges, Weld for vertices, and construction actions for objects. Each action has an icon and label, with its shortcut in the tooltip, and starts the same live adjustment as the keyboard. Unavailable actions stay disabled.

Select faces, edges, or objects, press the operation's shortcut, then '''drag the +/− handle in any viewport''' or type a value. Release the mouse to pause; grab the handle in another view to continue the same preview. Moving between views does not change the amount. All views show the same value. '''Enter or a click in empty viewport space applies; Escape or right-click cancels.''' The entire operation, including drags in different views, is one Undo.

Mouse adjustments snap to the grid. '''[ / ]''' changes the grid during an operation without leaving the preview or changing mouse sensitivity. Hold '''Shift''' for slower adjustment and a finer grid step, or '''Ctrl/Cmd''' to bypass snapping. Typed values and calculations such as <code>128/3</code> stay exact. Backspace edits the input; clearing it returns to mouse adjustment. Invalid input must be corrected or canceled before applying.

Every viewport shows a '''+/− adjustment gizmo''' that follows its view direction. Drag along the arrow to increase the amount, or back toward − to decrease it. Extrude and offset follow the face normal; inset points inward from a face edge. An axis viewed head-on, and operations without a single direction, use a horizontal guide. Movement across the guide does not change the amount.

Mouse sensitivity follows the view's world scale, independently of grid spacing; copy counts use 10 pixels per copy. The pointer wraps at viewport edges while dragging and is free as soon as you release it. On desktops without pointer warping, release and re-grab the handle to continue.

You can right-drag to orbit or pan, middle-drag to pan, scroll to zoom, frame the selection, and maximize or restore a viewport without ending the operation. During bevel, scroll changes segments; '''Ctrl/Cmd+scroll''' zooms instead. Linear and radial copy shortcuts adjust the number of additional copies, using the configured spacing or angle.

{| class="wikitable"
! Shortcut !! Operation
|-
| Shift+E / Alt+E || Extrude individual faces / extrude a region
|-
| Shift+I / Shift+B / Shift+H || Inset faces / bevel edges / hollow walls
|-
| Alt+F || Offset faces along their normals
|-
| Ctrl/Cmd+J / Shift+S || Combine objects / subtract last selected
|-
| Shift+W / Shift+K || Weld vertices / connect vertices
|-
| Shift+X / Shift+D || Split edges / dissolve edges
|-
| Shift+F / Shift+J || Cap holes / bridge boundaries
|-
| Alt+Delete / Alt+R || Delete selected faces / repair mesh seams
|-
| Alt+T / Alt+W || Convert a face to terrain / sew terrain patches
|-
| Shift+T / Alt+Shift+T || Sculpt terrain / toggle terrain and surface
|-
| Alt+B / Alt+Shift+B || Convert to brush / split into brushes
|-
| Alt+A || Create an editable array
|-
| Alt+Shift+A / Alt+Shift+R || Make linear / radial copies
|-
| Alt+M / Alt+Shift+M || Create symmetry / unlink selection
|-
| Alt+Shift+C / Alt+Shift+W || Clip at symmetry planes / weld independent symmetry
|-
| Alt+Shift+U || Remove all symmetry links
|-
| Alt+P / Alt+X / Alt+L || Pick pivot / use face axes / align to another face
|}

Commands without a numeric adjustment apply immediately; picking, alignment, and sculpting enter their existing tools. Shortcuts appear in the Geometry menu and inspector button tooltips. They only edit the map from the Level workspace, and yield to text fields and free camera.

Press '''C''' to draw a clipping plane, then Enter to apply it. While clipping, '''Alt+C''' toggles Slice (keep both sides) and '''Alt+F''' flips the kept side, including an existing preview. Alt+Left/Right, Alt+Up/Down, and Alt+Page Up/Down flip the selection along the focused view's axes.

You can still use the inspector. '''Enter in a construction numeric field''' creates and applies the operation directly. Changing a distance during an active preview updates that preview; Enter applies and Escape cancels. Enter in an open surface's extrusion field uses region extrusion. Preview buttons remain available when you want to inspect a result first.

=== Doorways and windows ===

For a doorway through a solid wall, place a box cutter through the wall, select the wall and then the cutter, and apply '''Subtract last selected'''. The operation removes the cutter.

For a framed opening, use '''Inset faces''', apply it, scale the selected inner face, and delete that face. A thick wall needs openings on both sides. '''Bridge boundaries''' joins compatible open rims to form the inside surfaces.

Choose '''Auto''' or '''Exact''' collision for a wall with an opening. Box and Convex collision can fill that opening even when the rendered wall looks correct.

== Materials, models, and prefabs ==

Drag a material from '''Materials''' onto a face. Hold Shift during the drop to apply it to the whole brush. These drops preserve the existing UV alignment.

In Texture mode, left-click samples a face's material and alignment; right-drag paints them. Adjust texture size and offsets in the inspector. Texture lock keeps the mapping attached while moving or resizing geometry.

Drag models from '''Models''' into a view, or use '''Place at pivot'''. Game models retain references to the SDK assets. For your own models or textures, use [[Vertex/Content|Content import]].

'''Prefabs''' contains reusable assemblies supplied by the game. They can include geometry, models, entities, and scripts. Linked instances retain local changes when refreshed. '''Unpack''' removes the source link. Save your own selections with '''File → Save selection as prefab…'''.

== Terrain ==

Select one four-sided face and press '''Alt+T''' (or choose '''Convert to terrain'''). Type the subdivision count and press Enter. The terrain replaces that brush with an open patch, so duplicate the brush first if you need to keep the solid.

Choose '''Base texture''' and '''Paint texture''' in the Terrain inspector. '''Paint textures''' reveals the second texture; Shift erases back to the base. '''Sculpt terrain''' raises, lowers, or smooths the surface. Use enough subdivisions for the shape you need, and inspect collision after sculpting.

In paint and sculpt modes, '''scroll up to enlarge the brush and down to shrink it'''. '''Shift+scroll''' adjusts strength; '''Ctrl/Cmd+scroll''' zooms the view. The brush outline and radius field update immediately. Changing brush settings does not paint or create an Undo step.

== Collision and lighting ==

The '''Collision''' section controls whether an object blocks movement, its collision shape, and its filters. Start with Auto. Use '''Create collision proxy''' when a simpler invisible shape would make movement smoother, such as a ramp over stairs. Creating a proxy disables the original collider; deleting the proxy does not restore it.

Set the sun, sky, ambient light, and fog in '''Map Environment'''. Game SDKs decide which lighting and spatial bakes are required. Inspect the built map in the game: the Vertex viewport does not reproduce every game shader or baked lighting effect.

== Entities and logic ==

Choose an entity in the creation controls, place it, and edit its properties in the inspector. A point has a position and direction. A bounds entity defines a volume. A brush entity owns geometry placed under it in the hierarchy.

Name entities before wiring them in [[Vertex/VSig|VSig]]. Game-specific reference pages explain their behavior; Grimwar's [[Grimwar/Entities|entity index]] covers every supplied type.

== Validate and export ==

Use '''File → Validate map''' to find geometry, reference, asset, and collision problems. Validation reports problems without repairing the map.

'''Export compiled meshes…''' writes <code>.vertexmesh</code> for engine import. '''Export selection as model…''' writes OBJ or FBX geometry for other tools. Model export does not carry game entities, engine model placements, or collision. Use the game's Build controls for a playable package.

Hidden objects still export. Hide and isolate are editing aids; delete an object or change its output settings when it should not ship.

[[Category:Vertex]] [[Category:Mapping]]

Vertex/Editing

2026-10-02T22:23:17Z

DocumentationBot: Document geometry gizmos, pointer wrapping and grid shortcuts during adjustment

{{VertexNav}}

Build a small room and test its scale and collision in your game before adding detail. The active game profile sets the map's units; changing the connected profile does not rescale an existing map.

== Move around and select ==

{| class="wikitable"
! Input !! Action
|-
| <kbd>Z</kbd>, then <kbd>WASD</kbd> / <kbd>Q</kbd> / <kbd>E</kbd> || Enter free camera and move. Hold Shift to move faster; Escape exits.
|-
| <kbd>F</kbd> || Frame the selection.
|-
| <kbd>1</kbd>–<kbd>4</kbd> / Space || Choose a view / maximize the view.
|-
| <kbd>S</kbd> / <kbd>G</kbd> / <kbd>R</kbd> / <kbd>T</kbd> || Select / move / rotate / scale.
|-
| <kbd>V</kbd> / <kbd>E</kbd> / <kbd>H</kbd> || Edit vertices / edges / faces.
|-
| <kbd>B</kbd> / <kbd>Shift+A</kbd> || Draw / texture tools.
|-
| <kbd>[</kbd> / <kbd>]</kbd> || Decrease / increase the grid size.
|-
| <kbd>I</kbd> / <kbd>Shift+C</kbd> || Isolate the selection / preview collision.
|}

Shortcuts yield to text fields and free camera. Select an object before selecting its vertices, edges, or faces. Delete in a component tool removes those components; deleting in the hierarchy removes whole objects.

Switch '''Global / Local''' above the views to choose transform axes. Local follows the active object or selected face. Numeric fields accept arithmetic, so you can enter a value such as <code>128*2</code>.

== Draw geometry ==

# Choose the draw tool and a shape.
# Set the grid and depth, then drag out the footprint.
# Apply the preview with Enter or '''Apply'''. Escape cancels.
# Use Move, Rotate, and Scale to position it. Keep large structural pieces on the grid.

Drawing on an existing collider starts the new shape on that surface. Empty space uses the draw plane. Hold Shift while drawing for equal width, height, and depth. Stairs fit the drawn bounds; adjust their step count in the creation settings.

Parametric shapes retain their settings. Use '''Convert to brush''' when you need to edit individual components. That conversion gives up the original shape controls.

=== Geometry shortcuts ===

The contextual bar above the viewports shows actions for the current tool and selection: Extrude and Inset for faces, Bevel for edges, Weld for vertices, and construction actions for objects. Each action has an icon and label, with its shortcut in the tooltip, and starts the same live adjustment as the keyboard. Unavailable actions stay disabled.

Select faces, edges, or objects, press the operation's shortcut, then '''move the mouse or type a value'''. '''Enter or left-click applies; Escape or right-click cancels.''' The status bar shows the current value and controls. Each completed operation is one Undo.

Mouse adjustments snap to the grid. '''[ / ]''' changes the grid during an operation without leaving the preview or changing mouse sensitivity. Hold '''Shift''' for slower adjustment and a finer grid step, or '''Ctrl/Cmd''' to bypass snapping. Typed values and calculations such as <code>128/3</code> stay exact. Backspace edits the input; clearing it returns to mouse adjustment. Invalid input must be corrected or canceled before applying.

The active viewport shows the value and a '''+/− adjustment gizmo'''. Move along the arrow to increase the amount, or back toward − to decrease it. Extrude and offset follow the face normal; inset points inward from a face edge. An axis viewed head-on, and operations without a single direction, use a horizontal guide. Movement across the guide does not change the amount.

Mouse sensitivity follows the view's world scale, independently of grid spacing; copy counts use 10 pixels per copy. The pointer moves to the handle when you start and wraps at the viewport edges, so adjustment has no screen-edge limit. On desktops without pointer warping, leaving the viewport pauses adjustment; re-entry anchors the pointer without a jump.

During bevel, the mouse wheel changes the segment count. Linear and radial copy shortcuts adjust the number of additional copies, using the configured spacing or angle.

{| class="wikitable"
! Shortcut !! Operation
|-
| Shift+E / Alt+E || Extrude individual faces / extrude a region
|-
| Shift+I / Shift+B / Shift+H || Inset faces / bevel edges / hollow walls
|-
| Alt+F || Offset faces along their normals
|-
| Ctrl/Cmd+J / Shift+S || Combine objects / subtract last selected
|-
| Shift+W / Shift+K || Weld vertices / connect vertices
|-
| Shift+X / Shift+D || Split edges / dissolve edges
|-
| Shift+F / Shift+J || Cap holes / bridge boundaries
|-
| Alt+Delete / Alt+R || Delete selected faces / repair mesh seams
|-
| Alt+T / Alt+W || Convert a face to terrain / sew terrain patches
|-
| Shift+T / Alt+Shift+T || Sculpt terrain / toggle terrain and surface
|-
| Alt+B / Alt+Shift+B || Convert to brush / split into brushes
|-
| Alt+A || Create an editable array
|-
| Alt+Shift+A / Alt+Shift+R || Make linear / radial copies
|-
| Alt+M / Alt+Shift+M || Create symmetry / unlink selection
|-
| Alt+Shift+C / Alt+Shift+W || Clip at symmetry planes / weld independent symmetry
|-
| Alt+Shift+U || Remove all symmetry links
|-
| Alt+P / Alt+X / Alt+L || Pick pivot / use face axes / align to another face
|}

Commands without a numeric adjustment apply immediately; picking, alignment, and sculpting enter their existing tools. Shortcuts appear in the Geometry menu and inspector button tooltips. They only edit the map from the Level workspace, and yield to text fields and free camera.

Press '''C''' to draw a clipping plane, then Enter to apply it. While clipping, '''Alt+C''' toggles Slice (keep both sides) and '''Alt+F''' flips the kept side, including an existing preview. Alt+Left/Right, Alt+Up/Down, and Alt+Page Up/Down flip the selection along the focused view's axes.

You can still use the inspector. '''Enter in a construction numeric field''' creates and applies the operation directly. Changing a distance during an active preview updates that preview; Enter applies and Escape cancels. Enter in an open surface's extrusion field uses region extrusion. Preview buttons remain available when you want to inspect a result first.

=== Doorways and windows ===

For a doorway through a solid wall, place a box cutter through the wall, select the wall and then the cutter, and apply '''Subtract last selected'''. The operation removes the cutter.

For a framed opening, use '''Inset faces''', apply it, scale the selected inner face, and delete that face. A thick wall needs openings on both sides. '''Bridge boundaries''' joins compatible open rims to form the inside surfaces.

Choose '''Auto''' or '''Exact''' collision for a wall with an opening. Box and Convex collision can fill that opening even when the rendered wall looks correct.

== Materials, models, and prefabs ==

Drag a material from '''Materials''' onto a face. Hold Shift during the drop to apply it to the whole brush. These drops preserve the existing UV alignment.

In Texture mode, left-click samples a face's material and alignment; right-drag paints them. Adjust texture size and offsets in the inspector. Texture lock keeps the mapping attached while moving or resizing geometry.

Drag models from '''Models''' into a view, or use '''Place at pivot'''. Game models retain references to the SDK assets. For your own models or textures, use [[Vertex/Content|Content import]].

'''Prefabs''' contains reusable assemblies supplied by the game. They can include geometry, models, entities, and scripts. Linked instances retain local changes when refreshed. '''Unpack''' removes the source link. Save your own selections with '''File → Save selection as prefab…'''.

== Terrain ==

Select one four-sided face and press '''Alt+T''' (or choose '''Convert to terrain'''). Type the subdivision count and press Enter. The terrain replaces that brush with an open patch, so duplicate the brush first if you need to keep the solid.

Choose '''Base texture''' and '''Paint texture''' in the Terrain inspector. '''Paint textures''' reveals the second texture; Shift erases back to the base. '''Sculpt terrain''' raises, lowers, or smooths the surface. Use enough subdivisions for the shape you need, and inspect collision after sculpting.

In paint and sculpt modes, '''scroll up to enlarge the brush and down to shrink it'''. '''Shift+scroll''' adjusts strength; '''Ctrl/Cmd+scroll''' zooms the view. The brush outline and radius field update immediately. Changing brush settings does not paint or create an Undo step.

== Collision and lighting ==

The '''Collision''' section controls whether an object blocks movement, its collision shape, and its filters. Start with Auto. Use '''Create collision proxy''' when a simpler invisible shape would make movement smoother, such as a ramp over stairs. Creating a proxy disables the original collider; deleting the proxy does not restore it.

Set the sun, sky, ambient light, and fog in '''Map Environment'''. Game SDKs decide which lighting and spatial bakes are required. Inspect the built map in the game: the Vertex viewport does not reproduce every game shader or baked lighting effect.

== Entities and logic ==

Choose an entity in the creation controls, place it, and edit its properties in the inspector. A point has a position and direction. A bounds entity defines a volume. A brush entity owns geometry placed under it in the hierarchy.

Name entities before wiring them in [[Vertex/VSig|VSig]]. Game-specific reference pages explain their behavior; Grimwar's [[Grimwar/Entities|entity index]] covers every supplied type.

== Validate and export ==

Use '''File → Validate map''' to find geometry, reference, asset, and collision problems. Validation reports problems without repairing the map.

'''Export compiled meshes…''' writes <code>.vertexmesh</code> for engine import. '''Export selection as model…''' writes OBJ or FBX geometry for other tools. Model export does not carry game entities, engine model placements, or collision. Use the game's Build controls for a playable package.

Hidden objects still export. Hide and isolate are editing aids; delete an object or change its output settings when it should not ship.

[[Category:Vertex]] [[Category:Mapping]]

Vertex/Editing

2026-10-02T20:30:08Z

DocumentationBot: Document predictable mouse sizing and terrain brush wheel controls

{{VertexNav}}

Build a small room and test its scale and collision in your game before adding detail. The active game profile sets the map's units; changing the connected profile does not rescale an existing map.

== Move around and select ==

{| class="wikitable"
! Input !! Action
|-
| <kbd>Z</kbd>, then <kbd>WASD</kbd> / <kbd>Q</kbd> / <kbd>E</kbd> || Enter free camera and move. Hold Shift to move faster; Escape exits.
|-
| <kbd>F</kbd> || Frame the selection.
|-
| <kbd>1</kbd>–<kbd>4</kbd> / Space || Choose a view / maximize the view.
|-
| <kbd>S</kbd> / <kbd>G</kbd> / <kbd>R</kbd> / <kbd>T</kbd> || Select / move / rotate / scale.
|-
| <kbd>V</kbd> / <kbd>E</kbd> / <kbd>H</kbd> || Edit vertices / edges / faces.
|-
| <kbd>B</kbd> / <kbd>Shift+A</kbd> || Draw / texture tools.
|-
| <kbd>[</kbd> / <kbd>]</kbd> || Decrease / increase the grid size.
|-
| <kbd>I</kbd> / <kbd>Shift+C</kbd> || Isolate the selection / preview collision.
|}

Shortcuts yield to text fields and free camera. Select an object before selecting its vertices, edges, or faces. Delete in a component tool removes those components; deleting in the hierarchy removes whole objects.

Switch '''Global / Local''' above the views to choose transform axes. Local follows the active object or selected face. Numeric fields accept arithmetic, so you can enter a value such as <code>128*2</code>.

== Draw geometry ==

# Choose the draw tool and a shape.
# Set the grid and depth, then drag out the footprint.
# Apply the preview with Enter or '''Apply'''. Escape cancels.
# Use Move, Rotate, and Scale to position it. Keep large structural pieces on the grid.

Drawing on an existing collider starts the new shape on that surface. Empty space uses the draw plane. Hold Shift while drawing for equal width, height, and depth. Stairs fit the drawn bounds; adjust their step count in the creation settings.

Parametric shapes retain their settings. Use '''Convert to brush''' when you need to edit individual components. That conversion gives up the original shape controls.

=== Geometry shortcuts ===

The contextual bar above the viewports shows actions for the current tool and selection: Extrude and Inset for faces, Bevel for edges, Weld for vertices, and construction actions for objects. Each action has an icon and label, with its shortcut in the tooltip, and starts the same live adjustment as the keyboard. Unavailable actions stay disabled.

Select faces, edges, or objects, press the operation's shortcut, then '''move the mouse or type a value'''. '''Enter or left-click applies; Escape or right-click cancels.''' The status bar shows the current value and controls. Each completed operation is one Undo.

Mouse adjustments snap to the grid. Hold '''Shift''' for slower adjustment and a finer grid step, or '''Ctrl/Cmd''' to bypass snapping. Typed values and calculations such as <code>128/3</code> stay exact. Backspace edits the input; clearing it returns to mouse adjustment. Invalid input must be corrected or canceled before applying.

The active viewport shows the current value and a direction guide. For every operation and every view, '''left decreases the value and right increases it'''; vertical movement does nothing. Distance sensitivity is one grid step per 16 pixels; copy counts use 10 pixels per copy. Leaving the viewport pauses adjustment. Re-entering anchors the mouse at its new position without changing the value. During bevel, the mouse wheel changes the segment count. Linear and radial copy shortcuts adjust the number of additional copies, using the configured spacing or angle.

{| class="wikitable"
! Shortcut !! Operation
|-
| Shift+E / Alt+E || Extrude individual faces / extrude a region
|-
| Shift+I / Shift+B / Shift+H || Inset faces / bevel edges / hollow walls
|-
| Alt+F || Offset faces along their normals
|-
| Ctrl/Cmd+J / Shift+S || Combine objects / subtract last selected
|-
| Shift+W / Shift+K || Weld vertices / connect vertices
|-
| Shift+X / Shift+D || Split edges / dissolve edges
|-
| Shift+F / Shift+J || Cap holes / bridge boundaries
|-
| Alt+Delete / Alt+R || Delete selected faces / repair mesh seams
|-
| Alt+T / Alt+W || Convert a face to terrain / sew terrain patches
|-
| Shift+T / Alt+Shift+T || Sculpt terrain / toggle terrain and surface
|-
| Alt+B / Alt+Shift+B || Convert to brush / split into brushes
|-
| Alt+A || Create an editable array
|-
| Alt+Shift+A / Alt+Shift+R || Make linear / radial copies
|-
| Alt+M / Alt+Shift+M || Create symmetry / unlink selection
|-
| Alt+Shift+C / Alt+Shift+W || Clip at symmetry planes / weld independent symmetry
|-
| Alt+Shift+U || Remove all symmetry links
|-
| Alt+P / Alt+X / Alt+L || Pick pivot / use face axes / align to another face
|}

Commands without a numeric adjustment apply immediately; picking, alignment, and sculpting enter their existing tools. Shortcuts appear in the Geometry menu and inspector button tooltips. They only edit the map from the Level workspace, and yield to text fields and free camera.

Press '''C''' to draw a clipping plane, then Enter to apply it. While clipping, '''Alt+C''' toggles Slice (keep both sides) and '''Alt+F''' flips the kept side, including an existing preview. Alt+Left/Right, Alt+Up/Down, and Alt+Page Up/Down flip the selection along the focused view's axes.

You can still use the inspector. '''Enter in a construction numeric field''' creates and applies the operation directly. Changing a distance during an active preview updates that preview; Enter applies and Escape cancels. Enter in an open surface's extrusion field uses region extrusion. Preview buttons remain available when you want to inspect a result first.

=== Doorways and windows ===

For a doorway through a solid wall, place a box cutter through the wall, select the wall and then the cutter, and apply '''Subtract last selected'''. The operation removes the cutter.

For a framed opening, use '''Inset faces''', apply it, scale the selected inner face, and delete that face. A thick wall needs openings on both sides. '''Bridge boundaries''' joins compatible open rims to form the inside surfaces.

Choose '''Auto''' or '''Exact''' collision for a wall with an opening. Box and Convex collision can fill that opening even when the rendered wall looks correct.

== Materials, models, and prefabs ==

Drag a material from '''Materials''' onto a face. Hold Shift during the drop to apply it to the whole brush. These drops preserve the existing UV alignment.

In Texture mode, left-click samples a face's material and alignment; right-drag paints them. Adjust texture size and offsets in the inspector. Texture lock keeps the mapping attached while moving or resizing geometry.

Drag models from '''Models''' into a view, or use '''Place at pivot'''. Game models retain references to the SDK assets. For your own models or textures, use [[Vertex/Content|Content import]].

'''Prefabs''' contains reusable assemblies supplied by the game. They can include geometry, models, entities, and scripts. Linked instances retain local changes when refreshed. '''Unpack''' removes the source link. Save your own selections with '''File → Save selection as prefab…'''.

== Terrain ==

Select one four-sided face and press '''Alt+T''' (or choose '''Convert to terrain'''). Type the subdivision count and press Enter. The terrain replaces that brush with an open patch, so duplicate the brush first if you need to keep the solid.

Choose '''Base texture''' and '''Paint texture''' in the Terrain inspector. '''Paint textures''' reveals the second texture; Shift erases back to the base. '''Sculpt terrain''' raises, lowers, or smooths the surface. Use enough subdivisions for the shape you need, and inspect collision after sculpting.

In paint and sculpt modes, '''scroll up to enlarge the brush and down to shrink it'''. '''Shift+scroll''' adjusts strength; '''Ctrl/Cmd+scroll''' zooms the view. The brush outline and radius field update immediately. Changing brush settings does not paint or create an Undo step.

== Collision and lighting ==

The '''Collision''' section controls whether an object blocks movement, its collision shape, and its filters. Start with Auto. Use '''Create collision proxy''' when a simpler invisible shape would make movement smoother, such as a ramp over stairs. Creating a proxy disables the original collider; deleting the proxy does not restore it.

Set the sun, sky, ambient light, and fog in '''Map Environment'''. Game SDKs decide which lighting and spatial bakes are required. Inspect the built map in the game: the Vertex viewport does not reproduce every game shader or baked lighting effect.

== Entities and logic ==

Choose an entity in the creation controls, place it, and edit its properties in the inspector. A point has a position and direction. A bounds entity defines a volume. A brush entity owns geometry placed under it in the hierarchy.

Name entities before wiring them in [[Vertex/VSig|VSig]]. Game-specific reference pages explain their behavior; Grimwar's [[Grimwar/Entities|entity index]] covers every supplied type.

== Validate and export ==

Use '''File → Validate map''' to find geometry, reference, asset, and collision problems. Validation reports problems without repairing the map.

'''Export compiled meshes…''' writes <code>.vertexmesh</code> for engine import. '''Export selection as model…''' writes OBJ or FBX geometry for other tools. Model export does not carry game entities, engine model placements, or collision. Use the game's Build controls for a playable package.

Hidden objects still export. Hide and isolate are editing aids; delete an object or change its output settings when it should not ship.

[[Category:Vertex]] [[Category:Mapping]]

Vertex/Editing

2026-10-02T19:39:22Z

DocumentationBot: Document contextual toolbar icons and labels

{{VertexNav}}

Build a small room and test its scale and collision in your game before adding detail. The active game profile sets the map's units; changing the connected profile does not rescale an existing map.

== Move around and select ==

{| class="wikitable"
! Input !! Action
|-
| <kbd>Z</kbd>, then <kbd>WASD</kbd> / <kbd>Q</kbd> / <kbd>E</kbd> || Enter free camera and move. Hold Shift to move faster; Escape exits.
|-
| <kbd>F</kbd> || Frame the selection.
|-
| <kbd>1</kbd>–<kbd>4</kbd> / Space || Choose a view / maximize the view.
|-
| <kbd>S</kbd> / <kbd>G</kbd> / <kbd>R</kbd> / <kbd>T</kbd> || Select / move / rotate / scale.
|-
| <kbd>V</kbd> / <kbd>E</kbd> / <kbd>H</kbd> || Edit vertices / edges / faces.
|-
| <kbd>B</kbd> / <kbd>Shift+A</kbd> || Draw / texture tools.
|-
| <kbd>[</kbd> / <kbd>]</kbd> || Decrease / increase the grid size.
|-
| <kbd>I</kbd> / <kbd>Shift+C</kbd> || Isolate the selection / preview collision.
|}

Shortcuts yield to text fields and free camera. Select an object before selecting its vertices, edges, or faces. Delete in a component tool removes those components; deleting in the hierarchy removes whole objects.

Switch '''Global / Local''' above the views to choose transform axes. Local follows the active object or selected face. Numeric fields accept arithmetic, so you can enter a value such as <code>128*2</code>.

== Draw geometry ==

# Choose the draw tool and a shape.
# Set the grid and depth, then drag out the footprint.
# Apply the preview with Enter or '''Apply'''. Escape cancels.
# Use Move, Rotate, and Scale to position it. Keep large structural pieces on the grid.

Drawing on an existing collider starts the new shape on that surface. Empty space uses the draw plane. Hold Shift while drawing for equal width, height, and depth. Stairs fit the drawn bounds; adjust their step count in the creation settings.

Parametric shapes retain their settings. Use '''Convert to brush''' when you need to edit individual components. That conversion gives up the original shape controls.

=== Geometry shortcuts ===

The contextual bar above the viewports shows actions for the current tool and selection: Extrude and Inset for faces, Bevel for edges, Weld for vertices, and construction actions for objects. Each action has an icon and label, with its shortcut in the tooltip, and starts the same live adjustment as the keyboard. Unavailable actions stay disabled.

Select faces, edges, or objects, press the operation's shortcut, then '''move the mouse or type a value'''. '''Enter or left-click applies; Escape or right-click cancels.''' The status bar shows the current value and controls. Each completed operation is one Undo.

Mouse adjustments snap to the grid. Hold '''Shift''' for slower adjustment and a tenth of the grid step, or '''Ctrl/Cmd''' to bypass snapping. Typed values and calculations such as <code>128/3</code> stay exact. Backspace edits the input; clearing it returns to mouse adjustment. Invalid input must be corrected or canceled before applying.

Extrude and face offset follow the selected face's normal on screen; use horizontal movement when viewing the face head-on. Other distances use horizontal movement. During bevel, the mouse wheel changes the segment count. Linear and radial copy shortcuts adjust the number of additional copies, using the configured spacing or angle.

{| class="wikitable"
! Shortcut !! Operation
|-
| Shift+E / Alt+E || Extrude individual faces / extrude a region
|-
| Shift+I / Shift+B / Shift+H || Inset faces / bevel edges / hollow walls
|-
| Alt+F || Offset faces along their normals
|-
| Ctrl/Cmd+J / Shift+S || Combine objects / subtract last selected
|-
| Shift+W / Shift+K || Weld vertices / connect vertices
|-
| Shift+X / Shift+D || Split edges / dissolve edges
|-
| Shift+F / Shift+J || Cap holes / bridge boundaries
|-
| Alt+Delete / Alt+R || Delete selected faces / repair mesh seams
|-
| Alt+T / Alt+W || Convert a face to terrain / sew terrain patches
|-
| Shift+T / Alt+Shift+T || Sculpt terrain / toggle terrain and surface
|-
| Alt+B / Alt+Shift+B || Convert to brush / split into brushes
|-
| Alt+A || Create an editable array
|-
| Alt+Shift+A / Alt+Shift+R || Make linear / radial copies
|-
| Alt+M / Alt+Shift+M || Create symmetry / unlink selection
|-
| Alt+Shift+C / Alt+Shift+W || Clip at symmetry planes / weld independent symmetry
|-
| Alt+Shift+U || Remove all symmetry links
|-
| Alt+P / Alt+X / Alt+L || Pick pivot / use face axes / align to another face
|}

Commands without a numeric adjustment apply immediately; picking, alignment, and sculpting enter their existing tools. Shortcuts appear in the Geometry menu and inspector button tooltips. They only edit the map from the Level workspace, and yield to text fields and free camera.

Press '''C''' to draw a clipping plane, then Enter to apply it. While clipping, '''Alt+C''' toggles Slice (keep both sides) and '''Alt+F''' flips the kept side, including an existing preview. Alt+Left/Right, Alt+Up/Down, and Alt+Page Up/Down flip the selection along the focused view's axes.

You can still use the inspector. '''Enter in a construction numeric field''' creates and applies the operation directly. Changing a distance during an active preview updates that preview; Enter applies and Escape cancels. Enter in an open surface's extrusion field uses region extrusion. Preview buttons remain available when you want to inspect a result first.

=== Doorways and windows ===

For a doorway through a solid wall, place a box cutter through the wall, select the wall and then the cutter, and apply '''Subtract last selected'''. The operation removes the cutter.

For a framed opening, use '''Inset faces''', apply it, scale the selected inner face, and delete that face. A thick wall needs openings on both sides. '''Bridge boundaries''' joins compatible open rims to form the inside surfaces.

Choose '''Auto''' or '''Exact''' collision for a wall with an opening. Box and Convex collision can fill that opening even when the rendered wall looks correct.

== Materials, models, and prefabs ==

Drag a material from '''Materials''' onto a face. Hold Shift during the drop to apply it to the whole brush. These drops preserve the existing UV alignment.

In Texture mode, left-click samples a face's material and alignment; right-drag paints them. Adjust texture size and offsets in the inspector. Texture lock keeps the mapping attached while moving or resizing geometry.

Drag models from '''Models''' into a view, or use '''Place at pivot'''. Game models retain references to the SDK assets. For your own models or textures, use [[Vertex/Content|Content import]].

'''Prefabs''' contains reusable assemblies supplied by the game. They can include geometry, models, entities, and scripts. Linked instances retain local changes when refreshed. '''Unpack''' removes the source link. Save your own selections with '''File → Save selection as prefab…'''.

== Terrain ==

Select one four-sided face and press '''Alt+T''' (or choose '''Convert to terrain'''). Type the subdivision count and press Enter. The terrain replaces that brush with an open patch, so duplicate the brush first if you need to keep the solid.

Choose '''Base texture''' and '''Paint texture''' in the Terrain inspector. '''Paint textures''' reveals the second texture; Shift erases back to the base. '''Sculpt terrain''' raises, lowers, or smooths the surface. Use enough subdivisions for the shape you need, and inspect collision after sculpting.

== Collision and lighting ==

The '''Collision''' section controls whether an object blocks movement, its collision shape, and its filters. Start with Auto. Use '''Create collision proxy''' when a simpler invisible shape would make movement smoother, such as a ramp over stairs. Creating a proxy disables the original collider; deleting the proxy does not restore it.

Set the sun, sky, ambient light, and fog in '''Map Environment'''. Game SDKs decide which lighting and spatial bakes are required. Inspect the built map in the game: the Vertex viewport does not reproduce every game shader or baked lighting effect.

== Entities and logic ==

Choose an entity in the creation controls, place it, and edit its properties in the inspector. A point has a position and direction. A bounds entity defines a volume. A brush entity owns geometry placed under it in the hierarchy.

Name entities before wiring them in [[Vertex/VSig|VSig]]. Game-specific reference pages explain their behavior; Grimwar's [[Grimwar/Entities|entity index]] covers every supplied type.

== Validate and export ==

Use '''File → Validate map''' to find geometry, reference, asset, and collision problems. Validation reports problems without repairing the map.

'''Export compiled meshes…''' writes <code>.vertexmesh</code> for engine import. '''Export selection as model…''' writes OBJ or FBX geometry for other tools. Model export does not carry game entities, engine model placements, or collision. Use the game's Build controls for a playable package.

Hidden objects still export. Hide and isolate are editing aids; delete an object or change its output settings when it should not ship.

[[Category:Vertex]] [[Category:Mapping]]

Vertex/Editing

2026-10-02T19:22:34Z

DocumentationBot: Document direct geometry shortcuts and clip modifiers

{{VertexNav}}

Build a small room and test its scale and collision in your game before adding detail. The active game profile sets the map's units; changing the connected profile does not rescale an existing map.

== Move around and select ==

{| class="wikitable"
! Input !! Action
|-
| <kbd>Z</kbd>, then <kbd>WASD</kbd> / <kbd>Q</kbd> / <kbd>E</kbd> || Enter free camera and move. Hold Shift to move faster; Escape exits.
|-
| <kbd>F</kbd> || Frame the selection.
|-
| <kbd>1</kbd>–<kbd>4</kbd> / Space || Choose a view / maximize the view.
|-
| <kbd>S</kbd> / <kbd>G</kbd> / <kbd>R</kbd> / <kbd>T</kbd> || Select / move / rotate / scale.
|-
| <kbd>V</kbd> / <kbd>E</kbd> / <kbd>H</kbd> || Edit vertices / edges / faces.
|-
| <kbd>B</kbd> / <kbd>Shift+A</kbd> || Draw / texture tools.
|-
| <kbd>[</kbd> / <kbd>]</kbd> || Decrease / increase the grid size.
|-
| <kbd>I</kbd> / <kbd>Shift+C</kbd> || Isolate the selection / preview collision.
|}

Shortcuts yield to text fields and free camera. Select an object before selecting its vertices, edges, or faces. Delete in a component tool removes those components; deleting in the hierarchy removes whole objects.

Switch '''Global / Local''' above the views to choose transform axes. Local follows the active object or selected face. Numeric fields accept arithmetic, so you can enter a value such as <code>128*2</code>.

== Draw geometry ==

# Choose the draw tool and a shape.
# Set the grid and depth, then drag out the footprint.
# Apply the preview with Enter or '''Apply'''. Escape cancels.
# Use Move, Rotate, and Scale to position it. Keep large structural pieces on the grid.

Drawing on an existing collider starts the new shape on that surface. Empty space uses the draw plane. Hold Shift while drawing for equal width, height, and depth. Stairs fit the drawn bounds; adjust their step count in the creation settings.

Parametric shapes retain their settings. Use '''Convert to brush''' when you need to edit individual components. That conversion gives up the original shape controls.

=== Geometry shortcuts ===

The contextual bar above the viewports shows actions for the current tool and selection: Extrude and Inset for faces, Bevel for edges, Weld for vertices, and construction actions for objects. Buttons show their shortcuts in tooltips and start the same live adjustment as the keyboard. Unavailable actions stay disabled.

Select faces, edges, or objects, press the operation's shortcut, then '''move the mouse or type a value'''. '''Enter or left-click applies; Escape or right-click cancels.''' The status bar shows the current value and controls. Each completed operation is one Undo.

Mouse adjustments snap to the grid. Hold '''Shift''' for slower adjustment and a tenth of the grid step, or '''Ctrl/Cmd''' to bypass snapping. Typed values and calculations such as <code>128/3</code> stay exact. Backspace edits the input; clearing it returns to mouse adjustment. Invalid input must be corrected or canceled before applying.

Extrude and face offset follow the selected face's normal on screen; use horizontal movement when viewing the face head-on. Other distances use horizontal movement. During bevel, the mouse wheel changes the segment count. Linear and radial copy shortcuts adjust the number of additional copies, using the configured spacing or angle.

{| class="wikitable"
! Shortcut !! Operation
|-
| Shift+E / Alt+E || Extrude individual faces / extrude a region
|-
| Shift+I / Shift+B / Shift+H || Inset faces / bevel edges / hollow walls
|-
| Alt+F || Offset faces along their normals
|-
| Ctrl/Cmd+J / Shift+S || Combine objects / subtract last selected
|-
| Shift+W / Shift+K || Weld vertices / connect vertices
|-
| Shift+X / Shift+D || Split edges / dissolve edges
|-
| Shift+F / Shift+J || Cap holes / bridge boundaries
|-
| Alt+Delete / Alt+R || Delete selected faces / repair mesh seams
|-
| Alt+T / Alt+W || Convert a face to terrain / sew terrain patches
|-
| Shift+T / Alt+Shift+T || Sculpt terrain / toggle terrain and surface
|-
| Alt+B / Alt+Shift+B || Convert to brush / split into brushes
|-
| Alt+A || Create an editable array
|-
| Alt+Shift+A / Alt+Shift+R || Make linear / radial copies
|-
| Alt+M / Alt+Shift+M || Create symmetry / unlink selection
|-
| Alt+Shift+C / Alt+Shift+W || Clip at symmetry planes / weld independent symmetry
|-
| Alt+Shift+U || Remove all symmetry links
|-
| Alt+P / Alt+X / Alt+L || Pick pivot / use face axes / align to another face
|}

Commands without a numeric adjustment apply immediately; picking, alignment, and sculpting enter their existing tools. Shortcuts appear in the Geometry menu and inspector button tooltips. They only edit the map from the Level workspace, and yield to text fields and free camera.

Press '''C''' to draw a clipping plane, then Enter to apply it. While clipping, '''Alt+C''' toggles Slice (keep both sides) and '''Alt+F''' flips the kept side, including an existing preview. Alt+Left/Right, Alt+Up/Down, and Alt+Page Up/Down flip the selection along the focused view's axes.

You can still use the inspector. '''Enter in a construction numeric field''' creates and applies the operation directly. Changing a distance during an active preview updates that preview; Enter applies and Escape cancels. Enter in an open surface's extrusion field uses region extrusion. Preview buttons remain available when you want to inspect a result first.

=== Doorways and windows ===

For a doorway through a solid wall, place a box cutter through the wall, select the wall and then the cutter, and apply '''Subtract last selected'''. The operation removes the cutter.

For a framed opening, use '''Inset faces''', apply it, scale the selected inner face, and delete that face. A thick wall needs openings on both sides. '''Bridge boundaries''' joins compatible open rims to form the inside surfaces.

Choose '''Auto''' or '''Exact''' collision for a wall with an opening. Box and Convex collision can fill that opening even when the rendered wall looks correct.

== Materials, models, and prefabs ==

Drag a material from '''Materials''' onto a face. Hold Shift during the drop to apply it to the whole brush. These drops preserve the existing UV alignment.

In Texture mode, left-click samples a face's material and alignment; right-drag paints them. Adjust texture size and offsets in the inspector. Texture lock keeps the mapping attached while moving or resizing geometry.

Drag models from '''Models''' into a view, or use '''Place at pivot'''. Game models retain references to the SDK assets. For your own models or textures, use [[Vertex/Content|Content import]].

'''Prefabs''' contains reusable assemblies supplied by the game. They can include geometry, models, entities, and scripts. Linked instances retain local changes when refreshed. '''Unpack''' removes the source link. Save your own selections with '''File → Save selection as prefab…'''.

== Terrain ==

Select one four-sided face and press '''Alt+T''' (or choose '''Convert to terrain'''). Type the subdivision count and press Enter. The terrain replaces that brush with an open patch, so duplicate the brush first if you need to keep the solid.

Choose '''Base texture''' and '''Paint texture''' in the Terrain inspector. '''Paint textures''' reveals the second texture; Shift erases back to the base. '''Sculpt terrain''' raises, lowers, or smooths the surface. Use enough subdivisions for the shape you need, and inspect collision after sculpting.

== Collision and lighting ==

The '''Collision''' section controls whether an object blocks movement, its collision shape, and its filters. Start with Auto. Use '''Create collision proxy''' when a simpler invisible shape would make movement smoother, such as a ramp over stairs. Creating a proxy disables the original collider; deleting the proxy does not restore it.

Set the sun, sky, ambient light, and fog in '''Map Environment'''. Game SDKs decide which lighting and spatial bakes are required. Inspect the built map in the game: the Vertex viewport does not reproduce every game shader or baked lighting effect.

== Entities and logic ==

Choose an entity in the creation controls, place it, and edit its properties in the inspector. A point has a position and direction. A bounds entity defines a volume. A brush entity owns geometry placed under it in the hierarchy.

Name entities before wiring them in [[Vertex/VSig|VSig]]. Game-specific reference pages explain their behavior; Grimwar's [[Grimwar/Entities|entity index]] covers every supplied type.

== Validate and export ==

Use '''File → Validate map''' to find geometry, reference, asset, and collision problems. Validation reports problems without repairing the map.

'''Export compiled meshes…''' writes <code>.vertexmesh</code> for engine import. '''Export selection as model…''' writes OBJ or FBX geometry for other tools. Model export does not carry game entities, engine model placements, or collision. Use the game's Build controls for a playable package.

Hidden objects still export. Hide and isolate are editing aids; delete an object or change its output settings when it should not ship.

[[Category:Vertex]] [[Category:Mapping]]

Vertex/Editing

2026-10-02T19:00:43Z

DocumentationBot: Document direct geometry shortcuts and clip modifiers

{{VertexNav}}

Build a small room and test its scale and collision in your game before adding detail. The active game profile sets the map's units; changing the connected profile does not rescale an existing map.

== Move around and select ==

{| class="wikitable"
! Input !! Action
|-
| <kbd>Z</kbd>, then <kbd>WASD</kbd> / <kbd>Q</kbd> / <kbd>E</kbd> || Enter free camera and move. Hold Shift to move faster; Escape exits.
|-
| <kbd>F</kbd> || Frame the selection.
|-
| <kbd>1</kbd>–<kbd>4</kbd> / Space || Choose a view / maximize the view.
|-
| <kbd>S</kbd> / <kbd>G</kbd> / <kbd>R</kbd> / <kbd>T</kbd> || Select / move / rotate / scale.
|-
| <kbd>V</kbd> / <kbd>E</kbd> / <kbd>H</kbd> || Edit vertices / edges / faces.
|-
| <kbd>B</kbd> / <kbd>Shift+A</kbd> || Draw / texture tools.
|-
| <kbd>[</kbd> / <kbd>]</kbd> || Decrease / increase the grid size.
|-
| <kbd>I</kbd> / <kbd>Shift+C</kbd> || Isolate the selection / preview collision.
|}

Shortcuts yield to text fields and free camera. Select an object before selecting its vertices, edges, or faces. Delete in a component tool removes those components; deleting in the hierarchy removes whole objects.

Switch '''Global / Local''' above the views to choose transform axes. Local follows the active object or selected face. Numeric fields accept arithmetic, so you can enter a value such as <code>128*2</code>.

== Draw geometry ==

# Choose the draw tool and a shape.
# Set the grid and depth, then drag out the footprint.
# Apply the preview with Enter or '''Apply'''. Escape cancels.
# Use Move, Rotate, and Scale to position it. Keep large structural pieces on the grid.

Drawing on an existing collider starts the new shape on that surface. Empty space uses the draw plane. Hold Shift while drawing for equal width, height, and depth. Stairs fit the drawn bounds; adjust their step count in the creation settings.

Parametric shapes retain their settings. Use '''Convert to brush''' when you need to edit individual components. That conversion gives up the original shape controls.

=== Geometry shortcuts ===

Select faces, edges, or objects, press the operation's shortcut, then '''move the mouse or type a value'''. '''Enter or left-click applies; Escape or right-click cancels.''' The status bar shows the current value and controls. Each completed operation is one Undo.

Mouse adjustments snap to the grid. Hold '''Shift''' for slower adjustment and a tenth of the grid step, or '''Ctrl/Cmd''' to bypass snapping. Typed values and calculations such as <code>128/3</code> stay exact. Backspace edits the input; clearing it returns to mouse adjustment. Invalid input must be corrected or canceled before applying.

Extrude and face offset follow the selected face's normal on screen; use horizontal movement when viewing the face head-on. Other distances use horizontal movement. During bevel, the mouse wheel changes the segment count. Linear and radial copy shortcuts adjust the number of additional copies, using the configured spacing or angle.

{| class="wikitable"
! Shortcut !! Operation
|-
| Shift+E / Alt+E || Extrude individual faces / extrude a region
|-
| Shift+I / Shift+B / Shift+H || Inset faces / bevel edges / hollow walls
|-
| Alt+F || Offset faces along their normals
|-
| Ctrl/Cmd+J / Shift+S || Combine objects / subtract last selected
|-
| Shift+W / Shift+K || Weld vertices / connect vertices
|-
| Shift+X / Shift+D || Split edges / dissolve edges
|-
| Shift+F / Shift+J || Cap holes / bridge boundaries
|-
| Alt+Delete / Alt+R || Delete selected faces / repair mesh seams
|-
| Alt+T / Alt+W || Convert a face to terrain / sew terrain patches
|-
| Shift+T / Alt+Shift+T || Sculpt terrain / toggle terrain and surface
|-
| Alt+B / Alt+Shift+B || Convert to brush / split into brushes
|-
| Alt+A || Create an editable array
|-
| Alt+Shift+A / Alt+Shift+R || Make linear / radial copies
|-
| Alt+M / Alt+Shift+M || Create symmetry / unlink selection
|-
| Alt+Shift+C / Alt+Shift+W || Clip at symmetry planes / weld independent symmetry
|-
| Alt+Shift+U || Remove all symmetry links
|-
| Alt+P / Alt+X / Alt+L || Pick pivot / use face axes / align to another face
|}

Commands without a numeric adjustment apply immediately; picking, alignment, and sculpting enter their existing tools. Shortcuts appear in the Geometry menu and inspector button tooltips. They only edit the map from the Level workspace, and yield to text fields and free camera.

Press '''C''' to draw a clipping plane, then Enter to apply it. While clipping, '''Alt+C''' toggles Slice (keep both sides) and '''Alt+F''' flips the kept side, including an existing preview. Alt+Left/Right, Alt+Up/Down, and Alt+Page Up/Down flip the selection along the focused view's axes.

You can still use the inspector. '''Enter in a construction numeric field''' creates and applies the operation directly. Changing a distance during an active preview updates that preview; Enter applies and Escape cancels. Enter in an open surface's extrusion field uses region extrusion. Preview buttons remain available when you want to inspect a result first.

=== Doorways and windows ===

For a doorway through a solid wall, place a box cutter through the wall, select the wall and then the cutter, and apply '''Subtract last selected'''. The operation removes the cutter.

For a framed opening, use '''Inset faces''', apply it, scale the selected inner face, and delete that face. A thick wall needs openings on both sides. '''Bridge boundaries''' joins compatible open rims to form the inside surfaces.

Choose '''Auto''' or '''Exact''' collision for a wall with an opening. Box and Convex collision can fill that opening even when the rendered wall looks correct.

== Materials, models, and prefabs ==

Drag a material from '''Materials''' onto a face. Hold Shift during the drop to apply it to the whole brush. These drops preserve the existing UV alignment.

In Texture mode, left-click samples a face's material and alignment; right-drag paints them. Adjust texture size and offsets in the inspector. Texture lock keeps the mapping attached while moving or resizing geometry.

Drag models from '''Models''' into a view, or use '''Place at pivot'''. Game models retain references to the SDK assets. For your own models or textures, use [[Vertex/Content|Content import]].

'''Prefabs''' contains reusable assemblies supplied by the game. They can include geometry, models, entities, and scripts. Linked instances retain local changes when refreshed. '''Unpack''' removes the source link. Save your own selections with '''File → Save selection as prefab…'''.

== Terrain ==

Select one four-sided face and press '''Alt+T''' (or choose '''Convert to terrain'''). Type the subdivision count and press Enter. The terrain replaces that brush with an open patch, so duplicate the brush first if you need to keep the solid.

Choose '''Base texture''' and '''Paint texture''' in the Terrain inspector. '''Paint textures''' reveals the second texture; Shift erases back to the base. '''Sculpt terrain''' raises, lowers, or smooths the surface. Use enough subdivisions for the shape you need, and inspect collision after sculpting.

== Collision and lighting ==

The '''Collision''' section controls whether an object blocks movement, its collision shape, and its filters. Start with Auto. Use '''Create collision proxy''' when a simpler invisible shape would make movement smoother, such as a ramp over stairs. Creating a proxy disables the original collider; deleting the proxy does not restore it.

Set the sun, sky, ambient light, and fog in '''Map Environment'''. Game SDKs decide which lighting and spatial bakes are required. Inspect the built map in the game: the Vertex viewport does not reproduce every game shader or baked lighting effect.

== Entities and logic ==

Choose an entity in the creation controls, place it, and edit its properties in the inspector. A point has a position and direction. A bounds entity defines a volume. A brush entity owns geometry placed under it in the hierarchy.

Name entities before wiring them in [[Vertex/VSig|VSig]]. Game-specific reference pages explain their behavior; Grimwar's [[Grimwar/Entities|entity index]] covers every supplied type.

== Validate and export ==

Use '''File → Validate map''' to find geometry, reference, asset, and collision problems. Validation reports problems without repairing the map.

'''Export compiled meshes…''' writes <code>.vertexmesh</code> for engine import. '''Export selection as model…''' writes OBJ or FBX geometry for other tools. Model export does not carry game entities, engine model placements, or collision. Use the game's Build controls for a playable package.

Hidden objects still export. Hide and isolate are editing aids; delete an object or change its output settings when it should not ship.

[[Category:Vertex]] [[Category:Mapping]]

Grimwar/Mapping

2026-10-02T18:10:17Z

DocumentationBot: Document optional map settings and default music

{{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 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.

== 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 ==

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]]

Grimwar/VSig reference

2026-10-01T04:13:05Z

DocumentationBot: Version 1

{{GameNav}}

This is the detailed VSig reference for Grimwar. Start with [[Grimwar/VSig|the door tutorial]] or [[Vertex/VSig|the language basics]]. Examples below show individual language features; keep the required refs and modules in your map when combining them.

== Refs and groups ==

A ref can match one hierarchy path or a wildcard:

<syntaxhighlight lang="text">
ref main_door: func_door match BuildingA/Door
ref spawn_doors: func_door match SpawnDoors/Door*

group exits:
main_door
spawn_doors

on round.post_round:
exits.close
</syntaxhighlight>

An input sent to a wildcard ref or group broadcasts to every match. Property reads and state capture require exactly one entity.

Stable entity names make refs readable and keep wildcard matches predictable. VSig refs use the object hierarchy and entity class.

== Entity lifecycle and operational state ==

Every concrete map entity exposes the same terminal lifecycle:

{| class="wikitable"
! Member !! Kind !! Meaning
|-
| <code>kill</code> || Input || Permanently remove this entity instance for the current map load.
|-
| <code>killed</code> || Output || Fire once immediately before the runtime is removed.
|}

<code>kill</code> is distinct from domain actions such as a damageable entity's <code>break</code>. A broken entity can be healed or reset; a killed entity returns only when the scene or map is loaded again. The server synchronizes terminal state to current clients and late joiners and records it in demo entity state. Client-local presentation entities use their owning client runtime.

The SDK calls this operation <code>kill</code>, not <code>destroy</code>. It does not expose hierarchy destruction because a Unity Transform hierarchy is an authoring relationship, not an entity-ownership boundary.

Entities that declare the '''Operational''' capability also expose:

{| class="wikitable"
! Member !! Kind !! Meaning
|-
| <code>enable</code> || Input || Make the entity operational.
|-
| <code>disable</code> || Input || Make the entity non-operational.
|-
| <code>toggle</code> || Input || Switch operational state.
|-
| <code>enabled</code> || Output || Fire on an actual disabled-to-enabled transition.
|-
| <code>disabled</code> || Output || Fire on an actual enabled-to-disabled transition.
|-
| <code>is_enabled</code> || Property || Read the current operational state.
|-
|}

Repeated <code>enable</code> or <code>disable</code> calls succeed without emitting duplicate transition outputs. Operational state never calls <code>GameObject.SetActive</code> and never changes Unity's component <code>enabled</code> property. The entity remains registered and applies its own behavior. For example, a disabled <code>func_damageable</code> ignores gameplay damage but still accepts <code>heal</code>, <code>reset</code>, <code>break</code>, operational inputs, and <code>kill</code>.

Keep more precise verbs when they carry different meaning. Doors remain <code>open</code>/<code>close</code>, damageables remain <code>break</code>/<code>reset</code>, and continuous movers remain <code>start</code>/<code>stop</code>.

== Activator, caller, and self ==

Every entity signal carries immutable execution context:

{| class="wikitable"
! Name !! Meaning
|-
| <code>activator</code> || Gameplay object that began the chain, such as the participant touching a trigger.
|-
| <code>caller</code> || Map entity that invoked the current entity.
|-
| <code>self</code> || Entity whose output handler or input is currently executing.
|}

Use the procedural targets <code>!activator</code>, <code>!caller</code>, and <code>!self</code>:

<syntaxhighlight lang="text">
ref entry_trigger: trigger_multiple match entry_trigger
ref first_gate: func_door match first_gate

on entry_trigger.start_touch:
first_gate.open

on first_gate.open:
!caller.disable
!self.kill
</syntaxhighlight>

If a player activates entity A and A invokes B, B receives the original player as <code>activator</code>, A as <code>caller</code>, and B as <code>self</code>. Each later entity invocation advances <code>caller</code> and <code>self</code> while preserving the original activator. Procedures, waits, scheduled blocks, and delayed entity outputs preserve their originating context. Autonomous and global signals have no activator or caller.

Targets resolve separately for every execution; there is no global last activator. A missing target produces a bounded warning and does nothing. Player and gameplay-object activators remain opaque provenance handles, so <code>!activator.kill</code> cannot kill a player or arbitrary GameObject. Clients cannot forge handles or invoke server-owned entities through this path.

== Values and expressions ==

Primitive types are <code>bool</code>, <code>int</code>, <code>float</code>, and <code>string</code>. Entity state uses the state type declared by its marker contract. Durations accept seconds or milliseconds, including <code>1.5s</code> and <code>250ms</code>.

<syntaxhighlight lang="text">
seed 1847

const max_score: int = 10
var score: int = 0
var title: string = "Arena"

on button.pressed:
score = clamp(score + 1, 0, max_score)
label.set_text("{0}: {1}/{2}", title, score, max_score)
</syntaxhighlight>

Strings must be quoted. Declare and initialize map variables and module state before use. Handler parameters and procedure parameters are immutable; assign mutable data to a map <code>var</code> or module <code>state</code>.

=== Operators ===

{| class="wikitable"
! Precedence, high to low !! Operators !! Notes
|-
| Grouping || <code>(expression)</code> || Parentheses override normal precedence.
|-
| Unary || <code>-value</code>, <code>not value</code>, <code>!value</code> || Numeric negation and logical negation.
|-
| Multiplicative || <code>*</code>, <code>/</code>, <code>%</code> || Division or remainder by zero produces an invalid expression value.
|-
| Additive || <code>+</code>, <code>-</code> || <code>+</code> concatenates when either operand is a string; otherwise both operands must be numeric.
|-
| Comparison || <code>==</code>, <code>!=</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code> || Ordering requires numbers. Non-numeric equality compares invariant text without case sensitivity.
|-
| Logical AND || <code>and</code>, <code>&&</code> || Both operands are evaluated.
|-
| Logical OR || <code>or</code>, <code>||</code> || Both operands are evaluated.
|}

Falsey values are <code>false</code>, numeric zero, an empty string, <code>null</code>, and a missing value. Nonzero numbers, nonempty strings, and entity-state values are truthy.

=== Built-in functions ===

These 20 expression functions are available:

{| class="wikitable"
! Function !! Result and constraints
|-
| <code>abs(value)</code> || Absolute numeric value.
|-
| <code>bool(value)</code> || Truthiness conversion using the rules above. A nonempty string, including <code>"false"</code>, is truthy.
|-
| <code>ceil(value)</code> || Smallest integer greater than or equal to the numeric value.
|-
| <code>choose(condition, when_true, when_false)</code> || Returns the second or third value according to the condition's truthiness.
|-
| <code>clamp(value, minimum, maximum)</code> || Numeric value constrained to the supplied bounds.
|-
| <code>convar(name)</code> || Reads one content-accessible console variable. Use a quoted name such as <code>convar("sv_gravity")</code>. The server allowlist and <code>sv_allow_content_commands</code> policy apply.
|-
| <code>float(value)</code> || Converts an integer, float, or invariant numeric string to a float.
|-
| <code>floor(value)</code> || Greatest integer less than or equal to the numeric value.
|-
| <code>format(pattern [, value1 [, value2]])</code> || Invariant composite formatting. Example: <code>format("{0}: {1:0.0}", name, score)</code>.
|-
| <code>int(value)</code> || Converts an integer, float, or invariant integer string to an integer. Float conversion truncates toward zero.
|-
| <code>lerp(a, b, t)</code> || Unclamped linear interpolation from <code>a</code> to <code>b</code>. Values of <code>t</code> outside <code>0..1</code> extrapolate.
|-
| <code>max(value1 [, value2])</code> || Maximum of one or more numeric arguments.
|-
| <code>min(value1 [, value2])</code> || Minimum of one or more numeric arguments.
|-
| <code>random()</code> || Random float from zero, inclusive, to one, exclusive.
|-
| <code>random(maximum)</code> || Random float between zero and <code>maximum</code>; reversed bounds are normalized.
|-
| <code>random(minimum, maximum)</code> || Random float between the two bounds; reversed bounds are normalized.
|-
| <code>random_int(maximum)</code> || Random integer from zero, inclusive, to <code>maximum</code>, exclusive. Maximum must be greater than zero.
|-
| <code>random_int(minimum, maximum)</code> || Random integer from <code>minimum</code>, inclusive, to <code>maximum</code>, exclusive. Maximum must be greater than minimum.
|-
| <code>remap(value, input_min, input_max, output_min, output_max)</code> || Unclamped mapping between numeric ranges. Equal input bounds are invalid.
|-
| <code>round(value)</code> || Rounds a numeric value to the nearest integer using the runtime's midpoint rule.
|-
| <code>shuffle(key, count)</code> || Returns every integer in <code>0..count-1</code> once in random order, then refills and reshuffles that key's bag. Count must be positive.
|-
| <code>string(value)</code> || Converts a value to invariant text.
|-
| <code>time()</code> || Current scaled game time in seconds.
|}

The table has 20 function names; overload rows show the accepted forms of <code>random</code> and <code>random_int</code>. A wrong argument count or incompatible value reports a runtime diagnostic and produces no usable value.

Without <code>seed</code>, each map runtime starts with fresh random entropy. A declared seed makes <code>random</code>, <code>random_int</code>, and shuffle refills repeatable for the same execution order. Use a stable string key for a shared shuffle bag. Inside a module, <code>shuffle(self, count)</code> gives each expanded module instance its own bag.

=== Statement reference ===

{| class="wikitable"
! Form !! Purpose
|-
| <code>target.input</code> or <code>target.input(arguments)</code> || Invoke an entity, group, or module input.
|-
| <code>call procedure(arguments)</code> || Run a top-level procedure and wait for it to return.
|-
| <code>local_input(arguments)</code> || Invoke an input or procedure inside the current module instance.
|-
| <code>name = expression</code> || Assign a map <code>var</code> or module <code>state</code>. Constants and parameters are immutable.
|-
| <code>if</code> / <code>elif</code> / <code>else</code> || Run one conditional branch.
|-
| <code>match</code> / <code>case</code> / <code>default</code> || Run the first equal case or the default branch.
|-
| <code>wait duration</code> || Suspend only the current handler, procedure, or scheduled block.
|-
| <code>schedule name after duration:</code> || Start or replace one named delayed task.
|-
| <code>schedule name every duration [times count]:</code> || Start or replace one named repeating task.
|-
| <code>cancel name</code> || Stop a named task if it exists.
|-
| <code>emit output(arguments)</code> || Emit a declared module output.
|-
| <code>server_command(expression)</code> || Run one allowlisted command from server authority.
|}

== Conditions and matching ==

<syntaxhighlight lang="text">
on counter.changed(value: float):
if value >= 10:
door.open
elif value > 0:
light.on
else:
light.off

match int(value):
case 1:
label.set_text("one")
case 2:
label.set_text("two")
default:
label.set_text("many")
</syntaxhighlight>

Indentation defines the statement block. A type mismatch, unknown name, invalid call, missing ref, or wrong handler payload is a compile error.

== Choose server or client authority ==

Handlers run on the server unless they begin with <code>client</code>. Use server handlers for rules, collision, objectives, and state changes. Use client handlers only for presentation entities whose contract allows client access.

<syntaxhighlight lang="text">
ref trigger: trigger_multiple match Trigger
ref door: func_door match Door
ref local_audio: env_ambient match LocalAudio

server on trigger.start_touch:
door.open

client on door.open:
local_audio.play
</syntaxhighlight>

Calls made by a handler keep that handler's authority. The compiler checks every entity input and output against its access rules. <code>server_command()</code> works only from server authority.

== Procedures, waits, and schedules ==

<syntaxhighlight lang="text">
def announce(message: string, delay: float = 0s):
wait delay
label.set_text(message)

on round.live:
call announce("Fight!", 0.25s)
schedule heartbeat every 1s times 10:
light.toggle

on round.post_round:
cancel heartbeat
</syntaxhighlight>

=== Procedures and wait ===

A procedure declaration uses <code>def</code>, typed parameters, and optional defaults. <code>call</code> runs it inline: the caller resumes only after the procedure and all of its waits complete. Direct or indirect recursive calls are rejected at runtime.

<code>wait duration</code> evaluates a non-negative duration once and suspends only the current execution chain. Other handlers and named schedules continue. A zero duration resumes on the next frame. A wait has no task name and cannot be cancelled independently; put the work in a named schedule when it needs a cancellation handle.

=== Schedule syntax ===

One-shot form:

<syntaxhighlight lang="text">
schedule open_warning after 750ms:
warning_light.on
call announce("Door opening")
</syntaxhighlight>

Repeating forms:

<syntaxhighlight lang="text">
schedule heartbeat every 1s:
light.toggle

schedule countdown every 1s times 10:
counter.subtract(1)
</syntaxhighlight>

The schedule name must be an identifier. The interval and optional count are expressions, so they can read constants, variables, module state, parameters, and built-in functions. <code>after</code> cannot use <code>times</code>.

{| class="wikitable"
! Rule !! Runtime behavior
|-
| First execution || Both <code>after</code> and <code>every</code> wait for the interval before running the block. Neither form runs immediately.
|-
| Duration || Negative or non-numeric durations stop the task with a diagnostic. Zero waits until the next frame.
|-
| Repeat count || A positive integer runs exactly that many times. Zero schedules nothing. A negative integer repeats until cancellation or map unload. Omitting <code>times</code> from <code>every</code> is the same as an unlimited negative count.
|-
| Dynamic interval || An <code>every</code> interval is re-evaluated before each iteration. <code>every random(0.5s, 1.5s)</code> therefore chooses a new delay each time.
|-
| Deadline timing || Repeating schedules anchor each short wait to the previous scaled-time deadline, so ordinary frame overshoot does not accumulate into timer drift.
|-
| Long overruns || If a block, nested procedure, or wait runs past its next deadline, the scheduler coalesces the missed time and waits one fresh interval. It does not burst missed executions in one frame.
|-
| Replacement || Starting a schedule automatically cancels the task with the same name before registering the new one.
|-
| Cancellation || <code>cancel name</code> stops the delay or running block. Cancelling a missing task is safe.
|-
| Locals and context || The task copies the handler or procedure's parameter values and preserves authority plus <code>!activator</code>, <code>!caller</code>, and <code>!self</code>. Map variables and module state remain live shared state.
|-
| Module scope || Schedule names declared inside a module are private to each expanded module instance. Two instances can both run <code>timer_loop</code> without replacing each other.
|-
| Lifetime || All tasks stop when the map VSig runtime unloads.
|}

This replacement behavior makes debounce straightforward:

<syntaxhighlight lang="text">
on trigger.trigger:
schedule close_after_quiet after 2s:
door.close
</syntaxhighlight>

Every new trigger restarts the two-second delay because it replaces <code>close_after_quiet</code>.

=== Milestone timelines ===

Use parallel one-shot schedules when a stage has actions at specific times. Each deadline is measured from the event that starts the stage; it does not depend on a repeating timer's frame-measured elapsed value.

<syntaxhighlight lang="text">
ref zombie_teleport: trigger_teleport match ZombieTeleport
ref spawn_door: func_door match SpawnDoor
ref zombie_door: func_door match ZombieDoor

on round.pre_round:
schedule island_intro after 1s:
server_command("gm_message major Defend this island for 90 seconds")

schedule island_warning after 80s:
server_command("gm_message major 10 seconds until the gates open")

schedule island_open after 90s:
server_command("gm_message major The gates are open. GOGOGO")
zombie_teleport.enable
spawn_door.open

schedule island_release after 115s:
zombie_teleport.disable
zombie_door.open
</syntaxhighlight>

Running this handler again replaces all four named tasks and restarts the timeline. Give unrelated timelines distinct task names. Use an explicit guard such as a relay or latch when a repeatable entity output must not restart a stage.

Cancel round-owned repeating work on <code>round.post_round</code> or another lifecycle event that always closes the activity:

<syntaxhighlight lang="text">
on round.post_round:
cancel heartbeat
cancel countdown
</syntaxhighlight>

== Reusable modules ==

A module contains parameters, private state, inputs, outputs, procedures, and handlers:

<syntaxhighlight lang="text">
module capture_counter(start: float = 0, max_value: float = 10):
state value: float = start
output changed(value: float)
output reached(value: float)

input add(amount: float = 1):
value = min(value + amount, max_value)
emit changed(value)
if value >= max_value:
emit reached(value)

input reset:
value = start
emit changed(value)

use capture_counter as captures(max_value = 3)

ref capture_point: game_capture_point
ref exit: func_door

on capture_point.captured:
captures.add

on captures.reached(value: float):
exit.open
</syntaxhighlight>

Module parameters are immutable configuration. State is private mutable data; read it as <code>instance.state_name</code>. Inputs are typed procedures. Outputs carry typed payloads and work like entity outputs.

Put shared modules in <code>.vsiglib</code> files and import only the required module.

=== Standard logic library ===

The twelve standard logic modules are built into VSig. No library file, copy, or import is required. They work in both Vertex maps and existing Unity-authored maps. <code>use</code> creates an instance with its own state:

<syntaxhighlight lang="text">
use counter as captures(max_value = 5)
</syntaxhighlight>

Give every instance a unique alias; using the same alias twice is an error. Explicitly declared or imported custom modules take precedence over built-ins with the same name. Game-specific modules such as <code>spawn_door_set</code> still need their own library import.

Existing imports remain compatible, including <code>Logic.vsiglib</code>, <code>Packages/com.vellocet.sdk/Runtime/VSig/Libraries/Logic.vsiglib</code>, and <code>Packages/com.vellocet.vertex/Runtime/VSig/Libraries/Logic.vsiglib</code>. You can remove those imports when using the standard modules. An explicitly supplied custom library at one of those paths keeps its own definitions.

These modules are compiled logic. They do not create GameObjects or network objects. Recompile a map after changing its script so its embedded program is updated.

{| class="wikitable"
! Module !! Use
|-
| <code>counter</code> || Add, subtract, set, clamp, and report a numeric value.
|-
| <code>accumulator</code> || Maintain an unclamped numeric total.
|-
| <code>relay</code> || Gate, delay, or limit a string signal to one trigger.
|-
| <code>timer</code> || Emit indexed ticks at fixed or randomized intervals.
|-
| <code>selector</code> || Route a string to one of eight configured cases.
|-
| <code>random_selector</code> || Pick a zero-based random or shuffled index.
|-
| <code>sequence</code> || Walk an integer range once or in a loop.
|-
| <code>latch</code> || Model idempotent set and clear transitions.
|-
| <code>toggle</code> || Store, flip, or directly set a boolean value.
|-
| <code>state_machine</code> || Track named state transitions and their previous value.
|-
| <code>debounce</code> || Emit only after a quiet delay following the latest trigger.
|-
| <code>cooldown</code> || Accept one trigger, then reject triggers until ready again.
|}

==== <code>counter</code> ====

<code>counter(start: float = 0, min_value: float = 0, max_value: float = 1, step: float = 1, clamp_value: bool = true)</code>

The exported <code>value</code> state starts at <code>start</code>. Each input that applies a value emits <code>changed(value)</code>. It then emits <code>min_reached(value)</code> when the result is at or below <code>min_value</code> and <code>max_reached(value)</code> when it is at or above <code>max_value</code>. When <code>clamp_value</code> is true, applied values are clamped to the configured range.

{| class="wikitable"
! Input !! Behavior
|-
| <code>add(amount: float = step)</code> || Add <code>amount</code> to the current value.
|-
| <code>subtract(amount: float = step)</code> || Subtract <code>amount</code> from the current value.
|-
| <code>set(next_value: float)</code> || Replace the current value.
|-
| <code>reset</code> || Apply the configured <code>start</code> value.
|}

==== <code>accumulator</code> ====

<code>accumulator(start: float = 0)</code> exports its current <code>value</code>. <code>add(amount: float)</code>, <code>set(next_value: float)</code>, and <code>reset</code> update that value and emit <code>changed(value: float)</code>. It does not clamp or emit threshold signals; use <code>counter</code> when a range matters.

==== <code>relay</code> ====

<code>relay(enabled_on_load: bool = true, trigger_once: bool = false, delay: float = 0)</code> exports <code>enabled</code> and <code>fired</code> state. An accepted <code>trigger(value: string = "")</code> emits <code>triggered(value: string)</code> immediately or after <code>delay</code>. A new delayed trigger replaces the instance's pending delayed emission.

{| class="wikitable"
! Input !! Behavior
|-
| <code>trigger(value: string = "")</code> || Emit only while enabled and, when <code>trigger_once</code> is true, only before the instance has fired.
|-
| <code>enable</code> || Accept later triggers.
|-
| <code>disable</code> || Reject later triggers and cancel a pending delayed emission.
|-
| <code>reset</code> || Clear <code>fired</code> and cancel a pending delayed emission without changing <code>enabled</code>.
|}

==== <code>timer</code> ====

<code>timer(interval: float = 1s, times: int = -1, lower_bound: float = interval, upper_bound: float = interval, start_on_load: bool = false)</code>

Use <code>timer.tick</code> for recurring gameplay milestones. Its one-based integer <code>index</code> advances exactly once for every delivered tick. The <code>elapsed</code> value remains available for display, progress, and diagnostics, but it is measured scaled frame time and is not guaranteed to equal a whole number.

<syntaxhighlight lang="text">
ref gate: func_door match Gate

use timer as gate_timer(interval = 1s, times = 90, start_on_load = false)

on round.live:
gate_timer.restart

on gate_timer.tick(index: int, elapsed: float, remaining: int):
if index == 80:
server_command("gm_message major 10 seconds until the gates open")
if index == 90:
gate.open

on round.post_round:
gate_timer.reset
</syntaxhighlight>

Do not compare <code>elapsed</code> with exact equality, such as <code>elapsed == 90</code>, because a frame may deliver the tick at <code>90.016</code>. The compiler reports <code>VSIG_TIMER_ELAPSED_EQUALITY</code> when a timer elapsed parameter is used with <code>==</code>, <code>!=</code>, or as the direct value of a <code>match</code> block.

{| class="wikitable"
! Input !! Behavior
|-
| <code>start</code> || Start a reset timer or resume a stopped timer from its preserved elapsed time, index, and remaining count. Calling it while running is safe and does nothing.
|-
| <code>stop</code> || Cancel the active wait while preserving elapsed time, index, and remaining count.
|-
| <code>restart</code> || Cancel, reset to index zero, and start from the beginning.
|-
| <code>reset</code> || Cancel and restore elapsed time and index to zero without starting.
|-
| <code>fire</code> || Emit <code>tick</code> immediately and advance the index without consuming a scheduled repeat.
|-
| <code>toggle</code> || Stop a running timer or start/resume a stopped timer.
|-
| <code>set_interval(value: float)</code> || Set one fixed non-negative interval for later waits.
|-
| <code>set_random_bounds(lower: float, upper: float)</code> || Set normalized non-negative bounds; each wait samples a fresh interval.
|-
| <code>set_times(value: int)</code> || Set the repeat count used by the next reset. When the timer is stopped, also replace its current remaining count. A negative count repeats until stopped or unloaded.
|}

A finite timer emits <code>finished()</code> after its last scheduled <code>tick(index: int, elapsed: float, remaining: int)</code>. Call <code>restart</code>, not <code>start</code>, to run a completed timer again. The exported <code>running</code>, <code>remaining</code>, <code>tick_index</code>, and <code>elapsed</code> states report status. <code>started_at</code>, <code>current_interval</code>, <code>current_lower_bound</code>, <code>current_upper_bound</code>, and <code>repeat_count</code> expose the backing schedule configuration; prefer the timer inputs when changing it.

==== <code>selector</code> ====

<code>selector(case_1: string = "", case_2: string = "", case_3: string = "", case_4: string = "", case_5: string = "", case_6: string = "", case_7: string = "", case_8: string = "")</code> compares <code>select(value: string)</code> with the configured cases in order. The first match emits <code>selected(index: int, value: string)</code> with a one-based case index. No match emits <code>defaulted(value: string)</code>. The module has no state.

==== <code>random_selector</code> ====

<code>random_selector(count: int = 2, shuffle_mode: bool = false)</code> exposes <code>pick</code> and emits <code>selected(index: int)</code> with a zero-based index from <code>0</code> through <code>count - 1</code>. The exported <code>last</code> state starts at <code>-1</code> and records the last emitted index. <code>count</code> must be positive.

With <code>shuffle_mode = false</code>, each pick is independent. With <code>shuffle_mode = true</code>, the instance emits every index once in randomized order before refilling its private shuffle bag.

==== <code>sequence</code> ====

<code>sequence(length: int = 1, start_index: int = 0, loop: bool = false)</code> exports its current <code>index</code>. While <code>index < length</code>, <code>next</code> emits <code>step(index: int)</code> and advances the index. Reaching the exclusive <code>length</code> emits <code>finished()</code>; a looping sequence then returns to <code>start_index</code>. <code>reset</code> returns to <code>start_index</code> without emitting an output.

==== <code>latch</code> ====

<code>latch(initial: bool = false)</code> exports <code>active</code> state and represents idempotent set/clear transitions.

{| class="wikitable"
! Input !! Outputs
|-
| <code>set</code> || When inactive, set active and emit <code>latched()</code> followed by <code>changed(true)</code>. When already active, emit nothing.
|-
| <code>clear</code> || When active, clear active and emit <code>released()</code> followed by <code>changed(false)</code>. When already inactive, emit nothing.
|-
| <code>reset</code> || Restore <code>initial</code> and emit <code>changed(active)</code>.
|}

==== <code>toggle</code> ====

<code>toggle(initial: bool = false)</code> exports boolean <code>value</code> state. <code>flip</code> inverts it, <code>set(value_to_set: bool)</code> replaces it, and <code>reset</code> restores <code>initial</code>. Every input emits <code>changed(value: bool)</code>, including <code>set</code> when the supplied value already matches.

==== <code>state_machine</code> ====

<code>state_machine(initial: string = "")</code> exports <code>current</code> and <code>previous</code> state. <code>set(next: string)</code> does nothing when <code>next</code> equals <code>current</code>. A real transition updates both states, then emits <code>exited(previous: string)</code>, <code>entered(current: string)</code>, and <code>changed(previous: string, current: string)</code> in that order. <code>reset</code> records the old current value as <code>previous</code>, restores <code>initial</code>, and emits only <code>changed(previous, current)</code>.

==== <code>debounce</code> ====

<code>debounce(delay: float = 0.1s)</code> exposes <code>trigger(value: string = "")</code> and <code>cancel</code>. Each trigger replaces the pending wait. If no newer trigger or cancellation arrives during <code>delay</code>, the module emits <code>fired(value: string)</code> with the latest payload. It has no exported state.

==== <code>cooldown</code> ====

<code>cooldown(duration: float = 1s, ready_on_load: bool = true)</code> exports <code>ready</code> state. While ready, <code>trigger(value: string = "")</code> clears readiness, emits <code>fired(value: string)</code>, waits for <code>duration</code>, restores readiness, and emits <code>became_ready()</code>. Triggers received while not ready do nothing. <code>reset</code> cancels the wait, sets ready, and emits <code>became_ready()</code> immediately.

=== Shipped spatial helper ===

Grimwar's Order and Union spawn-door prefabs include a <code>logic_script</code> host for <code>spawn_door_set</code>. Place one from Vertex's Prefabs browser. It binds the trigger, matching doors, and audio under that instance; you do not need a source-level import in the map script.

The helper exposes <code>restore_initial_state</code>, <code>enable</code>, and <code>disable</code>. Give the host a unique explicit alias if the map script needs to call it. Keep the assembly's expected child hierarchy when editing it.

== Spatial modules and logic_script ==

A spatial module declares local refs and binds each instance to a scene hierarchy:

<syntaxhighlight lang="text">
module gate:
ref trigger: trigger_multiple
ref door: func_door

on trigger.start_touch:
door.open

input reset:
door.close

use gate as exits match Gates/Exit_*
</syntaxhighlight>

A wildcard <code>use</code> creates one module instance per matching root and a broadcast group named by the authored alias.

Place a <code>logic_script</code> marker when a map should configure a module without a source-level <code>use</code>. Set the <code>.vsiglib</code>, module name, alias, arguments, and local-ref binding mode on the marker. The compiler expands it into the same form as a written <code>use</code>. It does not become a runtime entity.

== Map and round lifecycle ==

Lifecycle sources need no scene marker:

<syntaxhighlight lang="text">
once on map.ready:
doors.close

on round.warmup:
warmup_lights.on

on round.pre_round:
round_timer.reset

on round.live:
round_timer.start

client on round.overtime:
overtime_alarm.play

on round.post_round:
cancel heartbeat

on round.intermission:
doors.open
</syntaxhighlight>

Available lifecycle sources are <code>map.ready</code>, <code>round.warmup</code>, <code>round.pre_round</code>, <code>round.live</code>, <code>round.overtime</code>, <code>round.post_round</code>, and <code>round.intermission</code>.

Use <code>once on map.ready</code> to capture an authored entity's initial state or perform setup that must run once per map load.

== Safe server commands ==

<code>server_command()</code> sends one command through the server's content-accessible command boundary:

<syntaxhighlight lang="text">
once on map.ready:
server_command("mp_roundtime 3")
server_command("sv_gravity -6")
server_command("say Map rules loaded")

on door.open:
server_command("gm_message major DOOR HAS BEEN OPENED")
</syntaxhighlight>

The server allows a curated set of match timing, chat or HUD messages, round completion, friendly fire, movement tuning, class enforcement, and weapon-slot rules. It rejects semicolons, newlines, secret-like identifiers, and commands without the <code>ContentAccessible</code> flag. The runtime restores changed console variables when the map unloads.

Server operators can disable map commands with <code>sv_allow_content_commands 0</code>. <code>convar()</code> reads use the same allowlist.

== Snapshot a participant zone ==

<code>trigger_multiple.execute</code> captures the participants currently inside the volume and emits <code>executed</code> with an opaque snapshot token. Use it for extraction zones and other one-shot outcomes that a VMod must award to specific occupants.

Name the trigger and the entity that completes the objective, then connect them in the scene script:

<syntaxhighlight lang="text">
ref extraction_zone: trigger_multiple match ExtractionZone
ref extraction_door: func_door match ExtractionDoor

server on extraction_door.close:
extraction_zone.execute
</syntaxhighlight>

Set '''Allowed Activators''' and '''Allowed Teams''' on the trigger so the snapshot includes only the intended participants. The <code>close</code> output occurs after the door finishes closing. <code>execute</code> still emits an empty snapshot when nobody is inside, which lets the game mode resolve a failed extraction deterministically.

The subscribed VMod must call <code>context.VSig.GetParticipantSnapshot(token)</code> during the matching callback. The token expires when signal dispatch returns. See [[Grimwar/VMod reference#Send signals to VSig|Send signals to VSig]] for the callback and objective-award example.

== Signals shared with VMod ==

VMods can emit a source under <code>mod:<mod-id></code>. Handle that signal like any other output:

<syntaxhighlight lang="text">
on mod:community.hello.round_started(mode_id: string):
status_label.set_text("Mode: {0}", mode_id)

on mod:community.hello.stage.opened(index: int, gate_name: string):
gate_counter.set(index)
</syntaxhighlight>

The first handler receives output <code>round_started</code> from source <code>mod:community.hello</code>. The second receives output <code>opened</code> from child source <code>mod:community.hello.stage</code>.

A VMod can subscribe to a map entity or module output by source alias and output name. This exchange carries scalar values only. It does not expose scene objects to VMod code.

== Compile and test ==

Use the Code workspace to resolve syntax and binding errors, then build through '''Play in Game''' or '''Export add-on'''. The build validates against the entities captured for that map and embeds the compiled program. Save external source edits before starting the build.

Check wildcard matches, exercise round handlers more than once, and cancel repeating schedules at their intended lifecycle boundary. Editing loose source beside an installed package does not change the compiled map.

[[Category:Grimwar]] [[Category:VSig]]

Vertex/VSig

2026-10-01T04:13:05Z

DocumentationBot: Version 1

{{VertexNav}}

VSig connects events to actions in a map. Use it for triggers, doors, timers, and reusable map logic. The game SDK supplies the available entity classes and game events.

== Open the map script ==

Save a map with a game connection. Vertex creates and associates a companion <code><map_name>.vsig</code> when no entry script is selected. Choose '''Code → Map script''' to open it. Use '''Map → Choose map script…''' to select an existing entry file.

Keep shared <code>.vsiglib</code> files under the same source folder. '''More → New source…''' in Code creates another file there; creating it does not make it the map's entry script.

The Code workspace checks syntax and bindings using the current map and SDK. A successful build performs the final validation and embeds the compiled program. Save scripts regularly: map recovery does not recover unsaved script edits.

== Events and actions ==

A handler starts with <code>on source.event:</code>. Indented lines beneath it run when that event occurs. A <code>ref</code> binds a short alias to an authored entity by class and hierarchy path.

The game's entity reference defines valid inputs and outputs. For a complete trigger-to-door example, see [[Grimwar/VSig]]. A different game's SDK may use different class and signal names.

'''Inputs''' are actions a script calls. '''Outputs''' are events it listens to. Properties read a running entity's state. A ref can match several objects for broadcast actions, but a property read needs one unambiguous object.

== Values and reusable logic ==

Use <code>const</code> for a fixed value, <code>var</code> for map state, and <code>state</code> inside a reusable module. Primitive types are <code>bool</code>, <code>int</code>, <code>float</code>, and <code>string</code>. Quote strings and indent blocks consistently.

VSig includes twelve standard logic modules: <code>counter</code>, <code>accumulator</code>, <code>relay</code>, <code>timer</code>, <code>selector</code>, <code>random_selector</code>, <code>sequence</code>, <code>latch</code>, <code>toggle</code>, <code>state_machine</code>, <code>debounce</code>, and <code>cooldown</code>. Use them directly; no library file or import is needed. These modules also work in existing Unity-authored maps that were made without Vertex.

This complete script creates a counter instance and increments it once when the map is ready:

<syntaxhighlight lang="text">
scene "Counter example"

use counter as visits(max_value = 100)

once on map.ready:
visits.add
</syntaxhighlight>

Each instance has its own state. Give every instance a unique alias. See [[Grimwar/VSig reference#Standard logic library|the standard module reference]] for parameters, inputs, and outputs.

For custom behavior, declare a module or import one from a companion <code>.vsiglib</code> file:

<syntaxhighlight lang="text">
module visit_tracker(start: int = 0):
state value: int = start
output changed(value: int)

input add(amount: int = 1):
value = value + amount
emit changed(value)

use visit_tracker as visits
</syntaxhighlight>

Move that module declaration into <code>Counters.vsiglib</code> to share it, then import and instantiate it with:

<syntaxhighlight lang="text">
from "Counters.vsiglib" use visit_tracker
use visit_tracker as visits(start = 2)
</syntaxhighlight>

Explicitly declared or imported modules take precedence over built-in modules with the same name. Existing imports of <code>Logic.vsiglib</code>, including the old SDK and Vertex package paths, remain supported. Custom library imports still resolve within the captured source files. A game may also supply a library through an SDK asset or prefab; its documentation explains how to bind that library.

== Timing and authority ==

<code>wait 250ms</code> pauses the current execution chain. A named <code>schedule</code> runs delayed or repeating work and can be cancelled. Reusing a schedule name replaces the existing work. Cancel round-specific timers when the round ends.

Handlers use server authority by default. Prefix a handler with <code>client</code> for a presentation action whose entity contract allows client access. A client handler cannot grant itself server access.

<code>map.ready</code> is the standard startup event. Other events, allowed commands, multiplayer rules, and entity behavior belong to the game SDK. They are not available just because a script uses their names.

[[Category:Vertex]] [[Category:VSig]]

Category:Vellocet SDK

2026-10-01T04:13:05Z

DocumentationBot: Version 1

SDK setup now lives under Grimwar. See [[Grimwar/SDK setup|SDK setup]] or [[Grimwar|the Grimwar guides]].

Category:Grimwar entities

2026-10-01T04:13:05Z

DocumentationBot: Version 1

Settings and signal contracts for every current Grimwar entity. Browse [[Grimwar/Entities]].

[[Category:Grimwar]]

Grimwar/Entities/trigger water

2026-10-01T04:13:05Z

DocumentationBot: Version 1

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|trigger_water|section}}

Create a swimmable volume with a water surface.

Placement: Oriented volume.

== Set it up ==

Resize the volume to fill the water area; its top face is the surface. Choose an optional Surface Material or leave it empty for the game default. Test entering, swimming, leaving, and transitions into nearby ladders. The entity has no water-specific script inputs.

== Settings ==

These are the initial authoring values. Script inputs and runtime state are listed separately below.

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>surface_material</code> Surface Material || <code>None</code> || Optional material rendered across the water volume's upper face. When empty, the game uses its default water material. Reference: <code>material</code>.
|-
| <code>ignore_nav_mesh</code> Ignore Nav Mesh || <code>false</code> || Exclude this entity from navigation-mesh building. This does not disable its gameplay collision.
|}

== VSig contract ==

Use the names below with a ref bound to this entity. The value column describes the catalog value type, not a C# method signature. See [[Grimwar/Entities#Read the reference|Read the reference]] for arguments, authority, and common controls.

{| class="wikitable"
! Kind !! Member !! Value !! Authority / access
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|}

[[Category:Grimwar entities]]

Grimwar/Entities/trigger teleport

2026-10-01T04:13:05Z

DocumentationBot: Version 1

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|trigger_teleport|section}}

Move accepted occupants to a destination point.

Placement: Oriented volume.

== Set it up ==

Place an info_teleport_destination, then select it in Destination. Choose whether to rotate occupants and preserve velocity. Rotate Velocity rotates preserved movement between the trigger and destination frames. teleport affects all valid current occupants; the teleport output fires for each successful target. Test the exit for collision and accidental immediate re-entry.

== Settings ==

These are the initial authoring values. Script inputs and runtime state are listed separately below.

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>destination</code> Destination || <code>None</code> || Reference: <code>info_teleport_destination</code>.
|-
| <code>rotate_to_destination</code> Rotate To Destination || <code>true</code> || Face teleported objects and players along the destination's arrow direction.
|-
| <code>preserve_velocity</code> Preserve Velocity || <code>false</code> || Keep current movement velocity through the teleport.
|-
| <code>rotate_velocity</code> Rotate Velocity || <code>true</code> || Rotate preserved velocity from this trigger's facing into the destination facing.
|-
| <code>required_tag</code> Required Tag || <code>Empty</code> || Value type: <code>string</code>.
|-
| <code>allowed_teams</code> Allowed Teams || All (<code>7</code>) || Choices: None (<code>0</code>), Spectate (<code>1</code>), Order (<code>2</code>), Union (<code>4</code>), All (<code>7</code>).
|-
| <code>allowed_activators</code> Allowed Activators || Participants (<code>3</code>) || Choices: None (<code>0</code>), Humans (<code>1</code>), Bots (<code>2</code>), Participants (<code>3</code>), Unassigned Pawns (<code>4</code>), All Pawns (<code>7</code>), Non Pawns (<code>8</code>), Everything (<code>15</code>).
|-
| <code>start_disabled</code> Start Disabled || <code>false</code> || Value type: <code>bool</code>.
|-
| <code>ignore_nav_mesh</code> Ignore Nav Mesh || <code>false</code> || Exclude this entity from navigation-mesh building. This does not disable its gameplay collision.
|}

== VSig contract ==

Use the names below with a ref bound to this entity. The value column describes the catalog value type, not a C# method signature. See [[Grimwar/Entities#Read the reference|Read the reference]] for arguments, authority, and common controls.

{| class="wikitable"
! Kind !! Member !! Value !! Authority / access
|-
| Input || <code>disable</code> || <code>none</code> || Server
|-
| Input || <code>enable</code> || <code>none</code> || Server
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Input || <code>teleport</code> || <code>string</code> || Server
|-
| Input || <code>toggle</code> || <code>none</code> || Server
|-
| Output || <code>disabled</code> || <code>none</code> || Server
|-
| Output || <code>enabled</code> || <code>none</code> || Server
|-
| Output || <code>end_touch</code> || <code>string</code> || Server
|-
| Output || <code>end_touch_all</code> || <code>string</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|-
| Output || <code>start_touch</code> || <code>string</code> || Server
|-
| Output || <code>start_touch_all</code> || <code>string</code> || Server
|-
| Output || <code>teleport</code> || <code>string</code> || Server
|-
| Property || <code>is_enabled</code> || <code>bool</code> || Server; read/write
|}

This entity supports operational enable/disable. Repeating the current state does not emit another transition. <code>kill</code> is permanent for this map load.

[[Category:Grimwar entities]]

Grimwar/Entities/trigger spawn zone

2026-10-01T04:13:05Z

DocumentationBot: Version 1

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|trigger_spawn_zone|section}}

Register participants inside a team spawn zone.

Placement: Oriented volume.

== Set it up ==

Set Allowed Teams and size the volume around the spawn area. The game mode uses this registry for spawn-zone behavior. force_respawn_occupants requests a respawn for every current participant. Use a team barrier separately when you need a physical boundary.

== Settings ==

These are the initial authoring values. Script inputs and runtime state are listed separately below.

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>allowed_teams</code> Allowed Teams || All (<code>7</code>) || Participants outside these teams are ignored by this spawn zone. Choices: None (<code>0</code>), Spectate (<code>1</code>), Order (<code>2</code>), Union (<code>4</code>), All (<code>7</code>).
|-
| <code>start_disabled</code> Start Disabled || <code>false</code> || Start disabled until explicitly enabled.
|-
| <code>ignore_nav_mesh</code> Ignore Nav Mesh || <code>false</code> || Exclude this entity from navigation-mesh building. This does not disable its gameplay collision.
|}

== VSig contract ==

Use the names below with a ref bound to this entity. The value column describes the catalog value type, not a C# method signature. See [[Grimwar/Entities#Read the reference|Read the reference]] for arguments, authority, and common controls.

{| class="wikitable"
! Kind !! Member !! Value !! Authority / access
|-
| Input || <code>disable</code> || <code>none</code> || Server
|-
| Input || <code>enable</code> || <code>none</code> || Server
|-
| Input || <code>force_respawn_occupants</code> || <code>string</code> || Server
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Input || <code>toggle</code> || <code>none</code> || Server
|-
| Output || <code>disabled</code> || <code>none</code> || Server
|-
| Output || <code>enabled</code> || <code>none</code> || Server
|-
| Output || <code>end_touch</code> || <code>string</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|-
| Output || <code>start_touch</code> || <code>string</code> || Server
|-
| Property || <code>is_enabled</code> || <code>bool</code> || Server; read only
|}

This entity supports operational enable/disable. Repeating the current state does not emit another transition. <code>kill</code> is permanent for this map load.

[[Category:Grimwar entities]]

Grimwar/Entities/trigger push

2026-10-01T04:13:05Z

DocumentationBot: Version 1

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|trigger_push|section}}

Accelerate occupants or give them a one-time velocity impulse.

Placement: Oriented volume.

== Set it up ==

Continuous applies acceleration while occupied; On Enter gives an impulse. Push Angles uses local pitch and yaw: pitch -90 points up and yaw 90 points right. Clear Downward Velocity helps an upward push overcome a fall. push immediately affects current occupants, and set_speed clamps to zero or greater.

== Settings ==

These are the initial authoring values. Script inputs and runtime state are listed separately below.

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>required_tag</code> Required Tag || <code>Empty</code> || Optional tag required on an activating collider.
|-
| <code>allowed_teams</code> Allowed Teams || All (<code>7</code>) || Participant teams this trigger may push. Choices: None (<code>0</code>), Spectate (<code>1</code>), Order (<code>2</code>), Union (<code>4</code>), All (<code>7</code>).
|-
| <code>allowed_activators</code> Allowed Activators || Participants (<code>3</code>) || Kinds of collider that may activate this trigger. Choices: None (<code>0</code>), Humans (<code>1</code>), Bots (<code>2</code>), Participants (<code>3</code>), Unassigned Pawns (<code>4</code>), All Pawns (<code>7</code>), Non Pawns (<code>8</code>), Everything (<code>15</code>).
|-
| <code>mode</code> Mode || Continuous (<code>0</code>) || Continuous applies acceleration while occupied; On Enter applies one velocity impulse. Choices: Continuous (<code>0</code>), On Enter (<code>1</code>).
|-
| <code>speed</code> Speed || <code>12</code> || Acceleration per second or one-shot velocity impulse along Push Angles. Minimum: <code>0</code>.
|-
| <code>push_angles</code> Push Angles || <code>[0, 0]</code> || Local push angles in degrees: X is pitch (-90 = up), Y is yaw (90 = right). Zero follows the marker's forward axis.
|-
| <code>clear_downward_velocity</code> Clear Downward Velocity || <code>true</code> || Remove downward velocity before applying an upward push.
|-
| <code>start_disabled</code> Start Disabled || <code>false</code> || Value type: <code>bool</code>.
|-
| <code>ignore_nav_mesh</code> Ignore Nav Mesh || <code>false</code> || Exclude this entity from navigation-mesh building. This does not disable its gameplay collision.
|}

== VSig contract ==

Use the names below with a ref bound to this entity. The value column describes the catalog value type, not a C# method signature. See [[Grimwar/Entities#Read the reference|Read the reference]] for arguments, authority, and common controls.

{| class="wikitable"
! Kind !! Member !! Value !! Authority / access
|-
| Input || <code>disable</code> || <code>none</code> || Server
|-
| Input || <code>enable</code> || <code>none</code> || Server
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Input || <code>push</code> || <code>string</code> || Server
|-
| Input || <code>set_speed</code> || <code>float</code> || Server
|-
| Input || <code>toggle</code> || <code>none</code> || Server
|-
| Output || <code>disabled</code> || <code>none</code> || Server
|-
| Output || <code>enabled</code> || <code>none</code> || Server
|-
| Output || <code>end_touch</code> || <code>string</code> || Server
|-
| Output || <code>end_touch_all</code> || <code>string</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|-
| Output || <code>push</code> || <code>string</code> || Server
|-
| Output || <code>start_touch</code> || <code>string</code> || Server
|-
| Output || <code>start_touch_all</code> || <code>string</code> || Server
|-
| Property || <code>is_enabled</code> || <code>bool</code> || Server; read/write
|-
| Property || <code>speed</code> || <code>float</code> || Server; read/write
|}

This entity supports operational enable/disable. Repeating the current state does not emit another transition. <code>kill</code> is permanent for this map load.

[[Category:Grimwar entities]]

Grimwar/Entities/trigger multiple

2026-10-01T04:13:05Z

DocumentationBot: Version 1

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|trigger_multiple|section}}

Emit events as accepted objects enter, stay in, and leave a volume.

Placement: Oriented volume.

== Set it up ==

Set Allowed Teams explicitly: its default None excludes participants. Allowed Activators separately chooses humans, bots, unassigned pawns, and other colliders. Layer hints only narrow physics candidates. start_touch_all fires when occupancy goes from zero to one; end_touch_all fires when the last occupant leaves. fire emits trigger for each occupant. touch_test emits touching or not_touching. reset clears and refreshes occupancy. execute emits a short-lived participant snapshot token for VMods; see [[Grimwar/VSig#Signals shared with VMod|VSig and VMod]].

== Settings ==

These are the initial authoring values. Script inputs and runtime state are listed separately below.

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>required_tag</code> Required Tag || <code>Empty</code> || Only colliders with this tag activate the trigger. Leave blank to allow any tag.
|-
| <code>allowed_teams</code> Allowed Teams || None (<code>0</code>) || Allow participants from these teams. None blocks all participants; unassigned pawns and other colliders still follow Allowed Activators. Choices: None (<code>0</code>), Spectate (<code>1</code>), Order (<code>2</code>), Union (<code>4</code>), All (<code>7</code>).
|-
| <code>allowed_activators</code> Allowed Activators || Participants (<code>3</code>) || Participants are human or bot pawns. UnassignedPawns have a Pawn component with no participant. Choices: None (<code>0</code>), Humans (<code>1</code>), Bots (<code>2</code>), Participants (<code>3</code>), Unassigned Pawns (<code>4</code>), All Pawns (<code>7</code>), Non Pawns (<code>8</code>), Everything (<code>15</code>).
|-
| <code>layer_hint_mode</code> Layer Hint Mode || Auto From Activators (<code>0</code>) || Filters physics candidates; Allowed Activators still decides who triggers. Use SDK Layer Set for shared layers such as Item. Choices: Auto From Activators (<code>0</code>), Sdk Layer Set (<code>1</code>), All (<code>2</code>).
|-
| <code>layer_hint_set</code> Layer Hint Set || Participants (<code>3</code>) || Layers used when Layer Hint Mode is SDK Layer Set. Choices: None (<code>0</code>), Pawn (<code>1</code>), Hitbox (<code>2</code>), Participants (<code>3</code>), Item (<code>4</code>), Default (<code>8</code>), Shield (<code>16</code>), First Person (<code>32</code>), Trigger (<code>64</code>), Ragdoll (<code>128</code>).
|-
| <code>start_disabled</code> Start Disabled || <code>false</code> || Ignore touches until enabled by input.
|-
| <code>wait_seconds</code> Wait Seconds || <code>0.2</code> || Seconds between firings while occupied. Use 0.2 for typical triggers; 0 fires every frame. Minimum: <code>0</code>.
|-
| <code>delay_seconds</code> Delay Seconds || <code>0</code> || Delay (seconds) before the first OnTrigger after an activator enters. Minimum: <code>0</code>.
|-
| <code>fire_once</code> Fire Once || <code>false</code> || Disable after the first OnTrigger.
|-
| <code>touching_interval_seconds</code> Touching Interval Seconds || <code>0</code> || Seconds between OnTouching events while occupied. 0 disables them. Minimum: <code>0</code>.
|-
| <code>ignore_nav_mesh</code> Ignore Nav Mesh || <code>false</code> || Exclude this entity from navigation-mesh building. This does not disable its gameplay collision.
|}

== VSig contract ==

Use the names below with a ref bound to this entity. The value column describes the catalog value type, not a C# method signature. See [[Grimwar/Entities#Read the reference|Read the reference]] for arguments, authority, and common controls.

{| class="wikitable"
! Kind !! Member !! Value !! Authority / access
|-
| Input || <code>disable</code> || <code>none</code> || Server
|-
| Input || <code>enable</code> || <code>none</code> || Server
|-
| Input || <code>execute</code> || <code>none</code> || Server
|-
| Input || <code>fire</code> || <code>string</code> || Server
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Input || <code>reset</code> || <code>string</code> || Server
|-
| Input || <code>toggle</code> || <code>none</code> || Server
|-
| Input || <code>touch_test</code> || <code>string</code> || Server
|-
| Output || <code>disabled</code> || <code>none</code> || Server
|-
| Output || <code>enabled</code> || <code>none</code> || Server
|-
| Output || <code>end_touch</code> || <code>string</code> || Server
|-
| Output || <code>end_touch_all</code> || <code>string</code> || Server
|-
| Output || <code>executed</code> || <code>string</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|-
| Output || <code>not_touching</code> || <code>string</code> || Server
|-
| Output || <code>start_touch</code> || <code>string</code> || Server
|-
| Output || <code>start_touch_all</code> || <code>string</code> || Server
|-
| Output || <code>touching</code> || <code>string</code> || Server
|-
| Output || <code>trigger</code> || <code>string</code> || Server
|-
| Property || <code>is_enabled</code> || <code>bool</code> || Server; read only
|}

This entity supports operational enable/disable. Repeating the current state does not emit another transition. <code>kill</code> is permanent for this map load.

[[Category:Grimwar entities]]

Grimwar/Entities/trigger hurt

2026-10-01T04:13:05Z

DocumentationBot: Version 1

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|trigger_hurt|section}}

Damage or heal accepted occupants at an interval.

Placement: Oriented volume.

== Set it up ==

Set Allowed Activators, Allowed Teams, and any Required Tag before choosing Damage and Damage Interval Seconds. Negative damage heals. Doubling With Forgiveness increases per-target damage while occupied; set a cap if needed. hurt_player identifies a player-health target, while hurt covers another damageable. set_damage also resets the current doubling values.

== Settings ==

These are the initial authoring values. Script inputs and runtime state are listed separately below.

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>required_tag</code> Required Tag || <code>Empty</code> || Optional tag filter. If set, only colliders with this tag are processed.
|-
| <code>allowed_teams</code> Allowed Teams || All (<code>7</code>) || Optional team mask filter for participant-owned activators. Choices: None (<code>0</code>), Spectate (<code>1</code>), Order (<code>2</code>), Union (<code>4</code>), All (<code>7</code>).
|-
| <code>allowed_activators</code> Allowed Activators || Everything (<code>15</code>) || Which activator categories can be affected. Participants are pawns controlled by humans or bots. Choices: None (<code>0</code>), Humans (<code>1</code>), Bots (<code>2</code>), Participants (<code>3</code>), Unassigned Pawns (<code>4</code>), All Pawns (<code>7</code>), Non Pawns (<code>8</code>), Everything (<code>15</code>).
|-
| <code>layer_hint_mode</code> Layer Hint Mode || Auto From Activators (<code>0</code>) || Physics broad-phase hint only. Gameplay correctness still uses semantic activator filters. Use SDK Layer Set for deterministic cross-project hints like Item. Choices: Auto From Activators (<code>0</code>), Sdk Layer Set (<code>1</code>), All (<code>2</code>).
|-
| <code>layer_hint_set</code> Layer Hint Set || Participants (<code>3</code>) || Canonical SDK layer set used when Layer Hint Mode is SDK Layer Set. Choices: None (<code>0</code>), Pawn (<code>1</code>), Hitbox (<code>2</code>), Participants (<code>3</code>), Item (<code>4</code>), Default (<code>8</code>), Shield (<code>16</code>), First Person (<code>32</code>), Trigger (<code>64</code>), Ragdoll (<code>128</code>).
|-
| <code>start_disabled</code> Start Disabled || <code>false</code> || Start disabled (won't process touching entities) until enabled by input.
|-
| <code>damage</code> Damage || <code>10</code> || Damage dealt each tick. Negative values heal instead of damaging.
|-
| <code>damage_interval_seconds</code> Damage Interval Seconds || <code>0.5</code> || Seconds between damage/heal ticks while touching. Minimum: <code>0.01</code>.
|-
| <code>model</code> Model || Normal (<code>0</code>) || How per-target damage changes over time while continuously touching. Choices: Normal (<code>0</code>), Doubling With Forgiveness (<code>1</code>).
|-
| <code>damage_cap_per_second</code> Damage Cap Per Second || <code>0</code> || Maximum damage per second for DoublingWithForgiveness. 0 means uncapped. Minimum: <code>0</code>.
|-
| <code>ignore_nav_mesh</code> Ignore Nav Mesh || <code>false</code> || Exclude this entity from navigation-mesh building. This does not disable its gameplay collision.
|}

== VSig contract ==

Use the names below with a ref bound to this entity. The value column describes the catalog value type, not a C# method signature. See [[Grimwar/Entities#Read the reference|Read the reference]] for arguments, authority, and common controls.

{| class="wikitable"
! Kind !! Member !! Value !! Authority / access
|-
| Input || <code>disable</code> || <code>none</code> || Server
|-
| Input || <code>enable</code> || <code>none</code> || Server
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Input || <code>reset</code> || <code>string</code> || Server
|-
| Input || <code>set_damage</code> || <code>string</code> || Server
|-
| Input || <code>toggle</code> || <code>none</code> || Server
|-
| Input || <code>touch_test</code> || <code>string</code> || Server
|-
| Output || <code>disabled</code> || <code>none</code> || Server
|-
| Output || <code>enabled</code> || <code>none</code> || Server
|-
| Output || <code>end_touch</code> || <code>string</code> || Server
|-
| Output || <code>end_touch_all</code> || <code>string</code> || Server
|-
| Output || <code>hurt</code> || <code>string</code> || Server
|-
| Output || <code>hurt_player</code> || <code>string</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|-
| Output || <code>not_touching</code> || <code>string</code> || Server
|-
| Output || <code>start_touch</code> || <code>string</code> || Server
|-
| Output || <code>start_touch_all</code> || <code>string</code> || Server
|-
| Output || <code>touching</code> || <code>string</code> || Server
|-
| Property || <code>is_enabled</code> || <code>bool</code> || Server; read only
|}

This entity supports operational enable/disable. Repeating the current state does not emit another transition. <code>kill</code> is permanent for this map load.

[[Category:Grimwar entities]]

Grimwar/Entities/trigger gravewar upgrade zone

2026-10-01T04:13:05Z

DocumentationBot: Version 1

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|trigger_gravewar_upgrade_zone|section}}

Open Gravewar upgrades for eligible players inside a volume.

Placement: Oriented volume.

== Set it up ==

Place the volume where human Order participants should access the upgrade interface. The game mode supplies the eligibility rules. It also exposes generic trigger signals for map logic. Test entering and leaving the zone in Gravewar mode.

== Settings ==

These are the initial authoring values. Script inputs and runtime state are listed separately below.

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>start_disabled</code> Start Disabled || <code>false</code> || Start disabled until enabled through an entity input.
|-
| <code>wait_seconds</code> Wait Seconds || <code>0.2</code> || Seconds between OnTrigger emissions while an accepted object remains inside. Minimum: <code>0</code>.
|-
| <code>delay_seconds</code> Delay Seconds || <code>0</code> || Delay before the first OnTrigger emission after entry. Minimum: <code>0</code>.
|-
| <code>fire_once</code> Fire Once || <code>false</code> || Disable this volume after its first OnTrigger emission.
|-
| <code>touching_interval_seconds</code> Touching Interval Seconds || <code>0</code> || Emit OnTouching at this interval while occupied. Zero disables it. Minimum: <code>0</code>.
|-
| <code>ignore_nav_mesh</code> Ignore Nav Mesh || <code>false</code> || Exclude this entity from navigation-mesh building. This does not disable its gameplay collision.
|}

== VSig contract ==

Use the names below with a ref bound to this entity. The value column describes the catalog value type, not a C# method signature. See [[Grimwar/Entities#Read the reference|Read the reference]] for arguments, authority, and common controls.

{| class="wikitable"
! Kind !! Member !! Value !! Authority / access
|-
| Input || <code>disable</code> || <code>none</code> || Server
|-
| Input || <code>enable</code> || <code>none</code> || Server
|-
| Input || <code>execute</code> || <code>none</code> || Server
|-
| Input || <code>fire</code> || <code>string</code> || Server
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Input || <code>reset</code> || <code>string</code> || Server
|-
| Input || <code>toggle</code> || <code>none</code> || Server
|-
| Input || <code>touch_test</code> || <code>string</code> || Server
|-
| Output || <code>disabled</code> || <code>none</code> || Server
|-
| Output || <code>enabled</code> || <code>none</code> || Server
|-
| Output || <code>end_touch</code> || <code>string</code> || Server
|-
| Output || <code>end_touch_all</code> || <code>string</code> || Server
|-
| Output || <code>executed</code> || <code>string</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|-
| Output || <code>not_touching</code> || <code>string</code> || Server
|-
| Output || <code>start_touch</code> || <code>string</code> || Server
|-
| Output || <code>start_touch_all</code> || <code>string</code> || Server
|-
| Output || <code>touching</code> || <code>string</code> || Server
|-
| Output || <code>trigger</code> || <code>string</code> || Server
|-
| Property || <code>is_enabled</code> || <code>bool</code> || Server; read only
|}

This entity supports operational enable/disable. Repeating the current state does not emit another transition. <code>kill</code> is permanent for this map load.

[[Category:Grimwar entities]]

Grimwar/Entities/trigger gravewar skull deposit

2026-10-01T04:13:05Z

DocumentationBot: Version 1

{{GameNav}}

[[Grimwar/Entities|All entities]]

{{Entity icon|trigger_gravewar_skull_deposit|section}}

Let Gravewar survivors bank carried skulls.

Placement: Oriented volume.

== Set it up ==

Place the volume around the deposit area. Eligible survivors use Interact while inside it to bank skulls for the team. The game mode supplies participant filtering. This entity also has the generic trigger signals below; its trigger output alone is not a command to deposit arbitrary skulls. Test the facility in Gravewar mode.

== Settings ==

These are the initial authoring values. Script inputs and runtime state are listed separately below.

{| class="wikitable"
! Setting !! Default !! Meaning and choices
|-
| <code>start_disabled</code> Start Disabled || <code>false</code> || Start disabled until enabled through an entity input.
|-
| <code>wait_seconds</code> Wait Seconds || <code>0.2</code> || Seconds between OnTrigger emissions while an accepted object remains inside. Minimum: <code>0</code>.
|-
| <code>delay_seconds</code> Delay Seconds || <code>0</code> || Delay before the first OnTrigger emission after entry. Minimum: <code>0</code>.
|-
| <code>fire_once</code> Fire Once || <code>false</code> || Disable this volume after its first OnTrigger emission.
|-
| <code>touching_interval_seconds</code> Touching Interval Seconds || <code>0</code> || Emit OnTouching at this interval while occupied. Zero disables it. Minimum: <code>0</code>.
|-
| <code>ignore_nav_mesh</code> Ignore Nav Mesh || <code>false</code> || Exclude this entity from navigation-mesh building. This does not disable its gameplay collision.
|}

== VSig contract ==

Use the names below with a ref bound to this entity. The value column describes the catalog value type, not a C# method signature. See [[Grimwar/Entities#Read the reference|Read the reference]] for arguments, authority, and common controls.

{| class="wikitable"
! Kind !! Member !! Value !! Authority / access
|-
| Input || <code>disable</code> || <code>none</code> || Server
|-
| Input || <code>enable</code> || <code>none</code> || Server
|-
| Input || <code>execute</code> || <code>none</code> || Server
|-
| Input || <code>fire</code> || <code>string</code> || Server
|-
| Input || <code>kill</code> || <code>none</code> || Server
|-
| Input || <code>reset</code> || <code>string</code> || Server
|-
| Input || <code>toggle</code> || <code>none</code> || Server
|-
| Input || <code>touch_test</code> || <code>string</code> || Server
|-
| Output || <code>disabled</code> || <code>none</code> || Server
|-
| Output || <code>enabled</code> || <code>none</code> || Server
|-
| Output || <code>end_touch</code> || <code>string</code> || Server
|-
| Output || <code>end_touch_all</code> || <code>string</code> || Server
|-
| Output || <code>executed</code> || <code>string</code> || Server
|-
| Output || <code>killed</code> || <code>none</code> || Server
|-
| Output || <code>not_touching</code> || <code>string</code> || Server
|-
| Output || <code>start_touch</code> || <code>string</code> || Server
|-
| Output || <code>start_touch_all</code> || <code>string</code> || Server
|-
| Output || <code>touching</code> || <code>string</code> || Server
|-
| Output || <code>trigger</code> || <code>string</code> || Server
|-
| Property || <code>is_enabled</code> || <code>bool</code> || Server; read only
|}

This entity supports operational enable/disable. Repeating the current state does not emit another transition. <code>kill</code> is permanent for this map load.

[[Category:Grimwar entities]]