2026-09-26 18:14:36 +02:00
using System ;
using System.Collections.Generic ;
using System.IO ;
using System.Linq ;
using GameCult.Caching ;
using GameCult.Caching.MessagePack ;
using MessagePack ;
2026-09-30 03:06:43 +02:00
// A mod ship's visual package: model, anchors, schematic lines. The hull semantics (cells, hardpoints, stats) live in
// the ship's own HullData record beside this one, and HullData.Visual is the only binding between the two.
2026-09-26 18:14:36 +02:00
[CultDocument("aetheria.ship_authoring", "1"), MessagePackObject]
public sealed class ShipAuthoring
{
[CultName, Key(0)] public string Id ;
2026-09-30 03:06:43 +02:00
// Key 1 held the embedded HullData until S1; it is retired and never reused.
2026-09-26 18:14:36 +02:00
[Key(2)] public string ModelAsset ;
[Key(3)] public List < ShipAnchor > Anchors = new List < ShipAnchor > ( ) ;
[Key(4)] public List < ShipPolyline > SchematicLines = new List < ShipPolyline > ( ) ;
}
[MessagePackObject]
public sealed class ShipAnchor
{
// Stable semantic identity. HullData.Hardpoints[].Transform names this ID for mounts.
[Key(0)] public string Id ;
// One of: map-icon, hull-collider, shield, tractor, thruster-emitter,
// weapon-muzzle, radiator-mesh, or articulation.
[Key(1)] public string Role ;
// Stable node ID in the compiled model, never a Blender display name.
[Key(2)] public string ModelNodeId ;
// Only child roles use ParentId; e.g. a muzzle names its weapon hardpoint.
[Key(3)] public string ParentId ;
[Key(4)] public int Order ;
}
// Evaluated or baked Grease Pencil stroke coordinates in Blender's right-handed Z-up
// space. The runtime renderer owns its coordinate conversion and camera projection.
[MessagePackObject]
public sealed class ShipPolyline
{
[Key(0)] public string Layer ;
[Key(1)] public string Material ;
[Key(2)] public float [ ] Points ;
[Key(3)] public float [ ] Radii ;
[Key(4)] public float [ ] Opacities ;
[Key(5)] public bool Cyclic ;
[Key(6)] public float [ ] Color ;
}
public static class ShipAuthoringStore
{
public static CultCache Open ( string path , bool writable = false )
{
var cache = new CultCache ( ) ;
try
{
2026-09-30 03:06:43 +02:00
cache . AddBackingStore ( new SingleFileMessagePackBackingStore ( path , ! writable ) , new [ ] { typeof ( HullData ) , typeof ( ShipAuthoring ) } ) ;
2026-09-26 18:14:36 +02:00
return cache ;
}
catch
{
cache . Dispose ( ) ;
throw ;
}
}
2026-09-30 03:06:43 +02:00
// Writes one ship's two records under their deterministic keys, the shape Load expects.
public static void Write ( CultCache cache , HullData hull , ShipAuthoring visual )
{
cache . UpsertAsync ( typeof ( HullData ) , hull , ShipModCatalog . HullKey ( visual . Id ) ) . GetAwaiter ( ) . GetResult ( ) ;
cache . UpsertAsync ( typeof ( ShipAuthoring ) , visual , ShipModCatalog . AuthoringKey ( visual . Id ) ) . GetAwaiter ( ) . GetResult ( ) ;
}
// The structure of a ship file, without judging its content (drafts load): exactly one hull and one visual, each at
// its deterministic key, the hull naming that visual by its typed ref.
public static ( HullData Hull , ShipAuthoring Visual ) Load ( string path )
2026-09-26 18:14:36 +02:00
{
using var cache = Open ( path ) ;
2026-09-30 03:06:43 +02:00
var hulls = cache . GetAll < HullData > ( ) . ToArray ( ) ;
var visuals = cache . GetAll < ShipAuthoring > ( ) . ToArray ( ) ;
if ( visuals . Length ! = 1 )
throw new InvalidOperationException ( $"{path} must hold exactly one ship authoring record, found {visuals.Length}." ) ;
if ( hulls . Length ! = 1 )
throw new InvalidOperationException ( $"{path} must hold exactly one hull record, found {hulls.Length}." ) ;
var ( hull , visual ) = ( hulls [ 0 ] , visuals [ 0 ] ) ;
if ( ! cache . TryGetHandle ( hull ) . Value . Key . Equals ( ShipModCatalog . HullKey ( visual . Id ) ) | |
! cache . TryGetHandle ( visual ) . Value . Key . Equals ( ShipModCatalog . AuthoringKey ( visual . Id ) ) )
throw new InvalidOperationException ( $"{path}: {visual.Id}: records must be stored under {ShipModCatalog.HullKey(visual.Id).Value} and {ShipModCatalog.AuthoringKey(visual.Id).Value}." ) ;
return ( hull , visual ) ;
}
public static ( HullData Hull , ShipAuthoring Visual ) Read ( string path )
{
var ( hull , visual ) = Load ( path ) ;
Validate ( hull , visual ) ;
return ( hull , visual ) ;
2026-09-26 18:14:36 +02:00
}
2026-09-30 03:06:43 +02:00
// The one semantic check every path shares: the hull and its visual, judged together.
public static void Validate ( HullData hull , ShipAuthoring ship )
2026-09-26 18:14:36 +02:00
{
if ( ship = = null ) throw new InvalidOperationException ( "Ship authoring record is null." ) ;
if ( string . IsNullOrWhiteSpace ( ship . Id ) ) throw new InvalidOperationException ( "Ship ID is required." ) ;
2026-09-26 18:30:02 +02:00
if ( ! ( ship . Id [ 0 ] > = 'a' & & ship . Id [ 0 ] < = 'z' | | ship . Id [ 0 ] > = '0' & & ship . Id [ 0 ] < = '9' ) | | ship . Id . Any ( c = >
! ( c > = 'a' & & c < = 'z' | | c > = '0' & & c < = '9' | | c = = '.' | | c = = '_' | | c = = '-' ) ) )
throw new InvalidOperationException ( $"{ship.Id}: ship ID must use lower-case ASCII letters, digits, dots, underscores, or hyphens." ) ;
2026-09-30 03:06:43 +02:00
if ( hull = = null ) throw new InvalidOperationException ( $"{ship.Id}: hull data is required." ) ;
2026-09-26 18:14:36 +02:00
if ( string . IsNullOrWhiteSpace ( hull . Name ) ) throw new InvalidOperationException ( $"{ship.Id}: hull name is required." ) ;
2026-09-30 02:14:10 +02:00
if ( hull . Shape ? . Cells = = null | | ! hull . Shape . Cells . Cast < bool > ( ) . Any ( occupied = > occupied ) )
2026-09-26 18:14:36 +02:00
throw new InvalidOperationException ( $"{ship.Id}: schematic must contain at least one cell." ) ;
2026-09-30 03:06:43 +02:00
// A hull names exactly one visual: a Unity prefab (shipped hulls) or a ShipAuthoring record (mod ships).
2026-09-26 18:14:36 +02:00
if ( ! string . IsNullOrEmpty ( hull . Prefab ) )
throw new InvalidOperationException ( $"{ship.Id}: a mod ship cannot name a Unity prefab." ) ;
2026-09-30 03:06:43 +02:00
if ( ! hull . Visual . Key . Equals ( ShipModCatalog . AuthoringKey ( ship . Id ) ) )
throw new InvalidOperationException ( $"{ship.Id}: the hull must name its visual record {ShipModCatalog.AuthoringKey(ship.Id).Value}." ) ;
2026-09-26 18:14:36 +02:00
if ( string . IsNullOrWhiteSpace ( ship . ModelAsset ) | | Path . IsPathRooted ( ship . ModelAsset ) | |
ship . ModelAsset . Replace ( '\\' , '/' ) . Split ( '/' ) . Any ( part = > part = = ".." ) )
throw new InvalidOperationException ( $"{ship.Id}: model asset must be a relative package path." ) ;
var anchors = ship . Anchors ? ? throw new InvalidOperationException ( $"{ship.Id}: anchors are required." ) ;
var ids = new HashSet < string > ( StringComparer . Ordinal ) ;
2026-09-26 18:30:02 +02:00
var nodeIds = new HashSet < string > ( StringComparer . Ordinal ) ;
2026-09-26 18:14:36 +02:00
foreach ( var anchor in anchors )
{
if ( anchor = = null | | string . IsNullOrWhiteSpace ( anchor . Id ) | | ! ids . Add ( anchor . Id ) )
throw new InvalidOperationException ( $"{ship.Id}: anchor IDs must be present and unique." ) ;
if ( string . IsNullOrWhiteSpace ( anchor . ModelNodeId ) )
throw new InvalidOperationException ( $"{ship.Id}: anchor {anchor.Id} needs a model node ID." ) ;
2026-09-26 18:30:02 +02:00
if ( ! nodeIds . Add ( anchor . ModelNodeId ) )
throw new InvalidOperationException ( $"{ship.Id}: model node {anchor.ModelNodeId} is claimed by more than one anchor." ) ;
2026-09-26 18:14:36 +02:00
}
foreach ( var role in new [ ] { "map-icon" , "hull-collider" , "shield" , "tractor" } )
if ( anchors . Count ( anchor = > anchor . Role = = role ) ! = 1 )
throw new InvalidOperationException ( $"{ship.Id}: exactly one {role} anchor is required." ) ;
var mounts = new HashSet < string > ( StringComparer . Ordinal ) ;
var occupiedHardpointCells = new HashSet < ( int x , int y ) > ( ) ;
foreach ( var hardpoint in hull . Hardpoints ? ? new List < HardpointData > ( ) )
{
if ( hardpoint = = null | | string . IsNullOrWhiteSpace ( hardpoint . Transform ) | |
! mounts . Add ( hardpoint . Transform ) )
throw new InvalidOperationException ( $"{ship.Id}: hardpoint IDs must be present and unique." ) ;
if ( hardpoint . Shape ? . Cells = = null | | ! hardpoint . Shape . Cells . Cast < bool > ( ) . Any ( occupied = > occupied ) )
throw new InvalidOperationException ( $"{ship.Id}: hardpoint {hardpoint.Transform} has no cells." ) ;
for ( var cellX = 0 ; cellX < hardpoint . Shape . Width ; cellX + + )
for ( var cellY = 0 ; cellY < hardpoint . Shape . Height ; cellY + + )
{
if ( ! hardpoint . Shape . Cells [ cellX , cellY ] ) continue ;
var x = hardpoint . Position . x + cellX ;
var y = hardpoint . Position . y + cellY ;
if ( x < 0 | | y < 0 | | x > = hull . Shape . Width | | y > = hull . Shape . Height | | ! hull . Shape . Cells [ x , y ] )
throw new InvalidOperationException ( $"{ship.Id}: hardpoint {hardpoint.Transform} lies outside the hull schematic." ) ;
if ( ! occupiedHardpointCells . Add ( ( x , y ) ) )
throw new InvalidOperationException ( $"{ship.Id}: hardpoint {hardpoint.Transform} overlaps another hardpoint." ) ;
}
if ( ! anchors . Any ( anchor = > anchor . Id = = hardpoint . Transform ) )
throw new InvalidOperationException ( $"{ship.Id}: hardpoint {hardpoint.Transform} has no model anchor." ) ;
}
foreach ( var anchor in anchors . Where ( anchor = > ! string . IsNullOrEmpty ( anchor . ParentId ) ) )
if ( ! mounts . Contains ( anchor . ParentId ) )
throw new InvalidOperationException ( $"{ship.Id}: anchor {anchor.Id} has unknown hardpoint parent {anchor.ParentId}." ) ;
foreach ( var line in ship . SchematicLines ? ? new List < ShipPolyline > ( ) )
{
var points = line ? . Points ;
if ( points = = null | | points . Length < 6 | | points . Length % 3 ! = 0 | |
points . Any ( value = > float . IsNaN ( value ) | | float . IsInfinity ( value ) ) )
throw new InvalidOperationException ( $"{ship.Id}: schematic line needs finite XYZ points." ) ;
var count = points . Length / 3 ;
if ( line . Radii ! = null & & line . Radii . Length ! = count | |
line . Opacities ! = null & & line . Opacities . Length ! = count )
throw new InvalidOperationException ( $"{ship.Id}: schematic line point attributes have the wrong length." ) ;
if ( line . Radii ! = null & & line . Radii . Any ( value = > float . IsNaN ( value ) | | float . IsInfinity ( value ) | | value < 0 ) | |
2026-09-30 02:14:10 +02:00
line . Opacities ! = null & & line . Opacities . Any ( value = > float . IsNaN ( value ) | | value < 0 | | value > 1 ) )
2026-09-26 18:14:36 +02:00
throw new InvalidOperationException ( $"{ship.Id}: schematic line radius and opacity must be finite and in range." ) ;
if ( line . Color ! = null & & ( line . Color . Length ! = 4 | |
line . Color . Any ( value = > float . IsNaN ( value ) | | float . IsInfinity ( value ) ) ) )
throw new InvalidOperationException ( $"{ship.Id}: schematic line color must be finite RGBA." ) ;
}
}
}