-
Notifications
You must be signed in to change notification settings - Fork 16
docs(site): 同步v1.0.0文档与结构 #18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| /** 当前最新版本号,更新时只需修改此处 */ | ||
| export const VERSION = '0.6.5' | ||
| export const VERSION = '1.0.0' | ||
|
|
||
| /** GitHub Release 下载基础 URL */ | ||
| export const RELEASE_BASE = `https://github.com/SeaLantern-Studio/SeaLantern/releases/download/sea-lantern-v${VERSION}` | ||
| export const RELEASE_BASE = `https://github.com/SeaLantern-Studio/SeaLantern/releases/download/v${VERSION}` |
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -13,28 +13,39 @@ Choose the package that matches your system, then install directly. | |||||||||
| Current latest version: | ||||||||||
| <a :href="`/en/changelog#v${VERSION.replace(/\./g, '-')}`"><strong>v{{ VERSION }}</strong></a> | ||||||||||
|
|
||||||||||
| ::: tip Architecture update (v1.0.0+) | ||||||||||
| Windows and Linux ARM64 packages are now available. Choose the one matching your device architecture. | ||||||||||
| ::: | ||||||||||
|
|
||||||||||
| ## Windows | ||||||||||
|
|
||||||||||
| | Format | Description | | ||||||||||
| |--------|-------------| | ||||||||||
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_${VERSION}_x64-setup.exe`">EXE Installer</a> | Recommended, double-click to install | | ||||||||||
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_${VERSION}_x64_zh-CN.msi`">MSI Installer</a> | Windows Installer format | | ||||||||||
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_${VERSION}_arm64-setup.exe`">EXE Installer (ARM64)</a> | For Windows on ARM | | ||||||||||
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_${VERSION}_arm64_zh-CN.msi`">MSI Installer (ARM64)</a> | Windows Installer (ARM64) | | ||||||||||
|
|
||||||||||
| ## macOS | ||||||||||
|
|
||||||||||
| | Format | Description | | ||||||||||
| |--------|-------------| | ||||||||||
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_${VERSION}_aarch64.dmg`">DMG (Apple Silicon)</a> | M1 / M2 / M3 / M4 | | ||||||||||
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_${VERSION}_x64.dmg`">DMG (Intel)</a> | x64 architecture | | ||||||||||
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_aarch64.app.tar.gz`">app.tar.gz (Apple Silicon)</a> | Portable archive | | ||||||||||
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_x64.app.tar.gz`">app.tar.gz (Intel)</a> | Portable archive | | ||||||||||
|
Comment on lines
+35
to
+36
|
||||||||||
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_aarch64.app.tar.gz`">app.tar.gz (Apple Silicon)</a> | Portable archive | | |
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_x64.app.tar.gz`">app.tar.gz (Intel)</a> | Portable archive | | |
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_${VERSION}_aarch64.app.tar.gz`">app.tar.gz (Apple Silicon)</a> | Portable archive | | |
| | <a :href="`${RELEASE_BASE}/Sea.Lantern_${VERSION}_x64.app.tar.gz`">app.tar.gz (Intel)</a> | Portable archive | |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| # Detailed Directory Structure | ||
|
|
||
| > Based on the `v1.0.0` tree of `SeaLantern-Studio/SeaLantern` (released on 2026-02-26). | ||
|
|
||
| ## Top-Level Layout | ||
|
|
||
| ```text | ||
| SeaLantern/ | ||
| ├── .github/ | ||
| │ ├── ISSUE_TEMPLATE/ | ||
| │ ├── pull_request_template.md | ||
| │ └── workflows/ | ||
| │ ├── check.yml | ||
| │ ├── release.yml | ||
| │ ├── issue-check.yml | ||
| │ └── aur-publish.yml | ||
| ├── docs/ | ||
| │ ├── AI_GUIDE.md | ||
| │ ├── CONTRIBUTING.md | ||
| │ └── STRUCTURE.md | ||
| ├── src/ # Vue 3 + TypeScript frontend | ||
| ├── src-tauri/ # Rust + Tauri 2 backend | ||
| ├── Cargo.toml | ||
| ├── package.json | ||
| ├── pnpm-lock.yaml | ||
| ├── README.md | ||
| └── README-en.md | ||
| ``` | ||
|
|
||
| ## Frontend (`src/`) | ||
|
|
||
| ### API Layer (`src/api/`) | ||
|
|
||
| ```text | ||
| src/api/ | ||
| ├── tauri.ts | ||
| ├── server.ts | ||
| ├── config.ts | ||
| ├── settings.ts | ||
| ├── player.ts | ||
| ├── java.ts | ||
| ├── system.ts | ||
| ├── plugin.ts | ||
| ├── mcs_plugins.ts | ||
| ├── downloader.ts | ||
| ├── update.ts | ||
| ├── remoteLocales.ts | ||
| └── index.ts | ||
| ``` | ||
|
|
||
| ### Component Layer (`src/components/`) | ||
|
|
||
| ```text | ||
| src/components/ | ||
| ├── common/ # shared UI primitives (SLButton/SLInput/SLSelect/SLTabs/SLDropzone...) | ||
| ├── layout/ # AppHeader/AppLayout/AppSidebar | ||
| ├── console/ # ConsoleInput/ConsoleOutput/CommandModal | ||
| ├── config/ # ConfigCategories/ConfigEntry/ConfigToolbar | ||
| ├── plugin/ # PluginComponentRenderer/PluginPermissionPanel | ||
| ├── splash/ # SplashScreen | ||
| ├── views/ | ||
| │ ├── create/ # creation workflow split (workflow, startup utils, step components) | ||
| │ ├── home/ | ||
| │ ├── player/ | ||
| │ ├── settings/ | ||
| │ ├── paint/ | ||
| │ └── about/ | ||
| └── JavaDownloader.vue | ||
| ``` | ||
|
|
||
| ### View Layer (`src/views/`) | ||
|
|
||
| ```text | ||
| src/views/ | ||
| ├── HomeView.vue | ||
| ├── CreateServerView.vue | ||
| ├── ConsoleView.vue | ||
| ├── ConfigView.vue | ||
| ├── PlayerView.vue | ||
| ├── SettingsView.vue | ||
| ├── PaintView.vue | ||
| ├── AboutView.vue | ||
| ├── MarketView.vue | ||
| ├── DownloadFileView.vue | ||
| ├── PluginsView.vue | ||
| ├── PluginsPageView.vue | ||
| ├── PluginCategoryView.vue | ||
| └── PluginPageView.vue | ||
| ``` | ||
|
|
||
| ### State and Infrastructure | ||
|
|
||
| ```text | ||
| src/ | ||
| ├── stores/ # server/console/settings/plugin/ui/update/i18n stores | ||
| ├── composables/ # useAsync/useMessage/useTabIndicator/useAboutLinks... | ||
| ├── language/ # 10 locales + index.ts | ||
| ├── themes/ # default/midnight/ocean/rose/sunset | ||
| ├── styles/ # variables/reset/typography/app + module styles | ||
| ├── types/ # common/plugin/server/theme | ||
| ├── utils/ # constants/errorHandler/serverUtils/theme/version | ||
| ├── data/ # contributors.ts | ||
| ├── router/index.ts | ||
| ├── App.vue | ||
| ├── main.ts | ||
| └── style.css | ||
| ``` | ||
|
|
||
| ## Backend (`src-tauri/`) | ||
|
|
||
| ```text | ||
| src-tauri/ | ||
| ├── capabilities/default.json | ||
| ├── tauri.conf.json | ||
| ├── build.rs | ||
| ├── Cargo.toml | ||
| └── src/ | ||
| ├── commands/ # server/player/java/settings/system/update/downloader/mcs_plugin... | ||
| ├── services/ # server_manager/server_installer/download_manager/java_detector... | ||
| ├── models/ # server/plugin/config/settings/download models | ||
| ├── plugins/ # Lua plugin runtime (api/loader/manager/runtime) | ||
| ├── utils/ # cli/path/downloader | ||
| ├── lib.rs | ||
| └── main.rs | ||
| ``` | ||
|
|
||
| ## Key Structural Changes in v1.0.0 | ||
|
|
||
| - Server creation flow is fully split under `src/components/views/create/`. | ||
| - Plugin-related views and permission handling are clearly separated. | ||
| - Download modules are split out on both frontend and backend. | ||
| - `src/views/DownloadFileView.vue` is now part of the routed views. | ||
| - CI workflow is streamlined into check, release, issue-check, and AUR publish. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,9 +9,19 @@ | |
| - **Package Manager**: pnpm | ||
| - **Linting**: oxlint + oxfmt | ||
|
|
||
| ## v1.0.0 Structure Sync (2026-02-26) | ||
|
|
||
| - Server-creation flow is split under `src/components/views/create/` (import source, startup detection, custom command) | ||
| - View internals are further modularized under `about/`, `home/`, `paint/`, `player/`, and `settings/` | ||
| - API layer additions/updates include `src/api/downloader.ts` and `src/api/mcs_plugins.ts` | ||
| - View layer includes `DownloadFileView.vue` and multi-view plugin pages (`PluginsView / PluginsPageView / PluginCategoryView / PluginPageView`) | ||
| - Active CI/CD workflows: `check.yml`, `release.yml`, `issue-check.yml`, `aur-publish.yml` | ||
|
|
||
| ## Directory Overview | ||
|
|
||
| ``` | ||
|
|
||
| [Detailed Directory Structure](/en/structure-full) | ||
|
||
| SeaLantern/ | ||
| ├── src/ # Frontend source (Vue 3) | ||
| │ ├── api/ # Tauri invoke wrappers | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.