Vellocet Developer Community - Recent changes [en]

Main Page

WikiAdmin — Tue, 25 Aug 2026 05:34:48 GMT

Deploy Vellocet visual system

← Older revision		Revision as of 01:34, 25 August 2026
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	<div class="~~vellocet~~-~~hero~~">		<div class="docs-home">
	<div class="~~vellocet~~-~~hero__rail~~"~~><span>PUBLIC BUILD</span><span>DOCS / 2026</span></div>~~		<div class="docs-home__intro">
	~~<div class="vellocet-eyebrow">VELLOCET DEVELOPER COMMUNITY</div~~>		<h1>Developer documentation</h1>
	<~~div class="vellocet-hero__title"~~>~~Build worlds.~~<br /~~>Change the rules.</div~~>		<p>This wiki documents Grimwar maps, VSig scripts, VMods, addons, Steam Workshop publishing, and dedicated servers.</p>
	<p ~~class="vellocet-hero__lede"~~>~~Install the SDK, build~~ Grimwar maps, ~~write~~ VSig ~~and VMod~~, ~~package~~ addons, and ~~run community~~ servers.</p>
	~~<div class="vellocet-actions">[[Grimwar/Getting started\|Start with Grimwar]] [[Vellocet SDK\|Install the SDK]]</div>~~
	~~<div class="vellocet-hero__meta"><span>Maps</span><span>Server mods</span><span>Workshop</span><span>Tools</span></div~~>
	</div>		</div>

	<div class="~~vellocet~~-~~section-heading"><span>01</span><h2>Choose a game</h2></div>~~		<div class="docs-home__layout">
			<div class="docs-home__primary">
	~~<div class="vellocet-card-grid">~~
	~~<div class="vellocet-card vellocet-card--grimwar~~">
	<div class="~~vellocet~~-~~card__index~~"~~>01 / 03</div>~~
	~~<div class="vellocet-card__status">IN DEVELOPMENT</div~~>
	<h2>Grimwar</h2>		<h2>Grimwar</h2>
	<~~p>Map authoring, VSig, Workshop addons, dedicated servers, and server~~-~~side C# mods.</p~~>		<div class="docs-home__directory">
	<div class="~~vellocet~~-~~card__links~~">[[Grimwar\|~~Open developer portal →~~]]</~~div~~>		<div class="docs-home__entry"><h3>[[Grimwar/Getting started\|Getting started]]</h3><p>Install the tools and export a test map.</p></div>
	</div>		<div class="docs-home__entry"><h3>[[Vellocet SDK]]</h3><p>Set up SDK 1.0.3, sync content, use the Workbench, and export addons.</p></div>
	<div class="~~vellocet~~-~~card vellocet-card--aneurism~~">		<div class="docs-home__entry"><h3>[[Grimwar/Mapping\|Map authoring]]</h3><p>Build scenes with entities, lighting, navigation, spatial data, and VSig.</p></div>
	<div class="~~vellocet~~-~~card__index~~">02 / 03</div>		<div class="docs-home__entry"><h3>[[Grimwar/VSig\|VSig scripting]]</h3><p>Write map logic, handle events, call entities, and share modules.</p></div>
	<div class="~~vellocet~~-~~card__status~~">~~DOCUMENTATION INDEX~~</~~div>~~		<div class="docs-home__entry"><h3>[[Grimwar/VMod\|VMod scripting]]</h3><p>Package server-side C# and use Grimwar Mod API 5.</p></div>
	~~<h2>ANEURISM IV~~</h2>		<div class="docs-home__entry"><h3>[[Grimwar/Addons\|Using addons]]</h3><p>Install packages, enable them, select a source, and resolve conflicts.</p></div>
	<p>~~The ANEURISM IV section currently records documentation status without claiming unsupported mod interfaces~~.</p>		<div class="docs-home__entry"><h3>[[Grimwar/Steam Workshop addons\|Steam Workshop]]</h3><p>Publish and update map-only Release packages.</p></div>
	<div class="~~vellocet~~-~~card__links~~">[[~~ANEURISM IV~~\|~~Open developer portal →~~]]</~~div~~>		<div class="docs-home__entry"><h3>[[Grimwar/Dedicated servers\|Dedicated servers]]</h3><p>Configure servers, Workshop maps, VMods, rotation, and FastDL.</p></div>
	</div>
	<div class="~~vellocet-card vellocet-card-~~-~~muted~~">
	<~~div class="vellocet-card__index"~~>03 / 03</div>
	<div class="~~vellocet~~-~~card__status~~">~~FUTURE RELEASES~~</~~div>~~
	~~<h2>Upcoming games~~</h2>
	<p>~~Game~~-~~specific documentation will be added~~ only ~~after its public authoring interfaces are fixed~~.</p>
	<div class="~~vellocet~~-~~card__links~~">[[~~Upcoming games~~\|~~Documentation policy →~~]]</div>
	</div>		</div>
	</div>		</div>

	<div class="~~vellocet~~-~~section~~-~~heading~~"><~~span~~>02</~~span~~><h2>~~Developer resources~~</h2></div>		<div class="docs-home__aside">
			<h2>Other games</h2>
			<div class="docs-home__game"><h3>[[ANEURISM IV]]</h3><p>ANEURISM IV has no public authoring SDK or mod API.</p></div>
			<div class="docs-home__game"><h3>[[Upcoming games]]</h3><p>Vellocet has not published authoring tools for upcoming games.</p></div>

	<~~div class="vellocet-resource-grid"~~>		<h2>Versions</h2>
	<~~div~~><~~div~~ class="~~vellocet~~-~~resource__index~~">~~01 / SDK</div>~~<h3>[[Vellocet SDK]]</h3><p>~~Install the Unity package, create content, validate it, and export release-ready addons~~.</~~p></div~~>		<dl class="docs-home__versions">
	<~~div~~>~~<div class="vellocet-resource__index">02 / WORLD~~</~~div~~><h3>~~[[Grimwar/Mapping\|Mapping]]</h3><p>Author maps with entities, signals, lighting, navigation, and spatial data~~.</~~p></div~~>		<dt>Vellocet SDK</dt><dd>1.0.3</dd>
	<~~div~~>~~<div class="vellocet-resource__index">03 / LOGIC~~</~~div~~><h3>~~[[Grimwar/VSig\|VSig]]~~</~~h3><p>Connect entities, keep map state, schedule actions, and exchange signals with VMod.</p></div~~>		<dt>Unity</dt><dd>6000.3.17f1</dd>
	<~~div><div class="vellocet-resource__index">04 / CODE</div~~>~~<h3>[[Grimwar/~~VMod~~\|VMod]]~~</h3><~~p>Write server-authoritative C# against the public Grimwar Mod API.</p~~></~~div~~>		<dt>Addon schema</dt><dd>9</dd>
	~~<div><div class="vellocet-resource__index">05 / SHIP</div><h3>[[Grimwar/Addons\|Addons]]</h3><p>Package, install, select, validate, and test Grimwar content.~~</~~p></div~~>		<dt>VMod API</dt><dd>5</dd>
	~~<div><div class="vellocet-resource__index">06 / STEAM</div><h3>[[Grimwar/Steam Workshop addons\|Workshop]]</h3><p>Publish map-only Release packages and diagnose delivery failures.</p>~~</div>		</dl>
			</div>
	</div>		</div>

	<div class="~~vellocet~~-~~section-heading~~">~~<span>03</span><h2>Contribute</h2></div>~~		<div class="docs-home__utility">[[Help:Contents\|Wiki help]] · [[Special:AllPages\|All pages]] · [[Special:RecentChanges\|Recent changes]] · [[Vellocet Developer Community:Content policy\|Editing policy]]</div>

	~~<div class="vellocet-contribute">~~
	~~<div class="vellocet-contribute__label">Correct a guide or report a missing contract.</div>~~
	~~<div class="vellocet-contribute__body">Read the~~ [[~~Vellocet Developer Community~~:~~Content policy~~\|~~content policy~~]]~~, inspect~~ [[Special:RecentChanges\|~~recent~~ changes]]~~, or use the~~ [[Vellocet Developer Community:~~Community portal~~\|~~community portal~~]]~~. Generated API pages are maintained from versioned source.~~</div>
	</div>		</div>

