Skip to content

Commit 7ac2653

Browse files
committed
[common] update: agents.md
1 parent 0ced820 commit 7ac2653

4 files changed

Lines changed: 45 additions & 30 deletions

File tree

AGENTS.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,30 @@ Guide for AI agents working on the MCServerLauncher-Future-Web project.
44

55
## Project Overview
66

7-
**MCServerLauncher-Future-Web** is the web frontend and next-generation client for the MCServerLauncher-Future project. It is a monorepo containing a web interface, a Tauri-based desktop application, and a Rust-based daemon.
7+
**MCServerLauncher-Future-Web** is the web-based client for the MCServerLauncher-Future project. It is a monorepo
8+
containing a web server and a Tauri-based desktop application.
89

910
- **Repository**: MCServerLauncher-Future-Web
1011
- **Architecture**: Monorepo (Turborepo)
1112
- **Package Manager**: pnpm
1213

14+
## Subprojects
15+
16+
- **MCSL Future Web**: A web panel acting as a client for MCSL Future daemons.
17+
- **MCSL Future Tauri**: A local client which can connect to both web panel and daemons.
18+
1319
## Monorepo Structure
1420

1521
The project is organized as a monorepo using Turborepo and pnpm workspaces.
1622

17-
- `apps/`: Contains the main applications.
18-
- `mcsl-future-web`: The web frontend application.
19-
- `mcsl-future-tauri`: The Tauri desktop application wrapper.
20-
- `mcsl-future-daemon-rs`: The Rust-based daemon.
2123
- `packages/`: Shared packages and libraries.
24+
- `configs/`: Contains common plugin configs.
25+
- `ui/`: The ui components for MCSL Future Web.
26+
- `locales/`: A git submodule containing i18n translations.
27+
- `shared/`: Common codes and pages for both web server and desktop app.
28+
- `apps/`: Contains the main applications.
29+
- `app/`: The desktop app and unique code of MCSL Future Tauri.
30+
- `web/`: The web server and unique code of MCSL Future Web.
2231

2332
## Essential Commands
2433

@@ -40,11 +49,6 @@ pnpm run app:build # Build Tauri app
4049
pnpm run app:lint # Lint Tauri app
4150
pnpm run app:test # Test Tauri app
4251

43-
# Daemon Commands
44-
pnpm run daemon:dev # Start Rust daemon development server
45-
pnpm run daemon:build # Build Rust daemon
46-
pnpm run daemon:test # Test Rust daemon
47-
4852
# Global Commands
4953
pnpm run build # Build all packages
5054
pnpm run lint # Lint all packages
@@ -53,16 +57,20 @@ pnpm run test # Test all packages
5357

5458
## Technology Stack
5559

56-
- **Frontend**: Vue 3, TypeScript, Vite (likely, based on standard Vue 3 setups)
57-
- **Desktop App**: Tauri (Rust + Web Frontend)
58-
- **Daemon**: Rust
60+
- **Web**:
61+
- Frontend: Vue 3, TypeScript, RsBuild
62+
- Backend: Rust Actix Web
63+
- **App**: Tauri
64+
- Frontend: Vue 3, TypeScript, RsBuild
65+
- Backend: Tauri
5966
- **Build Tool**: Turborepo
6067
- **Package Manager**: pnpm
6168

6269
## AI Agents Contribution
6370

6471
本项目的开发与维护过程中,得到了 AI 代理(如 Cline 等)的协助。
6572
AI 代理主要参与了以下工作:
73+
6674
- 代码重构与优化
6775
- 国际化 (i18n) 支持
6876
- Bug 修复与逻辑完善
@@ -72,11 +80,11 @@ AI 代理主要参与了以下工作:
7280

7381
- Ensure all tests pass and code builds successfully before committing.
7482
- Follow the monorepo structure and place code in the appropriate app or package.
75-
- Use `pnpm` for managing dependencies.
7683

7784
## References
7885

