Skip to content

Latest commit

 

History

History
99 lines (68 loc) · 3.53 KB

README.md

File metadata and controls

99 lines (68 loc) · 3.53 KB
Raw

Welcome to pocket-platformer-exporter 👋

Version Documentation Maintenance License: MIT Twitter: Haroldo0k

Converts html files exported by pocket-platformer (https://the-l0bster.itch.io/pocket-platformer) into formats that should be more easily exported to other engines.

🏠 Homepage

Install

npm install

Usage

pocket-platformer-exporter <cmd> [args]

Commands:
  pocket-platformer-exporter json <src>     Converts a Pocket Platformer project
  <dest>                                    into a JSON file.
  pocket-platformer-exporter tiled <src>    Converts a Pocket Platformer project
  <dest>                                    into a Tiled project.

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]
  

pocket-platformer-exporter json <src> <dest>

Converts a Pocket Platformer project into a JSON file.

Positionals:
  src   The source Pocket Platformer HTML, the one that will be converted     [string] [required]
  dest  The name of the JSON file that will be generated.    [string] [required]
  

pocket-platformer-exporter tiled <src> <dest>

Converts a Pocket Platformer project into a Tiled project.

Positionals:
  src   The source Pocket Platformer HTML, the one that will be converted     [string] [required]
  dest  The name of either the directory where the Tiled project will be
        generated.                                           [string] [required]

Options:
  --zip      Compress the exported files into a ZIP file.
                                                      [boolean] [default: false]

Run tests

npm run test

Author

👤 Haroldo O. Pinheiro

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Haroldo O. Pinheiro.
This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator