Table of Contents

Introduction

S1MAPI (Mapping API) is a library for creating procedural 3D content in Schedule 1 mods. It focuses on mesh generation, building construction, and GLTF model loading while maintaining update resilience by avoiding direct dependencies on game assemblies.

Core Design Principles

Zero Initialization

S1MAPI requires no initialization. All APIs work immediately without calling any setup methods. Unity automatically handles resource cleanup when scenes unload or the application quits.

Update Resilience

S1MAPI never references Assembly-CSharp.dll types. This means your mods continue working across game updates, as long as Unity and FishNet remain stable (they typically do).

Fluent API

S1MAPI uses a fluent builder pattern for intuitive method chaining:

GameObject building = new BuildingBuilder("MyShop")
    .WithConfig(BuildingConfig.Medium)
    .AddFloor()
    .AddWalls(southDoor: true)
    .AddLights()
    .Build();

Key Features

Procedural Meshes

Generate basic shapes and combine them into complex geometries:

  • Boxes, spheres, cylinders, capsules
  • Flat shading for low-poly aesthetics
  • Custom materials and colors

Building Construction

Create complete building structures with:

  • Walls, floors, ceilings, decorative trim
  • Windows and doors
  • Procedural and S1 game furniture
  • Interior decorations
  • Lighting systems

GLTF Import

Load external 3D models at runtime:

  • Supports GLB and GLTF formats (prefer GLB)
  • No external dependencies
  • Automatic coordinate system conversion

When to Use S1MAPI

Use S1MAPI when you need/want to:

  • Create custom 3D objects programmatically
  • Import external 3D models
  • Avoid asset bundles

Use S1API when you need to:

  • Interact with game entities (NPCs, items, quests)
  • Access game systems (storage, sales, cooking)
  • Create custom NPC behaviors

Next Steps

Edit this page