godot-export-presets 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hello Invent LTD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights  
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell  
+copies of the Software, and to permit persons to whom the Software is  
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in  
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR  
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE  
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER  
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN  
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,110 @@
+# godot-export-presets
+
+Read and write Godot export_presets.cfg files.
+
+This library provides a simple way to programmatically manage Godot export presets. It handles parsing the config file format, merging presets, and includes base presets for common platforms.
+
+The parsing and serialization logic is based on Godot's source code, specifically the `ConfigFile`, `VariantParser`, and `VariantWriter` implementations from the Godot engine repository. This attempts to ensure compatibility with Godot's native export preset format.
+
+## Installation
+
+```bash
+npm install godot-export-presets
+```
+
+Requires Node.js 18 or higher.
+
+## Quick Start
+
+```typescript
+import { loadExportPresets, findPreset, saveExportPresets } from 'godot-export-presets';
+
+// Load existing presets
+const presets = await loadExportPresets('./export_presets.cfg');
+
+// Find preset by platform name
+const androidPreset = findPreset(presets, { platform: 'Android' });
+if (androidPreset) {
+  androidPreset.export_path = 'game.apk';
+}
+
+// Save
+await saveExportPresets('./export_presets.cfg', presets);
+```
+
+## Examples
+
+### Basic Reading and Writing
+
+Load a file, find a preset by name, make changes, and save:
+
+```typescript
+import { loadExportPresets, findPreset, saveExportPresets } from 'godot-export-presets';
+
+const presets = await loadExportPresets('./export_presets.cfg');
+console.log(`Found ${presets.presets.length} presets`);
+
+// Find preset by platform (case-insensitive)
+const androidPreset = findPreset(presets, { platform: 'android' });
+if (androidPreset) {
+  androidPreset.export_path = 'game.apk';
+}
+
+// Or find by preset name
+const iosPreset = findPreset(presets, { name: 'iOS' });
+if (iosPreset) {
+  iosPreset.export_path = 'game.ipa';
+}
+
+await saveExportPresets('./export_presets.cfg', presets);
+```
+
+### Using Base Presets
+
+The library includes base presets for Android and iOS on Godot 3.x and 4.x:
+
+```typescript
+import { getBasePreset, getMajorVersion } from 'godot-export-presets';
+
+// Get base preset for Android (Godot 4.x)
+const baseAndroid = getBasePreset('Android', 4);
+
+// Extract version from string
+const version = getMajorVersion('4.3.2'); // returns 4
+const baseForVersion = getBasePreset('iOS', version);
+```
+
+## API Overview
+
+Main functions:
+
+- `loadExportPresets(filePath)` - Load presets from file
+- `saveExportPresets(filePath, presets)` - Save presets to file
+- `parseExportPresets(content)` - Parse from string
+- `serializeExportPresets(presets)` - Serialize to string
+- `findPreset(presets, criteria)` - Find preset by platform/name/index
+- `getPreset(presets, index)` - Get preset by index
+- `setPreset(presets, preset, index?)` - Add or update preset
+- `removePreset(presets, index)` - Remove preset
+- `mergePresets(...presets)` - Merge multiple presets
+- `getBasePreset(platform, version)` - Get base preset
+- `getMajorVersion(version)` - Extract major version from string
+
+For full TypeScript types and API details, see the type definitions in `dist/index.d.ts`.
+
+## Implementation Notes
+
+This library is based on Godot's source code. The parsing logic follows Godot's `VariantParser` implementation, and the serialization follows `VariantWriter` and `String::property_name_encode`. The base presets are extracted from real Godot export configurations.
+
+This implementation was created with tool assistance using Cursor and Claude, porting Godot's C++ logic to TypeScript while maintaining compatibility with the original format.
+
+Key Godot source files referenced:
+- `core/io/config_file.cpp` - ConfigFile parsing and writing
+- `core/variant/variant_parser.cpp` - Variant parsing logic
+- `core/string/ustring.cpp` - String encoding for keys
+- `editor/export/editor_export.cpp` - Export preset structure
+
+## License
+
+MIT
+