doodle/cmd/doodad
Noah Petherbridge a06787411d Resolve circular import errors for Doodle++ plugin
* pkg/plus/dpp is the main plugin bridge, and defines nothing but an interface
  that defines the Doodle++ surface area (referring to internal game types such
  as doodad.Doodad or level.Level), but not their implementations.
  * dpp.Driver (an interface) is the main API that other parts of the game will
    call, for example "dpp.Driver.IsLevelSigned()"
  * plus_dpp.go and plus_foss.go provide the dpp.Driver implementation for their
    build; with plus_dpp.go generally forwarding function calls directly to the
    proprietary dpp package and plus_foss.go generally returning false/errors.
  * The bootstrap package simply assigns the above stub function to dpp.Driver
* pkg/plus/bootstrap is a package directly imported by main (in the doodle and
  doodad programs) and it works around circular dependency issues: this package
  simply assigns dpp.Driver to the DPP or FOSS version.

Miscellaneous fixes:

* File->Open in the editor and PlayScene will use the new Open Level window
  instead of loading the legacy GotoLoadMenu scene.
* Deprecated legacy scenes: d.GotoLoadMenu() and d.GotoPlayMenu().
* The doodle-admin program depends on the private dpp package, so can not be
  compiled in FOSS mode.
2024-04-18 22:12:56 -07:00
..
commands Update savegame format, Allow out-of-bounds camera 2023-03-07 21:55:10 -08:00
main.go Resolve circular import errors for Doodle++ plugin 2024-04-18 22:12:56 -07:00
README.md Add doodad.exe binary and PNG to Drawing Converter 2018-10-16 12:26:41 -07:00

doodad.exe

The doodad tool is a command line interface for interacting with Levels and Doodad files, collectively referred to as "Doodle drawings" or just "drawings" for short.

Commands

doodad convert

Convert between standard image files (bitmap or PNG) and Doodle drawings (levels or doodads).

This command can be used to "export" a Doodle drawing as a PNG (when run against a Level file, it may export a massive PNG image containing the entire level). It may also "import" a new Doodle drawing from an image on disk.

Example:

# Export a full screenshot of your level
$ doodad convert mymap.level screenshot.png

# Create a new level based from a PNG image.
$ doodad convert scanned-drawing.png new-level.level

# Create a new doodad based from a BMP image, and in this image the chroma
# color (transparent) is #FF00FF instead of white as default.
$ doodad convert --key '#FF00FF' button.png button.doodad

Supported image types:

  • PNG (8-bit or 24-bit, with transparent pixels or chroma key)
  • BMP (bitmap image with chroma key)

The chrome key defaults to white (#FFFFFF), so pixels of that color are treated as transparent and ignored. For PNG images, if a pixel is fully transparent (alpha channel 0%) it will also be skipped.

When converting an image into a drawing, the unique colors identified in the drawing are extracted into the palette. You will need to later edit the palette to assign meaning to the colors.