Jump to content

Main Page: Difference between revisions

From Vellocet Developer Community
Deploy Vellocet visual system
Deploy Vellocet visual system
 
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>

Latest revision as of 01:34, 25 August 2026

Developer documentation

This wiki documents Grimwar maps, VSig scripts, VMods, addons, Steam Workshop publishing, and dedicated servers.

Grimwar

Getting started

Install the tools and export a test map.

Vellocet SDK

Set up SDK 1.0.3, sync content, use the Workbench, and export addons.

Map authoring

Build scenes with entities, lighting, navigation, spatial data, and VSig.

VSig scripting

Write map logic, handle events, call entities, and share modules.

VMod scripting

Package server-side C# and use Grimwar Mod API 5.

Using addons

Install packages, enable them, select a source, and resolve conflicts.

Steam Workshop

Publish and update map-only Release packages.

Dedicated servers

Configure servers, Workshop maps, VMods, rotation, and FastDL.

Other games

ANEURISM IV

ANEURISM IV has no public authoring SDK or mod API.

Upcoming games

Vellocet has not published authoring tools for upcoming games.

Versions

Vellocet SDK
1.0.3
Unity
6000.3.17f1
Addon schema
9
VMod API
5