MediaWiki:Common.css

WikiAdmin — Tue, 25 Aug 2026 05:34:45 GMT

Deploy Vellocet visual system

Show changes

Vellocet Developer Community:Community portal

DocumentationBot — Tue, 25 Aug 2026 05:34:36 GMT

Publish SDK documentation

← Older revision		Revision as of 01:34, 25 August 2026
Line 1:		Line 1:
	~~The '''Vellocet Developer Community''' is the official home for technical documentation about~~ modding and ~~extending~~ Vellocet games.		This wiki documents public modding tools and APIs for Vellocet games.

	== ~~How the wiki is organized~~ ==		== Page types ==

	* '''Official guides''' explain supported workflows and are reviewed alongside game changes.		* '''Official guides''' explain supported workflows and are reviewed alongside game changes.
Line 9:		Line 9:
	== Contributing ==		== Contributing ==

	Public account registration ~~will open after~~ outbound email, anti-abuse protection, and contribution terms ~~have been verified~~. ~~Until then,~~ Vellocet staff can create editor accounts.		Public account registration is closed while Vellocet completes outbound email, anti-abuse protection, and contribution terms. Vellocet staff can create editor accounts.

	Before editing, read the [[Vellocet Developer Community:Content policy\|content policy]]. Use article talk pages for questions about a specific document and [[Help:Contents]] for wiki help.		Before editing, read the [[Vellocet Developer Community:Content policy\|content policy]]. Use article talk pages for questions about a specific document and [[Help:Contents]] for wiki help.

Upcoming games

DocumentationBot — Tue, 25 Aug 2026 05:34:35 GMT

Publish SDK documentation

← Older revision		Revision as of 01:34, 25 August 2026
Line 1:		Line 1:
	~~This page does~~ not ~~document~~ unannounced ~~games~~ or unreleased ~~interfaces. A game receives technical pages only after Vellocet publishes its authoring tools and compatibility boundary~~.		Vellocet has not published authoring tools for its unannounced or unreleased games.

	~~Do not assume that a~~ Grimwar ~~entity~~, package ~~schema~~, VSig ~~feature~~, or VMod ~~API works in another game~~. Shared ~~tooling is~~ documented under [[Vellocet SDK]]~~; runtime behavior belongs under the game that implements it~~.		Grimwar entities, package schemas, VSig features, and VMod APIs apply only to Grimwar. Shared tools are documented under [[Vellocet SDK]].

	[[Category:Vellocet games]]		[[Category:Vellocet games]]

ANEURISM IV

DocumentationBot — Tue, 25 Aug 2026 05:34:34 GMT

Publish SDK documentation

← Older revision		Revision as of 01:34, 25 August 2026
Line 1:		Line 1:
	~~No public~~ ANEURISM IV authoring SDK or supported ~~modding contract is documented here yet~~. ~~Do not apply~~ Grimwar package, VSig, or VMod instructions to ANEURISM IV ~~unless a game-specific~~ page ~~explicitly~~ says ~~they are compatible~~.		ANEURISM IV does not have a public authoring SDK or supported mod API. Grimwar package, VSig, and VMod instructions do not apply unless an ANEURISM IV page says otherwise.

	[[Category:ANEURISM IV]]		[[Category:ANEURISM IV]]

Grimwar

DocumentationBot — Tue, 25 Aug 2026 05:34:22 GMT

Publish SDK documentation

← Older revision		Revision as of 01:34, 25 August 2026
Line 1:		Line 1:
	{{GameNav}}		{{GameNav}}

	~~<div class="vellocet-eyebrow">GRIMWAR DEVELOPER PORTAL</div>~~		Grimwar supports custom Unity maps, VSig map logic, VMod server scripts, addon packages, Steam Workshop maps, and community dedicated servers.

	~~These guides cover the public~~ Grimwar ~~content toolchain:~~ Unity ~~map authoring~~, VSig map logic, VMod server ~~scripting~~, addon ~~installation~~, Steam Workshop maps, and community dedicated servers.

	== Start here ==		== Start here ==