7986
- [Vue 3 Documentation](https://vuejs.org/)
8087
- [Tauri Documentation](https://tauri.app/)
8188
- [Turborepo Documentation](https://turbo.build/repo/docs)
8289
- [Rust Documentation](https://www.rust-lang.org/learn)
90+
- [RsBuild Documentation](https://rsbuild.dev/)

apps/app/AGENTS.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Guide for agents working on the MCServerLauncher-Future-Web Tauri application.
44

55
## Project Overview
66

7-
**mcsl-future-tauri** is the Tauri-based desktop application wrapper for the MCServerLauncher-Future-Web project. It packages the web frontend into a native desktop application.
7+
**MCSL-Future-Tauri** is the Tauri-based desktop application wrapper for the MCServerLauncher-Future-Web project. It packages the web frontend into a native desktop application. Also, it has the ability to connect to MCSL-Future-Web web servers.
88

99
- **Repository**: MCServerLauncher-Future-Web
10-
- **Language**: Rust, TypeScript, Vue 3
11-
- **Framework**: Tauri
10+
- **Language**: Rust, TypeScript
11+
- **Framework**: Vue 3, Tauri, Rsbuild
1212
- **Architecture**: Monorepo App (Turborepo)
1313

1414
## Essential Commands
@@ -48,6 +48,7 @@ apps/app/
4848

4949
## References
5050

51-
- [Tauri Documentation](https://tauri.app/)
5251
- [Vue 3 Documentation](https://vuejs.org/)
52+
- [Tauri Documentation](https://tauri.app/)
5353
- [Rust Documentation](https://www.rust-lang.org/learn)
54+
- [RsBuild Documentation](https://rsbuild.dev/)

apps/web/AGENTS.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ Guide for agents working on the MCServerLauncher-Future-Web frontend application
44

55
## Project Overview
66

7-
**mcsl-future-web** is the web frontend application for the MCServerLauncher-Future project. It provides the user interface for managing Minecraft servers.
7+
**mcsl-future-web** is the web panel server application for the MCServerLauncher-Future project. It provides the user interface for managing Minecraft servers.
88

99
- **Repository**: MCServerLauncher-Future-Web
10-
- **Language**: TypeScript, Vue 3
11-
- **Framework**: Vue 3, Vite
10+
- **Language**: TypeScript, Rust
11+
- **Framework**: Vue 3, RsBuild, Actix Web
1212
- **Architecture**: Monorepo App (Turborepo)
1313

1414
## Essential Commands
1515

1616
```bash
17+
# Run all below in the project root
1718
# Start web frontend development server
1819
pnpm run web:dev
1920

@@ -31,17 +32,18 @@ pnpm run web:test
3132

3233
```
3334
apps/web/
34-
├── src/ # Vue 3 source code (components, views, assets)
35-
├── public/ # Static assets
36-
├── index.html # Entry HTML file
37-
├── vite.config.ts # Vite configuration
38-
└── package.json # App-specific dependencies and scripts
35+
├── src-frontend/ # Vue 3 source code (components, views, assets)
36+
├── src/ # Rust server source code
37+
├── public/ # Static assets
38+
├── rsbuild.config.ts # Rsbuild configuration
39+
└── package.json # App-specific dependencies and scripts
3940
```
4041

4142
## Key Concepts
4243

4344
- **Vue 3**: The core frontend framework used for building the user interface.
44-
- **Vite**: The build tool and development server.
45+
- **Actix Web**: The core rust server framework used for building restful apis and hosting static web files.
46+
- **RsBuild**: The build tool and development server.
4547
- **Monorepo Integration**: This app relies on shared packages from the `packages/` directory.
4648

4749
## Git & Workflow Notes
@@ -52,4 +54,5 @@ apps/web/
5254
## References
5355

5456
- [Vue 3 Documentation](https://vuejs.org/)
55-
- [Vite Documentation](https://vitejs.dev/)
57+
- [Rust Documentation](https://www.rust-lang.org/learn)
58+
- [RsBuild Documentation](https://rsbuild.dev/)

packages/shared/AGENTS.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ Guide for agents working on the MCServerLauncher-Future-Web shared package.
44

55
## Project Overview
66

7-
**shared** is a shared package within the MCServerLauncher-Future-Web monorepo. It contains shared utilities, types, and constants used across different applications (like the web frontend and Tauri app).
7+
**shared** is a shared package within the MCServerLauncher-Future-Web monorepo. It contains shared utilities, types, and constants used across different applications (like the web server and desktop app).
88

99
- **Repository**: MCServerLauncher-Future-Web
10-
- **Language**: TypeScript
10+
- **Language**: Vue3, TypeScript
1111
- **Architecture**: Monorepo Package (Turborepo)
1212

1313
## Essential Commands
1414

1515
```bash
16+
# Run all below in the project root
1617
# Lint the shared package
1718
pnpm --filter @repo/shared run lint
1819

@@ -46,5 +47,7 @@ packages/shared/
4647

4748
## References
4849

50+
- [Vue 3 Documentation](https://vuejs.org/)
4951
- [TypeScript Documentation](https://www.typescriptlang.org/docs/)
5052
- [Turborepo Documentation](https://turbo.build/repo/docs)
53+
- [RsBuild Documentation](https://rsbuild.dev/)

0 commit comments

Comments
 (0)