Question: Habitica S3-hosted assets availability

[t-m-w]

I have a couple of questions about the Habitica assets that are hosted on AWS at https://habitica-assets.s3.amazonaws.com and referenced statically all throughout the code base.

1. Is there somewhere that the assets can be downloaded so that Habitica can be self-hosted independently, and without needing to eat up traffic at the upstream S3 bucket?
2. Does the LICENSE file apply to these assets?

Similar issue, but specific to images, whereas the S3 bucket also includes sounds: HabitRPG/habitica-images#6

Thanks!

[SabreCat]

Hi @t-m-w ! Thank you for being a good open-source neighbor about this. I don't think a self-host instance would cause much drain on our S3, but we appreciate the consideration!

The habitica-images repo is the right place for obtaining your own copies of the files. I see in that issue that some assets are missing, which is not intentional--I'll get the missing GIFs in there, as well as add the audio files.

The LICENSE you linked does pertain to the asset files, as described in the third bullet point (CC-BY-NC-SA 3.0). So long as you're not causing any confusion about which site/app is official Habitica, you should be ok!

[t-m-w]

That sounds great! Thanks for the clarification, and looking forward to the updated repo!

[t-m-w]

I noticed a bunch of additional images and audio files added recently! Thanks!

Is this still a work in progress? I was maybe too eager in looking at this 😅, and there is really no hurry. I just wanted to mention where I've left off in my looking at it. There are still some files that cannot be found, and I could also use some help in figuring out how to recreate the path structure that S3 uses; is there a mapping somewhere?

Right now, I'm using simple rules to reorganize the habitica-images files to match S3:

• Every subdirectory's file goes into a flat structure in mobileApp/images, with the exception of the audio directory.
• The audio directory maintains its structure and is placed at mobileApp/sounds.

Even in doing this, there are many images whose hashes do not match S3, and many that are just not present (possibly generated, but how)? The assets/ folder at S3 for example has features_ images that I can't find.

Example of an image that looks materially different in both places:

List of files present in S3 but not in habitica-images, with their S3 paths/hashes: missing.txt

List of files present in habitica-images but with different S3 hashes, with their S3 paths/hashes: different.txt

[SabreCat]

Ah, I hadn't realized how extensive the missing files were. I'll work on getting them all up to date, though it might take a little while. At this rate you seem to have everything you need to make a PR against habitica-images to fix it, if you wanted to, hah.

What you describe is all I'm aware of, as far as directory structure. The assets folder looks like it was used for some kind of demo or promotional campaign, not the production website. At this point the Habitica codebase is the best source of truth for what images are actually employed, though I realize that's not easy to navigate!

If it'd help to reorganize habitica-images at all, I can do that. The folders there are arbitrary, as you can tell vs the very flat directory structure on S3.

[t-m-w]

Sure, I can work on a PR! On some level, it is nice to have the assets organized, so I would hate to lose that. But at the same time, it could be a hassle for self-hosters to need to move things around. Would it make any sense to have a "deployed" / "public" branch, or something like that? Or would that just be an annoying amount of extra work?

[t-m-w]

I added two PRs. Let me know if you'd like any changes to them, while also feeling free to make changes yourself if you'd like. Thanks!