Line 25:		Line 23:
	\|}		\|}

	== ~~Current version boundary~~ ==		== Versions ==

	{\| class="wikitable"		{\| class="wikitable"

Main Page

WikiAdmin — Tue, 25 Aug 2026 05:13:42 GMT

Deploy Vellocet visual system

← Older revision		Revision as of 01:13, 25 August 2026
Line 4:		Line 4:
	<div class="vellocet-eyebrow">VELLOCET DEVELOPER COMMUNITY</div>		<div class="vellocet-eyebrow">VELLOCET DEVELOPER COMMUNITY</div>
	<div class="vellocet-hero__title">Build worlds.<br />Change the rules.</div>		<div class="vellocet-hero__title">Build worlds.<br />Change the rules.</div>
	<p class="vellocet-hero__lede">~~Official technical documentation for creating~~ maps, ~~server mods~~, ~~tools~~, and community ~~content for Vellocet games~~.</p>		<p class="vellocet-hero__lede">Install the SDK, build Grimwar maps, write VSig and VMod, package addons, and run community servers.</p>
	<div class="vellocet-actions">[[Grimwar/Getting started\|Start with Grimwar]] [[Vellocet ~~Developer Community:Community portal~~\|~~Join~~ the ~~community~~]]</div>		<div class="vellocet-actions">[[Grimwar/Getting started\|Start with Grimwar]] [[Vellocet SDK\|Install the SDK]]</div>
	<div class="vellocet-hero__meta"><span>Maps</span><span>Server mods</span><span>Workshop</span><span>Tools</span></div>		<div class="vellocet-hero__meta"><span>Maps</span><span>Server mods</span><span>Workshop</span><span>Tools</span></div>
	</div>		</div>
Line 23:		Line 23:
	<div class="vellocet-card__status">DOCUMENTATION INDEX</div>		<div class="vellocet-card__status">DOCUMENTATION INDEX</div>
	<h2>ANEURISM IV</h2>		<h2>ANEURISM IV</h2>
	<p>~~Technical references and community knowledge for~~ ANEURISM IV.</p>		<p>The ANEURISM IV section currently records documentation status without claiming unsupported mod interfaces.</p>
	<div class="vellocet-card__links">[[ANEURISM IV\|Open developer portal →]]</div>		<div class="vellocet-card__links">[[ANEURISM IV\|Open developer portal →]]</div>
	</div>		</div>
Line 30:		Line 30:
	<div class="vellocet-card__status">FUTURE RELEASES</div>		<div class="vellocet-card__status">FUTURE RELEASES</div>
	<h2>Upcoming games</h2>		<h2>Upcoming games</h2>
	<p>~~New developer portals~~ will ~~share the same tools, conventions, and contributor workflow~~.</p>		<p>Game-specific documentation will be added only after its public authoring interfaces are fixed.</p>
	<div class="vellocet-card__links">[[Upcoming games\|~~View the roadmap~~ →]]</div>		<div class="vellocet-card__links">[[Upcoming games\|Documentation policy →]]</div>
	</div>		</div>
	</div>		</div>
Line 40:		Line 40:
	<div><div class="vellocet-resource__index">01 / SDK</div><h3>[[Vellocet SDK]]</h3><p>Install the Unity package, create content, validate it, and export release-ready addons.</p></div>		<div><div class="vellocet-resource__index">01 / SDK</div><h3>[[Vellocet SDK]]</h3><p>Install the Unity package, create content, validate it, and export release-ready addons.</p></div>
	<div><div class="vellocet-resource__index">02 / WORLD</div><h3>[[Grimwar/Mapping\|Mapping]]</h3><p>Author maps with entities, signals, lighting, navigation, and spatial data.</p></div>		<div><div class="vellocet-resource__index">02 / WORLD</div><h3>[[Grimwar/Mapping\|Mapping]]</h3><p>Author maps with entities, signals, lighting, navigation, and spatial data.</p></div>
	<div><div class="vellocet-resource__index">03 / CODE</div><h3>[[Grimwar/~~Server-side modding~~\|~~Server mods~~]]</h3><p>~~Build bounded~~ C# ~~gameplay extensions~~ against the ~~stable~~ Grimwar Mod API.</p></div>		<div><div class="vellocet-resource__index">03 / LOGIC</div><h3>[[Grimwar/VSig\|VSig]]</h3><p>Connect entities, keep map state, schedule actions, and exchange signals with VMod.</p></div>
	<div><div class="vellocet-resource__index">04 / SHIP</div><h3>[[Grimwar/~~Steam Workshop addons~~\|~~Workshop~~]]</h3><p>Package, ~~validate~~, ~~publish~~, ~~install~~, and ~~troubleshoot community~~ content.</p></div>		<div><div class="vellocet-resource__index">04 / CODE</div><h3>[[Grimwar/VMod\|VMod]]</h3><p>Write server-authoritative C# against the public Grimwar Mod API.</p></div>
			<div><div class="vellocet-resource__index">05 / SHIP</div><h3>[[Grimwar/Addons\|Addons]]</h3><p>Package, install, select, validate, and test Grimwar content.</p></div>
			<div><div class="vellocet-resource__index">06 / STEAM</div><h3>[[Grimwar/Steam Workshop addons\|Workshop]]</h3><p>Publish map-only Release packages and diagnose delivery failures.</p></div>
	</div>		</div>

Line 47:		Line 49:

	<div class="vellocet-contribute">		<div class="vellocet-contribute">
	<div class="vellocet-contribute__label">~~Documentation is part of the toolchain~~.</div>		<div class="vellocet-contribute__label">Correct a guide or report a missing contract.</div>
	<div class="vellocet-contribute__body">~~This wiki combines official, generated reference material with community-authored guides.~~ Read the [[Vellocet Developer Community:Content policy\|content policy]], ~~browse~~ [[Special:RecentChanges\|recent changes]], or ~~visit~~ the [[Vellocet Developer Community:Community portal\|community portal]].</div>		<div class="vellocet-contribute__body">Read the [[Vellocet Developer Community:Content policy\|content policy]], inspect [[Special:RecentChanges\|recent changes]], or use the [[Vellocet Developer Community:Community portal\|community portal]]. Generated API pages are maintained from versioned source.</div>
	</div>		</div>

Template:GameNav

WikiAdmin — Tue, 25 Aug 2026 05:13:41 GMT

Deploy Vellocet visual system

← Older revision		Revision as of 01:13, 25 August 2026
Line 1:		Line 1:
	<div class="game-nav">~~'''Grimwar:'''~~ [[Grimwar/Getting started\|Getting started]] · [[Grimwar/Mapping\|~~Mapping~~]] · [[Grimwar/~~Server-side modding~~\|~~Server mods~~]] · [[Grimwar/Steam Workshop addons\|Workshop]] · [[Grimwar/Dedicated servers\|~~Dedicated servers~~]] · [[Vellocet SDK\|SDK]]</div>		<div class="game-nav">[[Grimwar/Getting started\|Getting started]] · [[Grimwar/Mapping\|Maps]] · [[Grimwar/VSig\|VSig]] · [[Grimwar/VMod\|VMod]] · [[Grimwar/Addons\|Addons]] · [[Grimwar/Steam Workshop addons\|Workshop]] · [[Grimwar/Dedicated servers\|Servers]] · [[Vellocet SDK\|SDK]]</div>

MediaWiki:Sidebar

WikiAdmin — Tue, 25 Aug 2026 05:13:40 GMT

Deploy Vellocet visual system

← Older revision		Revision as of 01:13, 25 August 2026
Line 7:		Line 7:
	* grimwar		* grimwar
	** Grimwar/Getting started\|Getting started		** Grimwar/Getting started\|Getting started
	** Grimwar/Mapping\|~~Mapping~~		** Grimwar/Mapping\|Map authoring
	** Grimwar/~~Server-side modding~~\|~~Server mods~~		** Grimwar/VSig\|VSig
			** Grimwar/VMod\|VMod scripting
			** Grimwar/Addons\|Using addons
	** Grimwar/Steam Workshop addons\|Steam Workshop		** Grimwar/Steam Workshop addons\|Steam Workshop
	** Grimwar/Dedicated servers\|Dedicated servers		** Grimwar/Dedicated servers\|Dedicated servers

Upcoming games

DocumentationBot — Tue, 25 Aug 2026 05:13:20 GMT

Publish SDK documentation

← Older revision		Revision as of 01:13, 25 August 2026
Line 1:		Line 1:
	~~Future Vellocet~~ games ~~will receive their own developer portal when public authoring~~ interfaces ~~are ready~~. ~~Shared concepts belong under [[~~Vellocet ~~SDK]]; game-specific behavior remains in that game's section~~.		This page does not document unannounced games or unreleased interfaces. A game receives technical pages only after Vellocet publishes its authoring tools and compatibility boundary.

	~~No unannounced~~ game ~~or unreleased interface should be~~ documented ~~here~~.		Do not assume that a Grimwar entity, package schema, VSig feature, or VMod API works in another game. Shared tooling is documented under [[Vellocet SDK]]; runtime behavior belongs under the game that implements it.

	[[Category:Vellocet games]]		[[Category:Vellocet games]]

ANEURISM IV

DocumentationBot — Tue, 25 Aug 2026 05:13:19 GMT

Publish SDK documentation

← Older revision		Revision as of 01:13, 25 August 2026
Line 1:		Line 1:
	~~{{Draft}}~~		No public ANEURISM IV authoring SDK or supported modding contract is documented here yet. Do not apply Grimwar package, VSig, or VMod instructions to ANEURISM IV unless a game-specific page explicitly says they are compatible.

	~~This will be the official developer and community-knowledge portal for '''~~ANEURISM IV~~'''~~. ~~Its public modding surfaces~~, ~~supported tools~~, ~~version boundaries, and existing documentation still need~~ to ~~be inventoried before technical claims~~ are ~~published~~.

	~~Planned sections include:~~

	* Getting started
	* Supported content and mod types
	* Tools and installation
	* Technical reference
	* Tutorials and examples
	* Troubleshooting

	[[Category:ANEURISM IV]]		[[Category:ANEURISM IV]]

Vellocet SDK

DocumentationBot — Tue, 25 Aug 2026 05:13:17 GMT

Publish SDK documentation

@@ Line 1: / Line 1: @@
-{{Draft}}
+{{Notice|title=Version target|These instructions cover Vellocet SDK 1.0.3, Unity 6000.3.17f1, SDK content schema 3, addon schema 9, and Grimwar VMod API 5.}}
-The '''Vellocet SDK''' is the shared Unity authoring package for supported Vellocet game content. It contains public contracts, map tools, entity markers, validation, VSig authoring support, and addon export workflows.
+The '''Vellocet SDK''' is the Unity authoring package for Grimwar maps and addon content. It installs the map compiler, entity markers, VSig tools, validation, spatial baking, custom audio support, and the addon exporter.
-== Current Grimwar baseline ==
+== Install the SDK ==
 {| class="wikitable"
-! Component !! Version
+! Tab !! Use it for
 |-
-| Vellocet SDK || 1.0.3
+| Project || Link or sync the installed SDK content and manage VSig editor support.
 |-
-| Unity || 6000.3.17f1
+| Map || Create or prepare a scene, run map bakes, and inspect map state.
 |-
-| Content schema || 3
+| Entities || Find, place, and manage entity markers in loaded scenes.
 |}
-These values must be generated from the released package before the SDK is distributed publicly; development branches can move ahead of the public release.
+The Workbench quick actions can create a map, prepare the active scene, or open the Map Exporter. Preparing a scene adds the map contract and enables Probe Volumes when the current Unity project supports them.
-== Major tool areas ==
+== Before exporting content ==
-* SDK workbench and content linking
+* Save the scene and every referenced asset.
-* Map creation, validation, compilation, and export
+* Keep custom files below <code>Assets/CustomContent</code>.
-* Entity placement and signal contracts
+* Resolve every entity and VSig diagnostic.
-* VSig language support and metadata
+* Use a stable addon ID, map ID, and VMod ID. Do not recycle an ID for unrelated content.
-* Navigation and spatial-data baking
+* Export a Development package for local iteration.
-* Addon manifests, dependencies, identity, and validation
+* Export a Release package for distribution. Release map packages always build Windows client, macOS client, and Linux dedicated-server artifacts and require complete lighting and spatial bakes.
-[[Category:Vellocet SDK]]
+[[Category:Vellocet SDK]] [[Category:Grimwar]]

Grimwar/Dedicated servers

DocumentationBot — Tue, 25 Aug 2026 05:13:13 GMT

Publish SDK documentation

Show changes

Grimwar/Steam Workshop addons

DocumentationBot — Tue, 25 Aug 2026 05:13:11 GMT

Publish SDK documentation

@@ Line 1: / Line 1: @@
 {{GameNav}}
-{{Draft}}
+{{Notice|title=Current publishing boundary|Grimwar Workshop publishing accepts non-empty, map-only Release packages. A package containing VMods or another addon content kind cannot be published through this workflow.}}
-Maps and server mods use one addon package, catalogue, enable state, conflict-resolution model, and distribution pipeline. An addon can contain maps, server mods, or both.
+Steam Workshop is one source in Grimwar's addon catalog. The same package can be tested locally, published, subscribed to, selected, validated, and loaded without a separate Workshop format.
-== Author workflow ==
+== Prepare the map package ==
-# Produce a release export with the Vellocet SDK.
+# Finish local testing with a Development package.
-# Resolve every validation error before publication.
+# Open '''Tools > Vellocet > SDK > Map Exporter'''.
-# Supply a title, description, preview image, content tags, and visibility.
+# Select '''Release'''. Release builds Windows client, macOS client, and Linux dedicated-server artifacts and requires complete lighting and spatial bakes.
-# Create or update the Workshop item through the supported publishing tools.
+# Assign '''Map Image (in-game)''' for the map browser.
-# Accept the Steam Workshop legal agreement when Steam requests it.
+# Assign separate '''Addon Thumbnail (Workshop)''' artwork. It must be a decodable 1920 x 1080 PNG or JPEG.
-# Test subscribe, update, disable, unsubscribe, and clean-account installation paths.
+# Build the Release package and resolve every validator error.
-== Multiplayer delivery ==
+The exporter places the Workshop image at the addon root and records it as <code>addonThumbnail</code>. A map's <code>map.thumbnail</code> is separate and does not satisfy the Workshop requirement.
-Servers advertise the required addon identity and exact build. Clients must install and validate the matching package before completing the join flow. Server-only addon content is not delivered to clients unless the package also contains content required by the active session.
+Do not modify a Release folder after export. Grimwar validates the manifest, schema, compilation receipt, build ID, file paths, sizes, SHA-256 hashes, and platform payload before upload and again before mounting.
 [[Category:Grimwar]] [[Category:Steam Workshop]]

Grimwar/Server-side modding

DocumentationBot — Tue, 25 Aug 2026 05:13:10 GMT

Publish SDK documentation

← Older revision		Revision as of 01:13, 25 August 2026
Line 1:		Line 1:
	~~{{GameNav}}~~		#REDIRECT [[Grimwar/VMod]]
	~~{{Draft}}~~

	Grimwar server mods are C# source packages compiled at runtime and executed through an interpreter while the player and dedicated-server builds remain IL2CPP. Mods receive the stable <code>Grimwar.ModApi</code> capability surface rather than direct access to Unity, networking, the filesystem, reflection, or process APIs.

	~~== Package pipeline ==~~

	~~<syntaxhighlight lang="text">~~
	~~addon.json + mod.json + C~~# ~~sources~~
	~~-> package and API-version validation~~
	~~-> capability and syntax validation~~
	~~-> compile against Grimwar.ModApi~~
	~~-> isolated interpreted execution~~
	~~-> scoped commands, events, timers, effects, storage, and VSig~~
	~~</syntaxhighlight>~~

	~~== Core services ==~~

	The mod context provides bounded services for logging, commands, player snapshots, messages, menus, gameplay effects, administration, game modes, events, timers, time, randomness, persistent storage, VSig, and mod inspection.

	~~== Minimal structure ==~~

	Every mod declares a stable ID, version, API version, entry point, source files, dependencies, permissions, kind, and server-only execution flag in <code>mod.json</code>. Its entry class implements <code>IMod</code> and registers callbacks during <code>OnLoad</code>.

	~~The complete API reference and copy-ready examples will be generated from the public Mod API source after its documentation contract is finalized.~~

	[[~~Category:~~Grimwar~~]] [[Category:Server modding~~]]

Grimwar/Server-side C

DocumentationBot — Tue, 25 Aug 2026 05:13:09 GMT

Publish SDK documentation

New page

#REDIRECT [[Grimwar/VMod]]

Grimwar/Addons

DocumentationBot — Tue, 25 Aug 2026 05:13:08 GMT

Publish SDK documentation

New page

{{GameNav}}
{{Notice|title=Version target|These instructions cover addon schema 9 and the Grimwar addon catalog shipped with Vellocet SDK 1.0.3.}}

An '''addon''' is the folder Grimwar discovers, validates, enables, and mounts. Maps, VMods, and addon-owned audio all use this package boundary. Do not install a loose scene, asset bundle, <code>.csx</code> file, or <code>mod.json</code> by itself.

== Package layout ==

Every addon starts with <code>addon.json</code>:

<syntaxhighlight lang="text">
community.example/
addon.json
maps/
as_example/
compile-receipt.json
StandaloneWindows64/
StandaloneOSX/
StandaloneLinux64/
mod.json
ExampleMod.csx
audio/
</syntaxhighlight>

The manifest's <code>contents</code> array declares each map, VMod, or other supported content entry. A mixed package can contain a map and the VMod that supplies its game mode. The complete folder remains one install and update unit.

Use the SDK exporter to produce map packages. For VMods, follow [[Grimwar/VMod#What a VMod package contains|the VMod manifest format]]. Keep addon IDs stable between releases; a changed ID is a different addon rather than an update.

== Use the Addons screen ==

Open '''Addons''' from Grimwar's main menu. The library combines every discovered source and reports whether each candidate is installed, valid, enabled, current, or in conflict.

The available actions depend on the source and package:

{| class="wikitable"
! Action !! Result
|-
| '''Enable''' / '''Disable''' || Changes whether the selected addon may be mounted.
|-
| '''Use This Copy''' || Selects this physical copy when several sources provide the same addon ID.
|-
| '''Open Folder''' || Opens the install location for a disk-backed package.
|-
| '''View on Steam''' || Opens the selected Workshop item.
|-
| '''Download/Update''' || Requests the current Workshop build from Steam.
|-
| '''Unsubscribe''' || Removes the Steam subscription. Steam controls final file removal.
|-
| '''Publish / Update''' || Publishes an eligible local map-only Release package.
|}

An invalid, incomplete, unavailable, or currently downloading candidate cannot be enabled or selected.

== Sources and conflicts ==

Grimwar groups physical copies by the <code>id</code> in <code>addon.json</code>. Initial source priority is:

{| class="wikitable"
! Priority !! Source !! Notes
|-
| 300 || SDK overlay || Read-only folder supplied with <code>--addon-root</code> or <code>GRIMWAR_ADDON_ROOT</code>.
|-
| 200 || Steam Workshop || Steam-managed client install.
|-
| 200 || Dedicated-server Workshop || Steam-managed or operator-staged server copy with a Workshop identity.
|-
| 100 || Manual or FastDL || Writable addon library below the active Grimwar data root.
|}

'''Use This Copy''' overrides that priority and stores the selection in <code>state/addons.json</code>. Only one valid copy of an addon ID is mounted. Built-in maps cannot be replaced by an addon, and a duplicate map ID that collides with built-in or already mounted content is rejected.

If an edited local package appears to have no effect, check the Addons screen for another selected copy with the same ID.

== Test an authored map ==

# Export a Development package from the SDK Map Exporter.
# Put the package below Grimwar's addon directory, or start Grimwar with <code>--addon-root <absolute-export-folder></code>.
# Open '''Addons''', confirm the package is valid and enabled, and select '''Use This Copy''' when necessary.
# Open '''Host'''. Entering or returning to the Host tab rescans addon folders.
# Select the map. If it has no guest download source, Grimwar sets Access to '''Local''' and changes the action to '''Test Map'''.
# Start the map and test the compiled package, not only the Unity authoring scene.

Local test mode admits only the listen host. It creates no public listing or join string, disables invites, and rejects remote connections. This allows an unpublished map to run without pretending that clients can download it.

== Install a Workshop map ==

# Launch Grimwar through Steam.
# Open '''Addons''' and choose '''Browse Steam Workshop''', or open [https://steamcommunity.com/app/4219460/workshop/ Grimwar Workshop].
# Subscribe to the map.
# Return to the Addons screen and wait for Steam's download and installation to finish.
# Enable the package if it is disabled.
# Open '''Host''' or join a server that requires the same Workshop build.

Steam owns subscribed files and their updates. Grimwar validates and mounts Steam's installed folder directly. An installed item can remain visible from the local cache while Steam is offline, but subscription, update, and Workshop enable-state changes require Steam online.

When joining a server, Grimwar downloads only the addon that owns the active map plus any session-wide requirements. Login completes only after every advertised package has the required addon ID and exact build ID and passes Release validation.

== Install a VMod on a server ==

# Run <code>vmod_runtime_paths</code> from authenticated server console or RCON.
# Copy the complete folder containing <code>addon.json</code> into the printed <code><data>/addons</code> root.
# Restart the process, or run <code>vmod_runtime_reload</code> while no scripted game mode is active.
# Run <code>vmod_runtime_list</code> and check that the VMod loaded without a compiler, capability, or dependency error.

VMod-only packages are not currently publishable through Grimwar Workshop. Use manual installation or the SDK overlay. See [[Grimwar/VMod#Install and test a VMod|Install and test a VMod]].

== Dedicated-server addon files ==

The first server launch creates its operator-owned layout without replacing existing files. Relevant paths below the active data root are:

{| class="wikitable"
! Path !! Purpose
|-
| <code>addons/<addon-id>/</code> || Manual and FastDL-installed packages.
|-
| <code>config/server-addons.json</code> || Workshop item IDs, manual Workshop bindings, collections, and the optional depot override.
|-
| <code>config/rotation.json</code> || Whitelist or blacklist of map IDs and optional game modes.
|-
| <code>state/addons.json</code> || Enabled candidates and explicit source selections.
|-
| <code>cache/steam-workshop-server/</code> || Steam-managed dedicated-server Workshop installs.
|}

Use [[Grimwar/Dedicated servers#Install Workshop maps|Dedicated servers]] for <code>server-addons.json</code>, manual bindings, and rotation examples.

== Fix a package that does not load ==

Check these in order:

# The selected directory itself contains <code>addon.json</code>; it is not one level above or below it.
# The package is complete and has not been copied while an export or Steam download is still running.
# The Addons screen marks the candidate valid and enabled.
# '''Use This Copy''' points to the build you intend to test.
# The addon and content IDs do not collide with another installed package or built-in map.
# The package was rebuilt with the current schema and contains the platform artifact needed by this process.
# For a Release package, every declared file, size, SHA-256 hash, path, and compilation receipt is unchanged.

The validator also rejects absolute or escaping paths, symbolic links or reparse points, unsupported file types, more than 8,192 files, and packages larger than 20 GiB.

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

Grimwar/VMod

DocumentationBot — Tue, 25 Aug 2026 05:13:03 GMT

Publish SDK documentation

New page

{{GameNav}}
{{Notice|title=Version target|This guide covers VMod API 5 and addon schema 9. A server rejects packages built for another API or schema.}}

'''VMod''' is Grimwar's server-authoritative C# mod runtime. The server compiles source with Roslyn C# 2.0 and runs the result through dotnow. Grimwar itself remains an IL2CPP build.

A VMod can use the public <code>Grimwar.ModApi</code> services. It cannot reference Unity, FishNet, Grimwar internals, arbitrary files, sockets, reflection, processes, or native code.

== What a VMod package contains ==

The addon folder is the install unit.

<syntaxhighlight lang="text">
community.hello/
addon.json
mod.json
HelloMod.csx
</syntaxhighlight>

Use <code>.csx</code> below a Unity project's <code>Assets</code> folder so the editor recognizes C# without asking Unity to compile the file. A VMod kept outside Unity can use <code>.cs</code>.

<code>addon.json</code> registers the folder with Grimwar's addon catalog:

<syntaxhighlight lang="json">
{
"schemaVersion": 9,
"id": "community.hello",
"title": "Hello Server",
"author": "Ada",
"version": "1.0.0",
"distributionProfile": "development",
"buildId": "0123456789abcdef0123456789abcdef",
"createdUtc": "2026-08-25T00:00:00Z",
"sdkVersion": "1.0.3",
"unityVersion": "6000.3.17f1",
"requires": [],
"contents": [
{
"kind": "mods",
"id": "community.hello",
"title": "Hello Server",
"mod": { "manifest": "mod.json" }
}
]
}
</syntaxhighlight>

The addon ID, content ID, and VMod ID must resolve to the same normalized ID. <code>requires</code> contains addon IDs. Grimwar enables and loads required addons before the package that names them.

<code>mod.json</code> defines the code entry point:

<syntaxhighlight lang="json">
{
"id": "community.hello",
"name": "Hello Server",
"version": "1.0.0",
"apiVersion": 5,
"kind": "addon",
"entryPoint": "CommunityMods.HelloMod",
"sourceFiles": ["HelloMod.csx"],
"dependencies": [],
"permissions": [],
"enabled": true,
"serverOnly": true
}
</syntaxhighlight>

{| class="wikitable"
! Field !! Rule
|-
| <code>id</code> || Stable ID up to 96 characters. Use lowercase letters, digits, dots, underscores, and hyphens.
|-
| <code>apiVersion</code> || Must equal the server's current VMod API, currently <code>5</code>.
|-
| <code>kind</code> || <code>addon</code>, <code>admin</code>, or <code>gameMode</code>. Administrative host operations require <code>admin</code>.
|-
| <code>entryPoint</code> || Fully qualified, non-abstract class implementing <code>IMod</code>.
|-
| <code>sourceFiles</code> || Relative <code>.cs</code> or <code>.csx</code> paths contained by this addon.
|-
| <code>dependencies</code> || VMod IDs that must load first.
|-
| <code>permissions</code> || Permission names the VMod may attach to its commands and menu items. This does not grant those permissions to players.
|-
| <code>serverOnly</code> || Must be <code>true</code> in API 5.
|}

== Write the entry class ==

This mod registers <code>hello</code> for chat and authenticated consoles:

<syntaxhighlight lang="csharp">
using System;
using Grimwar.ModApi;

namespace CommunityMods
{
public sealed class HelloMod : IMod
{
private IModContext _context;

public void OnLoad(IModContext context)
{
_context = context;
var result = context.Commands.Register(new ModCommandSpec
{
Name = "hello",
Description = "Say hello to the server.",
MinimumArguments = 0,
MaximumArguments = 0,
AllowChat = true,
AllowConsole = true,
ChatAliases = new[] { "hi" }
}, "OnHello");

if (!result.Success)
throw new InvalidOperationException(result.Message);

context.Log.Write("Hello Server loaded.");
}

public void OnUnload()
{
_context = null;
}

public void OnHello(IModCommandInvocation command)
{
var name = command.Caller == null
? "server console"
: command.Caller.DisplayName;
_context.Messages.Broadcast("Hello from " + name + "!");
}
}
}
</syntaxhighlight>

Registrations take a method name because delegates do not cross the interpreter boundary. Grimwar verifies the method before accepting the registration.

{| class="wikitable"
! Registration !! Handler signature
|-
| Command || One <code>IModCommandInvocation</code> parameter
|-
| Event || One <code>ModEvent</code> parameter
|-
| Timer || One <code>ModTimerInvocation</code> parameter
|-
| VSig subscription || One <code>ModVSigEvent</code> parameter
|-
| Menu || One <code>ModMenuInvocation</code> parameter
|}

<code>OnUnload</code> must clear references and release any VMod-owned state that is not already scoped through the host. Commands, event subscriptions, timers, effects, and dynamic modes are removed when the package unloads.

== Public API services ==

<code>IModContext</code> supplies the following services:

{| class="wikitable"
! Service !! Use
|-
| <code>Log</code> || Namespaced server log messages.
|-
| <code>Commands</code> || Chat, local console, server console, and RCON commands with aliases, argument limits, and permissions.
|-
| <code>Players</code> || Immutable player snapshots and selectors such as exact name, unique partial name, Steam ID, client ID, <code>@me</code>, and <code>@random</code>.
|-
| <code>Messages</code> || Broadcast or private chat, escaped colored segments, and major or minor HUD messages.
|-
| <code>Menus</code> || Server-owned numeric menus and shared VMod Admin entries.
|-
| <code>Effects</code> || Health, damage, slap, slay, timed damage or movement multipliers, weapon restrictions, and screen shake.
|-
| <code>Audio</code> || Play addon-owned audio globally, for one player, or at a world position.
|-
| <code>Admin</code> || Permission checks, immunity-aware targeting, kick, ban, and unban for <code>admin</code> packages.
|-
| <code>GameMode</code> || Read mode state. The active <code>gameMode</code> package can change teams, respawn players, and end rounds or matches.
|-
| <code>Events</code> || Player, combat, round, match, and mode-change subscriptions.
|-
| <code>Scheduler</code> || One-shot and repeating callbacks.
|-
| <code>Clock</code> and <code>Random</code> || Monotonic or Unix time and a per-VMod random source.
|-
| <code>Storage</code> || Sandboxed typed key/value data under the VMod's state directory.
|-
| <code>VSig</code> || Emit or subscribe to bounded VSig signals.
|-
| <code>Mods</code> || Inspect loaded packages. Administrative VMods can request reloads.
|}

<code>ModPlayer</code> and other API objects are snapshots. Keep the stable player ID and call <code>Players.Find</code> again when current state matters.

== Events and timers ==

<syntaxhighlight lang="csharp">
public void OnLoad(IModContext context)
{
_context = context;

var subscription = context.Events.Subscribe(
ModEventKind.PlayerSpawned,
"OnPlayerSpawned");
if (!subscription.Success)
throw new InvalidOperationException(subscription.Message);

context.Scheduler.Once(5f, "OnTimer", "startup");
}

public void OnPlayerSpawned(ModEvent value)
{
if (value.Player != null)
_context.Messages.Tell(value.Player.Id, "Welcome back.");
}

public void OnTimer(ModTimerInvocation value)
{
_context.Log.Write(value.TimerId + " fired with state " + value.State);
}
</syntaxhighlight>

Combat events put the victim in <code>Player</code> and a connected attacker or killer in <code>OtherPlayer</code>. Read <code>Amount</code>, <code>HealthAfter</code>, <code>WeaponId</code>, <code>AbilityId</code>, <code>WasHeadshot</code>, <code>WasCritical</code>, and <code>WasSuicide</code> for scalar event data.

Timers have a 50 ms minimum interval, a 24-hour maximum delay, and a limit of 256 timers per VMod. Cancel repeating timers when their owning activity ends.

== Permissions ==

A permission on <code>ModCommandSpec.Permission</code> must also appear in <code>mod.json</code>. The manifest declaration allows the VMod to ask for the permission; server admin configuration decides who has it.

VMod Admin reads groups and users from <code><data>/config/mods</code>. A wildcard such as <code>admin.*</code> grants one namespace. A leading minus sign is an explicit deny and wins over grants. Immunity prevents one administrator from targeting another administrator with the same or higher value.

Do not put an RCON password or another secret in VMod source, manifests, or addon configuration.

== Send signals to VSig ==

Every VMod owns a source alias named <code>mod:<mod-id></code>.

<syntaxhighlight lang="csharp">
_context.VSig.Emit("round_started", _context.GameMode.ActiveId);
_context.VSig.EmitFrom(
"mod:community.hello.stage",
"opened",
3,
"sewer_gate");
</syntaxhighlight>

A custom source must be the owned alias or a child below it. Payloads can contain at most eight null, string, Boolean, or numeric values. Send a 64-bit identifier such as a Steam ID as a string.

A VMod can subscribe to a map signal:

<syntaxhighlight lang="csharp">
context.VSig.Subscribe("escape_trigger", "on_executed", "OnEscape");

public void OnEscape(ModVSigEvent value)
{
_context.Log.Write(value.SourceAlias + "." + value.OutputName);
}
</syntaxhighlight>

See [[Grimwar/VSig#Signals shared with VMod|Signals shared with VMod]] for the map side.

== Supported C# subset ==

VMods can use ordinary control flow, classes, structs, enums, arrays, strings, <code>StringBuilder</code>, and approved <code>System.Collections</code> and <code>System.Collections.Generic</code> shapes.

The validator rejects file and network I/O, reflection, processes, console or environment access, threads, tasks, Unity or Grimwar internals, native interop, unsafe code, <code>typeof</code>, async methods, iterators, lambdas, LINQ queries, <code>try</code>/<code>catch</code>/<code>finally</code>, <code>using</code>, <code>lock</code>, <code>foreach</code>, precompiled DLLs, and extra assembly references. Use indexed <code>for</code> loops and explicit cleanup.

Compilation alone does not guarantee that an arbitrary generic combination exists in the IL2CPP host. Start with arrays, <code>List<T></code>, <code>Dictionary<string, T></code>, and <code>HashSet<string></code> using types present in the public API and bundled examples.

== Install and test a VMod ==

# Run <code>vmod_runtime_paths</code> through an authenticated server console or RCON session. Use the printed addon path instead of guessing a platform-specific data directory.
# Copy the complete addon folder into <code><data>/addons</code>.
# Restart the server, or run <code>vmod_runtime_reload</code> while no scripted game mode is active.
# Run <code>vmod_runtime_list</code> and confirm the package is loaded and not faulted.
# Exercise every chat and console alias with empty, quoted, invalid, and maximum-length arguments.
# Run the test again with a non-admin player when the VMod declares permissions.
# Reload it more than once and check that handlers, timers, commands, and effects do not duplicate.

Useful server commands:

{| class="wikitable"
! Command !! Result
|-
| <code>vmod_runtime_list</code> || Lists loaded and faulted VMods.
|-
| <code>vmod_runtime_reload</code> || Refreshes addons and permissions, recompiles changed source, and reloads in dependency order.
|-
| <code>vmod_runtime_reload_admins</code> || Reloads admin groups and users without unloading VMods.
|-
| <code>vmod_runtime_paths</code> || Prints addon, config, state, and compiler-cache roots.
|-
| <code>sv_vmod_enabled 0</code> || Disables the VMod runtime at startup.
|}

The server refuses <code>vmod_runtime_reload</code> while a scripted game mode is active. Change to a native mode first.

== Distribution rules ==

VMod-only packages are currently installed manually or through the development overlay. Steam Workshop publishing accepts map-only Release packages and rejects packages that contain VMods. Server-only VMod source is not installed on remote players.

Use <code>--addon-root <absolute-folder></code> or <code>GRIMWAR_ADDON_ROOT</code> during development to load a package directly. For ordinary installation, copy the complete folder containing <code>addon.json</code>; a loose <code>.csx</code> file is never an installable VMod.

Bundled examples are available in Grimwar's <code>StreamingAssets/Grimwar/Addons</code> source tree. <code>grimwar.rtd</code> is the smallest command and effect example. <code>grimwar.admin</code> covers permissions and menus. <code>grimwar.zombie_mod</code> is a scripted mode. <code>grimwar.quake_sounds</code> combines server logic with addon-owned audio.

[[Category:Grimwar]] [[Category:VMod]] [[Category:Server modding]]

Grimwar/VSig

DocumentationBot — Tue, 25 Aug 2026 05:12:57 GMT

Publish SDK documentation

New page

{{GameNav}}
{{Notice|title=Version target|This guide covers the VSig compiler and standard library included with Vellocet SDK 1.0.3.}}

'''VSig''' is Grimwar's map-logic language. A VSig program listens to entity or game outputs, changes state, calls entity inputs, schedules work, and exchanges bounded signals with VMods. The Map Exporter validates and compiles it into the map package.

Use VSig for map orchestration. Use an entity marker when the thing has a position, volume, renderer, collider, or native game behavior. Use [[Grimwar/VMod|VMod]] for server rules that need players, commands, persistent storage, permissions, or game-mode control.

== Create the map script ==

A map scene and its VSig source share a name and folder:

<syntaxhighlight lang="text">
Assets/CustomContent/Maps/Range/Range.unity
Assets/CustomContent/Maps/Range/Range.vsig
</syntaxhighlight>

Create a script with '''Assets > Create > Vellocet > SDK > VSig Script'''. A marker Inspector can also create or open the current scene's file and insert refs for selected entities.

Install syntax support from '''SDK Workbench > Project > VSig Editor Support'''. Unity still performs the authoritative parse and validation.

== First working script ==

<syntaxhighlight lang="text">
scene "Example"

ref trigger: trigger_multiple match Triggers/Entrance
ref door: func_door match Doors/MainDoor

var door_start: DoorEntityState = null

once on map.ready:
door_start = door.state

on trigger.start_touch:
door.open

on trigger.end_touch_all:
door.restore(door_start)
</syntaxhighlight>

The two <code>ref</code> declarations bind authored markers to short aliases. <code>map.ready</code> runs after server-side map entities are bound. The trigger's <code>start_touch</code> output calls the door's <code>open</code> input. The script captures the starting door state once and restores it after the last toucher leaves.

Marker Inspectors list the inputs, outputs, state type, and access rules for that entity class. Use that contract instead of guessing a signal name.

== 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 GameObject names make refs readable and keep wildcard matches predictable. A marker's hidden runtime ID is managed by the SDK; VSig authoring uses the object hierarchy and entity class.

== 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 include arithmetic, comparisons, <code>and</code>, <code>or</code>, and <code>not</code>. Built-in functions include:

* <code>min</code>, <code>max</code>, <code>clamp</code>, <code>abs</code>, <code>floor</code>, <code>ceil</code>, and <code>round</code>
* <code>lerp</code> and <code>remap</code>
* <code>random</code>, <code>random_int</code>, <code>shuffle</code>, and <code>choose</code>
* <code>time</code>, <code>format</code>, and <code>convar</code>
* <code>bool</code>, <code>int</code>, <code>float</code>, and <code>string</code> conversions

Without <code>seed</code>, each map runtime starts with fresh random entropy. A declared seed makes random sequences repeatable. <code>shuffle(self, count)</code> gives each module instance its own shuffle bag.

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

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

<code>wait</code> suspends the current handler or procedure. <code>schedule name after duration</code> runs once. <code>schedule name every duration</code> repeats, and <code>times</code> limits the count. Starting a named schedule replaces the existing task with that name. Cancelling a task that is not running is safe.

Cancel round-owned repeating work on <code>round.post_round</code> or another lifecycle event that always closes the activity.

== Reusable modules ==

A module contains parameters, private state, inputs, outputs, procedures, and handlers:

<syntaxhighlight lang="text">
module 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 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 and can be inspected 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:

<syntaxhighlight lang="text">
from "Packages/com.vellocet.sdk/Runtime/VSig/Libraries/Logic.vsiglib" use counter
use counter as captures(max_value = 5)
</syntaxhighlight>

The standard logic library contains <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>.

These modules are compiled logic. They do not create GameObjects or network objects.

== 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 designer should choose a module and its arguments in the scene Inspector. Select the <code>.vsiglib</code>, module name, alias, arguments, and local-ref binding mode. The compiler expands the marker into the same form as a source-authored <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.enable

on round.pre_round:
round_timer.reset

on round.live:
round_timer.start

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. Any changed console variable is restored 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.

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

Press Play for quick testing. The compiled VSig runtime Inspector shows validation state, live module state, scheduled tasks, and a bounded recent-event trace. Marker Inspectors can show signal routes and add selected refs or a group to the paired script.

Before export:

# Save the scene and VSig file.
# Resolve parser, type, ref, module, and entity-contract diagnostics.
# Check wildcard refs against the final hierarchy.
# Exercise each round-phase handler more than once.
# Confirm repeating schedules stop at the intended lifecycle boundary.
# Run '''Compile Scene''' in the Map Exporter before building the addon package.

The exporter expands imported modules, validates the final program, and embeds a compact compiled program in the map. A Release export refuses incomplete required bakes or invalid VSig.

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

Grimwar/Mapping

DocumentationBot — Tue, 25 Aug 2026 05:12:55 GMT

Publish SDK documentation

Show changes

Grimwar/Getting started

DocumentationBot — Tue, 25 Aug 2026 05:12:54 GMT

Publish SDK documentation

@@ Line 1: / Line 1: @@
 {{GameNav}}
-{{Draft}}
+{{Notice|title=Version target|Use Vellocet SDK 1.0.3 with Unity 6000.3.17f1. Current packages use addon schema 9 and VMod API 5.}}
-Choose the track that matches what you want to build.
+Start with the result you want:
-== Maps and content ==
+{| class="wikitable"
-# Install the [[Vellocet SDK]] in the supported Unity editor version.
+== Install the authoring tools ==
-== Server-side gameplay ==
+# Install the current Vellocet SDK with the VSDK app.
-# Read the [[Grimwar/Server-side modding|server mod overview]].
+See [[Vellocet SDK#Install the SDK|Install the SDK]] for project paths, content sync, and editor support.
-== Server administration ==
+== Build and test a first map ==
-Start with [[Grimwar/Dedicated servers]] for installation, configuration, addon acquisition, map rotation, and diagnostics.
+# In SDK Workbench, select '''Create New Map...''' and save it below <code>Assets/CustomContent/Maps</code>.
 [[Category:Grimwar]] [[Category:Getting started]]

Grimwar

DocumentationBot — Tue, 25 Aug 2026 05:12:53 GMT

Publish SDK documentation

← Older revision		Revision as of 01:12, 25 August 2026
Line 3:		Line 3:
	<div class="vellocet-eyebrow">GRIMWAR DEVELOPER PORTAL</div>		<div class="vellocet-eyebrow">GRIMWAR DEVELOPER PORTAL</div>

	Grimwar ~~supports community-created maps~~, Workshop ~~addons~~, dedicated servers~~, and bounded server-side C# gameplay mods. This portal collects the supported authoring workflows and versioned technical reference~~.		These guides cover the public Grimwar content toolchain: Unity map authoring, VSig map logic, VMod server scripting, addon installation, Steam Workshop maps, and community dedicated servers.

	== Start here ==		== Start here ==
Line 14:		Line 14:
	\| Build a map \|\| [[Grimwar/Mapping]]		\| Build a map \|\| [[Grimwar/Mapping]]
	\|-		\|-
	\| ~~Write server gameplay~~ \|\| [[Grimwar/~~Server-side modding\|Server-side C# modding~~]]		\| Script map logic \|\| [[Grimwar/VSig]]
	\|-		\|-
	\| Publish ~~or install an addon~~ \|\| [[Grimwar/Steam Workshop addons]]		\| Write server gameplay \|\| [[Grimwar/VMod\|VMod C# scripting]]
			\|-
			\| Install or select a package \|\| [[Grimwar/Addons\|Using addons]]
			\|-
			\| Publish a map \|\| [[Grimwar/Steam Workshop addons\|Steam Workshop publishing]]
	\|-		\|-
	\| Operate a community server \|\| [[Grimwar/Dedicated servers]]		\| Operate a community server \|\| [[Grimwar/Dedicated servers]]
	\|}		\|}

	== ~~Reference areas~~ ==		== Current version boundary ==

	* Mod API types, services, events, and version compatibility		{\| class="wikitable"
	* Map entities, inputs, outputs, and placement requirements		! Component !! Version
	* VSig syntax, standard library, lifecycle, and signals		\|-
	* Addon ~~and mod manifest schemas~~		\| Vellocet SDK \|\| 1.0.3
	* Server commands, configuration, paths, and diagnostics		\|-
			\| Unity editor \|\| 6000.3.17f1
			\|-
			\| SDK content schema \|\| 3
			\|-
			\| Addon schema \|\| 9
			\|-
			\| VMod API \|\| 5
			\|}

	~~Reference pages will~~ be ~~generated from~~ the ~~public~~ SDK ~~and protected from~~ manual ~~edits. Guides and examples remain collaborative~~.		Packages built for an older rejected schema or a different VMod API must be rebuilt against the current SDK. Steam Workshop publishing currently accepts map-only Release packages; VMod packages use manual installation or the development overlay.

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

Main Page

WikiAdmin — Tue, 25 Aug 2026 04:29:33 GMT

Deploy Vellocet visual system

← Older revision		Revision as of 00:29, 25 August 2026
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	<div class="vellocet-hero">		<div class="vellocet-hero">
			<div class="vellocet-hero__rail"><span>PUBLIC BUILD</span><span>DOCS / 2026</span></div>
	<div class="vellocet-eyebrow">VELLOCET DEVELOPER COMMUNITY</div>		<div class="vellocet-eyebrow">VELLOCET DEVELOPER COMMUNITY</div>
	<div class="vellocet-hero__title">Build worlds.<br />Change the rules.</div>		<div class="vellocet-hero__title">Build worlds.<br />Change the rules.</div>
	<p class="vellocet-hero__lede">Official technical documentation for creating maps, server mods, tools, and community content for Vellocet games.</p>		<p class="vellocet-hero__lede">Official technical documentation for creating maps, server mods, tools, and community content for Vellocet games.</p>
	<div class="vellocet-actions">[[Grimwar/Getting started\|Start with Grimwar]] [[Vellocet Developer Community:Community portal\|Join the community]]</div>		<div class="vellocet-actions">[[Grimwar/Getting started\|Start with Grimwar]] [[Vellocet Developer Community:Community portal\|Join the community]]</div>
			<div class="vellocet-hero__meta"><span>Maps</span><span>Server mods</span><span>Workshop</span><span>Tools</span></div>
	</div>		</div>

Line 11:		Line 13:
	<div class="vellocet-card-grid">		<div class="vellocet-card-grid">
	<div class="vellocet-card vellocet-card--grimwar">		<div class="vellocet-card vellocet-card--grimwar">
			<div class="vellocet-card__index">01 / 03</div>
	<div class="vellocet-card__status">IN DEVELOPMENT</div>		<div class="vellocet-card__status">IN DEVELOPMENT</div>
	<h2>Grimwar</h2>		<h2>Grimwar</h2>
Line 16:		Line 19:
	<div class="vellocet-card__links">[[Grimwar\|Open developer portal →]]</div>		<div class="vellocet-card__links">[[Grimwar\|Open developer portal →]]</div>
	</div>		</div>
	<div class="vellocet-card">		<div class="vellocet-card vellocet-card--aneurism">
			<div class="vellocet-card__index">02 / 03</div>
	<div class="vellocet-card__status">DOCUMENTATION INDEX</div>		<div class="vellocet-card__status">DOCUMENTATION INDEX</div>
	<h2>ANEURISM IV</h2>		<h2>ANEURISM IV</h2>
Line 23:		Line 27:
	</div>		</div>
	<div class="vellocet-card vellocet-card--muted">		<div class="vellocet-card vellocet-card--muted">
			<div class="vellocet-card__index">03 / 03</div>
	<div class="vellocet-card__status">FUTURE RELEASES</div>		<div class="vellocet-card__status">FUTURE RELEASES</div>
	<h2>Upcoming games</h2>		<h2>Upcoming games</h2>
Line 33:		Line 38:

	<div class="vellocet-resource-grid">		<div class="vellocet-resource-grid">
	<div><h3>[[Vellocet SDK]]</h3><p>Install the Unity package, create content, validate it, and export release-ready addons.</p></div>		<div><div class="vellocet-resource__index">01 / SDK</div><h3>[[Vellocet SDK]]</h3><p>Install the Unity package, create content, validate it, and export release-ready addons.</p></div>
	<div><h3>[[Grimwar/Mapping\|Mapping]]</h3><p>Author maps with entities, signals, lighting, navigation, and spatial data.</p></div>		<div><div class="vellocet-resource__index">02 / WORLD</div><h3>[[Grimwar/Mapping\|Mapping]]</h3><p>Author maps with entities, signals, lighting, navigation, and spatial data.</p></div>
	<div><h3>[[Grimwar/Server-side modding\|Server mods]]</h3><p>Build bounded C# gameplay extensions against the stable Grimwar Mod API.</p></div>		<div><div class="vellocet-resource__index">03 / CODE</div><h3>[[Grimwar/Server-side modding\|Server mods]]</h3><p>Build bounded C# gameplay extensions against the stable Grimwar Mod API.</p></div>
	<div><h3>[[Grimwar/Steam Workshop addons\|Workshop]]</h3><p>Package, validate, publish, install, and troubleshoot community content.</p></div>		<div><div class="vellocet-resource__index">04 / SHIP</div><h3>[[Grimwar/Steam Workshop addons\|Workshop]]</h3><p>Package, validate, publish, install, and troubleshoot community content.</p></div>
	</div>		</div>

	<div class="vellocet-section-heading"><span>03</span><h2>Contribute</h2></div>		<div class="vellocet-section-heading"><span>03</span><h2>Contribute</h2></div>

	This wiki combines official, generated reference material with community-authored guides. Read the [[Vellocet Developer Community:Content policy\|content policy]], browse [[Special:RecentChanges\|recent changes]], or visit the [[Vellocet Developer Community:Community portal\|community portal]].		<div class="vellocet-contribute">
			<div class="vellocet-contribute__label">Documentation is part of the toolchain.</div>
			<div class="vellocet-contribute__body">This wiki combines official, generated reference material with community-authored guides. Read the [[Vellocet Developer Community:Content policy\|content policy]], browse [[Special:RecentChanges\|recent changes]], or visit the [[Vellocet Developer Community:Community portal\|community portal]].</div>
			</div>

MediaWiki:Common.css

WikiAdmin — Tue, 25 Aug 2026 04:29:32 GMT

Deploy Vellocet visual system

Show changes

ANEURISM IV

WikiAdmin — Tue, 25 Aug 2026 00:33:13 GMT