|
@ -0,0 +1,32 @@ |
|
|
|
|
|
Asset Compression Helper |
|
|
|
|
|
======================== |
|
|
|
|
|
|
|
|
|
|
|
## About |
|
|
|
|
|
|
|
|
|
|
|
This tool exists to help compress, store, retrieve and validate media for games. The goal is to provide a simple workflow for checking assets for changes, generating new compressed versions based on those changes, storing those changed versions, and retrieving compressed files. |
|
|
|
|
|
|
|
|
|
|
|
This tool is designed to work with an S3 compatible bucket storage provider. |
|
|
|
|
|
|
|
|
|
|
|
## Requirements |
|
|
|
|
|
|
|
|
|
|
|
- An S3 Compatible Storage Service |
|
|
|
|
|
- Python 3.7+ |
|
|
|
|
|
- FFMpeg for jpeg, video, and audio compression |
|
|
|
|
|
- OptiPNG for png optimization |
|
|
|
|
|
|
|
|
|
|
|
## Using |
|
|
|
|
|
|
|
|
|
|
|
### Configuring Profiles |
|
|
|
|
|
|
|
|
|
|
|
### Checking For Changed Assets |
|
|
|
|
|
|
|
|
|
|
|
### Compressing Changed Assets |
|
|
|
|
|
|
|
|
|
|
|
### Uploading Changed Assets |
|
|
|
|
|
|
|
|
|
|
|
### Downloading Assets |
|
|
|
|
|
|
|
|
|
|
|
## Contributing |
|
|
|
|
|
|
|
|
|
|
|
## License |
|
|
|
|
|
See [LICENSE.md](LICENSE.md) |