https://github.com/insality/defold-parser

Node module to encode and decode Defold files
https://github.com/insality/defold-parser

defold npm npm-package parser

Last synced: about 1 month ago
JSON representation

Node module to encode and decode Defold files

• Host: GitHub
• URL: https://github.com/insality/defold-parser
• Owner: Insality
• License: mit
• Created: 2022-10-02T16:32:21.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2022-10-17T21:25:36.000Z (about 2 years ago)
• Last Synced: 2024-11-09T15:00:30.208Z (about 1 month ago)
• Topics: defold, npm, npm-package, parser
• Language: JavaScript
• Homepage:
• Size: 149 KB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
![](logo_defold_parser.png)

[![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/insality) [![Ko-Fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/insality) [![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/insality)

[![CI/CD](https://github.com/Insality/defold-parser/actions/workflows/node.js.yml/badge.svg)](https://github.com/Insality/defold-parser/actions/workflows/node.js.yml)

[![npm](https://img.shields.io/npm/v/defold-parser?label=defold-parser)](https://www.npmjs.com/package/defold-parser)

**Defold Parser** - node module to encode and decode [**Defold**](https://defold.com/) files.

## Install

To install **[defold-parser](https://www.npmjs.com/package/defold-parser)** use [`npm`](https://docs.npmjs.com/).

```bash

npm install --save defold-parser

```

For update **defold-parser** you can use

```bash

npm update --save defold-parser

```

## Usage

Add require line to your `.js` script:

```js

const defold_parser = require("defold-parser")

```

All available API is:

```js

// Parse any Defold file (go, gui, collection, particlefx, etc)

let object = defold_parser.load_from_file([path_to_defold_file])

// Save object to the Defold format

defold_parser.save_to_file([path_to_file], [object])

// You can pass text string directly

let object = defold_parser.decode_object([defold_text_string])

// And get Defold encoded text directly too

let defold_text_string = defold_parser.encode_object([js_object])

```

Every Defold parsed struct is array, even for single fields. To access any field you should access it on first array index. For example:

```js

let parsed_collection = defold_parser.load_from_file("./tests/files/collection.collection")

let instance = parsed_collection.embedded_instances[0]

assert(instance.id[0] == "tile")

assert(inner_component.id[0] = "sprite")

assert(inner_component.type[0] = "sprite")

```

To know, which fields you wanna edit, see the file struct you parsing or just use `console.log` in development :smile:

## License

- Developed and supported by [Insality](https://github.com/Insality)

## Issues and suggestions

If you have any issues, questions or suggestions please [create an issue](https://github.com/Insality/defold-parser/issues) or contact me: [[email protected]](mailto:[email protected])

## ❤️ Support project ❤️

Please support me if you like this project! It will help me keep engaged to update this project.

[![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/insality) [![Ko-Fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/insality) [![BuyMeACoffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/insality)