Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gdquest/product-packager
A portable shell program to package and prepare courses, tutorial series, and other products to release on e-commerce platforms like Gumroad and Mavenseed.
https://github.com/gdquest/product-packager
e-commerce gumroad itchio mavenseed packaging product shell
Last synced: about 3 hours ago
JSON representation
A portable shell program to package and prepare courses, tutorial series, and other products to release on e-commerce platforms like Gumroad and Mavenseed.
- Host: GitHub
- URL: https://github.com/gdquest/product-packager
- Owner: GDQuest
- License: mit
- Created: 2020-03-21T23:06:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T13:05:15.000Z (18 days ago)
- Last Synced: 2024-10-29T15:16:47.785Z (18 days ago)
- Topics: e-commerce, gumroad, itchio, mavenseed, packaging, product, shell
- Language: C++
- Size: 4.78 MB
- Stars: 56
- Watchers: 5
- Forks: 8
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GDQuest Product Packager
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](https://mdxjs.com) prose files for our web platform [GDSchool](https://school.gdquest.com/).
- Preprocesses MDX files:
- Includes content from code files. Replaces `` with the corresponding source code.
- Appends Godot icon images before detected class names.
- Compress and resize png and jpg images using [imagemagick](https://www.imagemagick.org/).
- Compress and resize videos with [FFMpeg](https://ffmpeg.org/).
- 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.
1. 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](https://fishshell.com/):
```sh
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](issues).
## Contributing
If you encounter a bug or you have an idea to improve the tool, please [open an issue](https://github.com/GDQuest/product-packager/issues).
If you want to contribute to the project, for instance, by fixing a bug or adding a feature, check out our [Contributor's guidelines](https://www.gdquest.com/docs/guidelines/contributing-to/gdquest-projects/).
Also, please use [ShellCheck](https://www.shellcheck.net/) 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](https://gdquest.mavenseed.com/). 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](https://discord.gg/CHYVgar)
- For quick news, follow us on [Twitter](https://twitter.com/nathangdquest)
- We release video tutorials and major updates on [YouTube](https://youtube.com/c/gdquest)