Skip to content

SeaLantern-Studio/SeaLantern-Preview

 
 

Repository files navigation

logo

海晶灯(Sea Lantern)

一个轻量化的 Minecraft 服务器管理工具,基于 Tauri 2 + Rust + Vue 3

GitHub Stars GitHub Forks GitHub Latest
Gitee Stars Gitee Forks

简体中文 English

有问题?尝试→Ask DeepWiki

能干什么

  • 下载服务器核心
  • 客制化开服器体验
  • Todo: JVM 预设与分享社区
  • 方便直观的更改配置(目前仅支持原版的server.properties)
  • 快捷控制台命令
  • Todo: Cli 模式下让服务器在 Docker 容器化环境下运行

快速开始

Tips:实际上,我们拥有一个文档站!在那里你可以更直观和方便的观看各种文档!可以点击 这里 跳转

下载 正式版

下载 开发预览版

开发

请注意! 我们正在讨论关于 branch 和 fork 变动相关的内容, 开发步骤部分可能随时会有所改变, 例如 GitHub 开发仓库的变动等内容!

你需要 Node.js 20+Rust 1.70+

同时请安装pnpmcargo

您需要先 Fork 源仓库,然后在你自己的仓库进行开发工作。

如果你只是想要查看最新进度,可以直接拉取源仓库:

git clone https://github.com/SeaLantern-Studio/SeaLantern.git
cd SeaLantern

项目的包管理器经过投票,从npm切换至pnpm

前端与后端:

pnpm --dir frontend install
pnpm --dir frontend run tauri:dev

部分 Linux 发行版,例如 Arch,如果直接使用 pnpm --dir frontend run tauri:dev 可能不会编译成功,请检查你的依赖库是否完全,建议你在运行上述命令时使用包管理器提前安装 Tauri 的依赖以避免出现依赖不存在问题。点击前往"Tauri | 前置要求"

仅前端:

pnpm --dir frontend run dev

代码质量检查

提交代码前,我们建议运行以下命令来检查代码质量:

前端检查
# 代码质量检查
pnpm --dir frontend run lint

# 类型检查并验证生产构建
pnpm --dir frontend run build:check

# 自动修复可修复问题
pnpm --dir frontend run lint:fix

# 格式化代码
pnpm --dir frontend run fmt

# 检查代码格式
pnpm --dir frontend run fmt:check
后端检查
# 检查代码格式
cargo fmt --all -- --check

# 编译检查
cargo check --workspace

# 运行 Clippy 检查
cargo clippy --workspace -- -D warnings

# 格式化代码
cargo fmt --all

项目已配置 CI 自动检查,确保所有提交的代码都符合规范。

提交检查

CI 会在 PR/推送时校验代码质量与相关规范。

技术栈

  • 前端: Vue 3 + TypeScript + Vite
  • 后端: Rust + Tauri 2
  • 通信: Tauri invoke
  • Docker: itzg/minecraft-server

没有 Electron,没有 Node 后端,没有 Webpack。启动快,体积小,内存省。

我们使用 Webview 作为前端渲染,Webview 是现代计算机系统中自带的应用,前后端内存占用基本不超过70MiB

项目结构

详见 项目结构

CLI 服务器入口

当前仓库已经提供统一的 sealantern server ... CLI 入口,可同时覆盖本地 Java 服务端与 itzg/minecraft-server Docker 运行方式。

使用说明见 CLI 服务器运行指南

待开发功能

这些功能的位置都预留好了,代码骨架是现成的,等你来写:

  • 备份管理 - 世界存档的增量备份和还原
  • 内网穿透 - 集成 FRP
  • 定时任务 - 自动重启、定时备份、定时执行命令
  • 资源管理 - 从 Modrinth 和 CurseForge 搜索安装插件和模组

交流群

QQ 交流群:293748695,欢迎加入讨论!

参与开发

欢迎贡献代码!在开始之前,请阅读贡献指南以了解代码规范和开发流程。

界面也是。颜色在 CSS 变量里,组件是独立的,不喜欢就换。 想做个主题皮肤?做。想把整个布局推翻重来?也行。

当然,这一切的前提是你有足够的理由和能力,并且与群内的各位商讨后才能做,不然我们很有可能会拒收 PR

怎么贡献

  1. Fork 这个仓库的dev分支
  2. 建分支写代码
  3. 提 Pull Request
  4. 你的名字会出现在关于页面的贡献者墙上

不会写代码也行。说你想要什么功能,或者画个 UI 草图发出来,只要核实有用,都算贡献。

i18n 国际化支持指南

Sea Lantern 支持多语言国际化,包括简体中文、繁体中文和英文等. i18n 国际化指南

除了当前已有的常见语言,想要加额外语言,请制作插件。

License

GNU General Public License v3.0

Star History

Star History Chart

贡献者

感谢所有为 Sea Lantern 做出贡献的人!

Contributors

致谢

Sea Lantern 是一个开源项目,遵循 GPLv3 协议。

Minecraft 是 Mojang AB 的注册商标。 本项目未经 Mojang 或 Microsoft 批准,也不与 Mojang 或 Microsoft 关联。

“我们搭建了骨架,而灵魂,交给你们。”

About

一款由B站社区共创的客制化Minecraft开服器,它的模样,由你来决定

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Rust 63.8%
  • Vue 18.4%
  • TypeScript 14.6%
  • CSS 2.5%
  • JavaScript 0.4%
  • Dockerfile 0.2%
  • Other 0.1%