msfs-layout-generator 0.1.3 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.MD +63 -0
- package/package.json +1 -1
package/README.MD
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
|
|
2
|
+
# 🛫 MSFS Layout Generator
|
|
3
|
+
|
|
4
|
+
   
|
|
5
|
+
|
|
6
|
+
A tool for **Microsoft Flight Simulator (MSFS)** developers to automatically generate and update `layout.json` files for their add-ons.
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## ✨ Features
|
|
11
|
+
|
|
12
|
+
- **Automatic Layout Generation**
|
|
13
|
+
Scans package directories and creates `layout.json` with file metadata
|
|
14
|
+
|
|
15
|
+
- **Manifest Integration**
|
|
16
|
+
Automatically updates `total_package_size` in `manifest.json`
|
|
17
|
+
- **Multiple Processing Modes**
|
|
18
|
+
Process single packages, multiple packages, or batch operations
|
|
19
|
+
|
|
20
|
+
- **Batch Processing**
|
|
21
|
+
Interactive Windows batch file with menu system for easy use
|
|
22
|
+
|
|
23
|
+
- **Flexible CLI**
|
|
24
|
+
Command-line interface with various options for different workflows
|
|
25
|
+
|
|
26
|
+
- **TypeScript Support**
|
|
27
|
+
Fully typed API for programmatic usage
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## 📦 Installation & Quick Start
|
|
32
|
+
|
|
33
|
+
### Windows batch file with menu system (recommended)
|
|
34
|
+
|
|
35
|
+
1. Download `msfs-layout-generator.bat` from the latest [release](https://github.com/p-sergienko/msfs-layout-generator/releases)
|
|
36
|
+
2. Place it in your desired directory
|
|
37
|
+
3. Double-click to run
|
|
38
|
+
4. Choose options from the interactive menu
|
|
39
|
+
|
|
40
|
+
### Manual Installation as a Global CLI Tool
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npm install -g msfs-layout-generator
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## 💻 API Usage (For Developers)
|
|
49
|
+
|
|
50
|
+
Use your manager (npm, yarn, bun etc.) to install the package:
|
|
51
|
+
```bash
|
|
52
|
+
npm install msfs-layout-generator
|
|
53
|
+
```
|
|
54
|
+
Import the generator in your TypeScript / JavaScript projects:
|
|
55
|
+
```ts
|
|
56
|
+
import { generateLayout } from 'msfs-layout-generator';
|
|
57
|
+
|
|
58
|
+
// Process a single package
|
|
59
|
+
await generateLayout("F:\\fs20\\Community\\my-package");
|
|
60
|
+
```
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
**Happy Flying! ✈️**
|