- 版权类型
- 原创
- 插件中文名称
- 铸造厂
- 插件英文名称
- Foundry
- 原帖地址
- #
- 支持的核心(服务端)
- Spigot
- Paper
- Folia
- Purpur
- PufferFish
- Leaves
- 语言支持
- 多语言
- 适配版本(Java)
- 26.x
- 1.21
[MD]
# Foundry —— 现代化 Minecraft 科技框架 [Paper 1.21+]
> **一个面向插件开发者的工业科技框架**
> 能力驱动 · 类型安全 · 模块化 · 高性能
---
## 📢 项目状态告示
> ⚠️ **本项目尚未完善,目前处于早期开发阶段**
> 许多模块与功能仍在持续实现与打磨中,API 可能会发生变动。
> **欢迎各位开发者添砖加瓦!** 无论是代码贡献、文档完善、问题反馈还是功能建议,都非常欢迎。
> 让我们一起把 Foundry 做成真正好用的 Minecraft 科技框架。
---
## ✨ 项目简介
**Foundry** 是一套专为 Minecraft 服务器插件开发者打造的现代化技术框架。
它提供了完整的**能量系统、流体处理、机器基础设施、自动化网络**等工业科技常用能力,采用**能力驱动(Capability-Driven)**架构,让你可以像搭积木一样构建复杂的科技内容。
无论是想做工业模组风格的插件,还是需要能量/流体/机器底层支持的自动化系统,Foundry 都能显著降低开发难度,提升代码质量与可维护性。
---
## 🎯 适合谁使用?
- 想开发**工业科技**、**自动化**、**机器类**插件的开发者
- 需要能量网络、流体管道、配方系统的插件作者
- 追求类型安全、模块化、高性能底层架构的开发者
- 希望避免重复造轮子的技术向插件开发者
---
## 🧩 核心特性
| 特性 | 说明 |
|------|------|
| **能力驱动架构** | 机器只声明自己能做什么,运行时动态查询,无硬依赖 |
| **类型安全** | 全程强类型设计,减少运行时错误,IDE 友好 |
| **模块化设计** | 各系统独立又可互通,按需引入 |
| **性能优先** | 高效 Tick 调度、懒加载、异步友好架构 |
| **开发者友好** | 注解驱动注册、合理默认值、清晰文档 |
| **多平台兼容** | 支持 Paper / Spigot,并提供 Folia 多线程兼容层 |
---
## 📦 模块一览
Foundry 采用多模块设计,你可以按需使用:
- **foundry-api** —— 公共 API 与能力契约
- **foundry-core** —— 框架核心与运行时引擎
- **foundry-energy** —— 能量生成、存储、传输与网络
- **foundry-fluid** —— 流体处理、储罐、管道系统
- **foundry-machine** —— 机器生命周期、Tick 调度、多方块结构
- **foundry-gui** —— 声明式 GUI 构建器
- **foundry-recipe** —— 配方系统与匹配引擎
- **foundry-storage** —— 物品与库存管理
- **foundry-network** —— 客户端-服务端网络同步
- **foundry-entity** —— 实体型机器支持
- **foundry-folia** —— Folia 多线程兼容层
- **foundry-platform** —— 平台抽象与版本适配
---
## 🚀 快速开始
### 依赖引入(Gradle Kotlin DSL)
```kotlin
repositories {
maven("https://maven.pkg.github.com/ian171/Foundry") {
credentials {
username = project.findProperty("gpr.user") as String?
password = project.findProperty("gpr.token") as String?
}
}
}
dependencies {
compileOnly("io.github.ian171:foundry:0.0.1.2-SNAPSHOT")
}
```
### plugin.yml
```yaml
depend: [Foundry]
```
### 简单示例:煤炭发电机
```java
@Foundry(namespace = "myplugin", id = "coal_generator")
@FoundryBlock(material = Material.NOTE_BLOCK, isMachine = true)
@FoundryMachine(tickInterval = 20)
public class CoalGenerator implements CapabilityProvider {
private final EnergyStorage energy = new SimpleEnergyStorage(10000);
public void tick() {
if (hasFuel()) {
energy.insert(100.0, false); // 每秒产生 100 能量
}
}
@Override
public <T extends Capability> Optional<T> getCapability(
CapabilityKey<T> key, Direction side
) {
if (key == FoundryCapabilities.ENERGY) {
return Optional.of(key.getType().cast(energy));
}
return Optional.empty();
}
@Override
public Set<CapabilityKey<?>> getCapabilities() {
return Set.of(FoundryCapabilities.ENERGY);
}
}
```
---
## 📋 支持环境
- **Java**:21+
- **服务端**:Paper 1.21+(兼容 Spigot / Bukkit)
- **构建工具**:Gradle 8.5+
- **许可协议**:GPL-3.0(允许商业使用,但修改后需开源)
---
## 🔗 相关链接
- **GitHub 仓库**:https://github.com/ian171/Foundry
- **Issues 反馈**:https://github.com/ian171/Foundry/issues
- **Discussions 讨论**:https://github.com/ian171/Foundry/discussions
---
## 🤝 贡献与支持
项目目前仍处于**早期阶段**,功能尚未完全稳定。
我们非常欢迎:
- 提交 Pull Request(功能、修复、文档)
- 报告 Bug 或提出改进建议
- 参与讨论与设计
- 编写示例与教程
> **未完善,欢迎添砖加瓦!**
> 一起打造更好的 Minecraft 科技开发体验。
---
**Foundry** —— 用正确的方式构建 Minecraft 工业自动化。
[/MD]