Flutter未知功能插件wfc的使用

Wave Function Collapse in Dart

此仓库包含了一个由mxgmn用C#编写的Wave Function Collapse算法的Dart实现。波函数坍缩（WFC）是一种约束求解算法，常用于过程内容生成，如创建位图、地图或关卡。

致谢

这个项目是对mxgmn创建的Wave Function Collapse算法的重新实现。原始的C#版本是这个Dart实现的基础和灵感来源。本项目的目的是使该算法可以被使用Dart开发包括构建跨平台应用程序的开发者访问。所有关于WFC的核心思想和概念的功劳都归于mxgmn。这个仓库专注于将实现翻译成Dart，同时遵循Dart特定的约定和习惯用法。

功能

• 基于Dart的Wave Function Collapse算法的重新实现。

• 与Flutter和其他Dart应用程序兼容设计。

• 从XML和JSON文件读取瓦片配置，类似于原始实现。

• 可定制的日志记录，支持用户定义的日志处理程序。

• 提供了一个自定义日志记录器作为示例：

  import 'package:wfc/src/logging/logger.dart'; // 在其他项目中如果想尝试它
  

• 包含用于位图操作和过程内容生成的帮助类。

使用方法

1. 克隆仓库：

   git clone https://github.com/rick-dalley/wfc.git
   cd wfc
   

2. 安装依赖：确保您的系统上安装了Dart。通过运行以下命令安装依赖项：

   dart pub get
   

3. 运行项目：要执行main.dart中提供的示例，请使用：

   dart run
   

4. 输入文件：将您的XML配置文件放在适当的目录中（例如，lib/tilesets）。修改样本JSON文件（samples.json）以包含您的瓦片配置。

5. 输出：生成的位图和可选文本输出将保存在output/目录中。可以在输出文件夹中找到输出样本。

导入包

要在您自己的项目中使用wfc包，导入公共API（参见example/example.dart或./main.dart以查看示例）：

import 'package:wfc/wfc.dart';

代码结构

• lib/src/：
  • base_model.dart：为Wave Function Collapse定义抽象基模型。
  • simple_tile_model.dart：实现基于瓦片的WFC算法。
  • logging/logger.dart：提供具有可定制日志级别的日志记录功能。
  • tile.dart：表示瓦片配置。
  • bitmap_helper.dart：包含用于位图操作的实用函数。
• main.dart：算法使用的示例，它读取所有输入并创建多个输出，以展示功能的广度。
• example/example.dart：展示输出的使用示例。
• output/：保存生成输出的目录。

示例代码

以下是example/example.dart的完整示例代码，展示了如何解析瓦片文件、准备输出目录以及运行算法：

import 'dart:convert';
import 'dart:io';
import 'dart:math';

import 'package:wfc/wfc.dart';

Logger logger = Logger();

Future<List<Tile>> parseTilesFromFile(String filePath) async {
  final fileContent = await File(filePath).readAsString();

  // Parse the JSON content
  final List<dynamic> jsonList = jsonDecode(fileContent);

  // Map JSON elements to Tile objects
  List<Tile> tileList = [];
  for (var tileMap in jsonList) {
    try {
      var parsedTile = Tile.fromJSON(tileMap as Map<String, dynamic>);
      tileList.add(parsedTile);
    } catch (e) {
      logger.log('Error parsing tile: $tileMap, Error: $e');
    }
  }
  return tileList;
}

void prepareOutputDestination(String pathToOutput) {
  final folder = Directory(pathToOutput);
  if (!folder.existsSync()) {
    folder.createSync();
  }

  // Iterate through files in the directory and delete them
  folder.listSync().whereType<File>().forEach((file) {
    file.deleteSync();
  });
}

void main() async {
  // Set up paths
  final String currentDirectory = Directory.current.path;
  final String jsonPath = "$currentDirectory/assets/samples.json";
  final String outputPath = "$currentDirectory/example_output/";

  // Clean the output directory
  final outputDirectory = Directory(outputPath);
  if (!outputDirectory.existsSync()) {
    outputDirectory.createSync();
  } else {
    outputDirectory.listSync().whereType<File>().forEach((file) => file.deleteSync());
  }

  // Load the sample tile data
  final tiles = await parseTilesFromFile(jsonPath);

  // Create a random seed
  final random = Random();
  int seed = random.nextInt(1 << 32);

  // Pick the first tile to demonstrate
  if (tiles.isNotEmpty) {
    final tile = tiles.first;

    // Create a model from the tile
    final model = createModel(tile, currentDirectory);

    // Run the algorithm and save the output
    if (model.run(seed, tile.limit)) {
      model.save(outputPath, tile, seed);
      print("Example completed successfully. Output saved to $outputPath");
    } else {
      print("A contradiction occurred while running the algorithm.");
    }
  } else {
    print("No tiles found in $jsonPath.");
  }
}

贡献

欢迎贡献！如果您发现错误或有改进建议，请随时打开问题或提交拉取请求。

贡献步骤：

1. 叉此仓库。

2. 创建一个新的分支进行更改：

   git checkout -b feature/my-feature
   

3. 提交更改：

   git commit -m "Add my feature"
   

4. 推送到您的分支：

   git push origin feature/my-feature
   

5. 打开一个拉取请求。请确保遵循现有的编码风格，并在适用时添加测试。

许可证

本项目根据MIT许可证授权。原始C#实现由mxgmn根据MIT许可证授权。