Skip to content

Latest commit

 

History

History
74 lines (44 loc) · 3.53 KB

README.md

File metadata and controls

74 lines (44 loc) · 3.53 KB
Raw

GDQuest Product Packager

Plugin banner image

Product Packager is a set of CLI tools to help GDQuest in creating their tutorial series, courses and other products.

Features

This repository contains utilities for our internal build system to create courses.

It does things such as:

  • Auto-formats MDX prose files for our web platform GDSchool.
  • Preprocesses MDX files:
    • Includes content from code files. Replaces <Include file="Filename.gd" anchor="anchor_name" /> with the corresponding source code.
    • Appends Godot icon images before detected class names.
  • Compress and resize png and jpg images using imagemagick.
  • Compress and resize videos with FFMpeg.
  • Strip documents to translate from code, to count words to translate.

MDX Utils gotchas

The MDX formatter depends on some Godot source files to build regular expressiosn.

These are found at mdx-utils/src/md/godot/, and they need to be synced with the upstream godot repo.

We have a shell script mdx-utils/update_godot.sh that:

  1. Sets up a git remote called godot that points to the Godot repository.
  2. Updates the mdx-utils/src/md/godot/ folder.

Note: that after you run the script you have to manually commit the update.

Nim gotchas

mdx-utils/src/md/assets.nim reads the Godot files at compile time.

  • walkDir() seems to require paths relative to the path where we compile from. If using nimble build this is mdx-utils/.
  • staticRead() requires paths relative to the assets.nim source file.

How to use

Product packager is a modular set of tools to help process files and package products. You can find them in their respective directories.

You can use these tools individually. For example, here are some example commands I would use to compress pictures and videos in a directory using my favorite shell, fish:

optimize_pictures.sh --output output_directory --resize 1280:-1\> -- pictures/*.{jpg,png}
optimize_videos.sh --output output_directory videos/*.mp4

Run any program with the --help option to learn to use it. Also, if you find a bug, you can run tools with the -d or --dry-run option to output debug information. Please copy and paste that output to any bug you report in the issues tab.

Contributing

If you encounter a bug or you have an idea to improve the tool, please open an issue.

If you want to contribute to the project, for instance, by fixing a bug or adding a feature, check out our Contributor's guidelines.

Also, please use ShellCheck to lint your code and ensure it's POSIX-compliant.

Pull requests and code reviews are much welcome. You can share your feedback and POSIX shell programming tips in the issues tab, or by sending me a message (see below).

Support us

Our work on Free Software is sponsored by our Godot game creation courses. Consider getting one to support us!

If you like our work, please star the repository! This helps more people find it.

Join the community

  • You can join the GDQuest community and come chat with us on Discord
  • For quick news, follow us on Twitter
  • We release video tutorials and major updates on YouTube