Skip to main content

Crate yang_pcg

Crate yang_pcg 

Source
Expand description

§yang-pcg

YANG Procedural Content Generation - UE5 Roguelike 地图生成算法库

本库提供可复现、可测试、可缓存、可导出、可分块加载的地图生成核心, 并通过独立适配层与 UE5 PCG 工作流对接。

§核心特性

  • 确定性生成:相同种子和配置生成相同结果
  • 分层架构:算法核心与 UE5 集成解耦
  • 可观测性:完整的调试和追踪支持
  • 可扩展性:支持约束、模板、分块等增强能力

§模块组织

  • config: 配置管理与归一化
  • generator: 核心生成器编排
  • rng: 确定性随机数生成
  • topology: 房间拓扑与路径规划
  • layout: 空间布局与走廊生成
  • terrain: 房间地形生成
  • spawn: 交互物与敌人点位生成
  • constraint: 约束求解(锚点、排除区、模板)
  • model: 核心数据模型
  • ue: UE5 适配层
  • debug: 调试与分析输出
  • cache: 缓存管理(调用方自管工具类,generate() 不自动读写缓存)
  • error: 错误类型定义
  • validation: 结果验证与不变量检查

§使用示例

ⓘ
use yang_pcg::{GenerationRequest, GenerationConfig, MapGenerator};

// 创建生成请求
let request = GenerationRequest {
    seed: Some(12345),
    config: GenerationConfig::default(),
    constraints: vec![],
    runtime_context: None,
    trace_id: None,
};

// 生成地图
let generator = MapGenerator::new();
let result = generator.generate(request)?;

// 导出为 JSON
let json = serde_json::to_string_pretty(&result)?;

Re-exports§

pub use chunked::ChunkDetailResult;
pub use chunked::TopologyResult;
pub use config::GenerationConfig;
pub use config::GenerationMode;
pub use config::NormalizedConfig;
pub use digest::ConfigDigest;
pub use digest::ConstraintDigest;
pub use error::PcgError;
pub use error::PcgResult;
pub use export::export_binary;
pub use export::export_json;
pub use export::export_json_compact;
pub use export::import_binary;
pub use export::import_json;
pub use export::CURRENT_SCHEMA_VERSION;
pub use generator::MapGenerator;
pub use grammar::GrammarContext;
pub use grammar::GrammarRule;
pub use grammar::WeightedRuleSelector;
pub use model::geometry::CardinalDir;
pub use model::geometry::GridPoint;
pub use model::geometry::WorldPoint;
pub use model::request::GenerationRequest;
pub use model::request::RuntimeContext;
pub use model::result::GenerationResult;
pub use model::result::ResultMetadata;
pub use model::room::Room;
pub use model::room::RoomType;
pub use rng::StableRng;
pub use validation::ValidationItem;
pub use validation::ValidationReport;

Modules§

backend
cache
chunked
config
constraint
debug
digest
error
export
generator
grammar
layout
model
rng
terrain
topology
ue
validation