/NeosAccountDownloaderGPL

Downloads your Neos account to your local computer.

Primary LanguageC#OtherNOASSERTION

Stiefel's Version of Neos Account Downloader

This is not the same repository of the Neos Account Downloader devloped by GuVAnj8Gv3RJ. This is a forked repository that includes additional features missing from the original tool that are in high demand by Neos users and features that GuVA is still implementing. If you prefer to download the original Neos Account Downloader, you may visit GuVA's repository at https://github.com/GuVAnj8Gv3RJ/NeosAccountDownloader. All FAQs from GuVA's README will be listed here in addtion to ones that I will list.

A small tool/utility to download your Neos Account contents to your local computer.

Disclaimer

While every effort is made to download everything from your account, this utility may miss or lose some data. As such we're unable to offer any guarantee or warranty on this application's ability. This is in line with the License but this additional disclaimer is here in the hopes of transparency.

Please refer to the License file for additional commentary.

Download

Windows: Neos Account Downloader for Windows (v2023.9.2)

Linux: Neos Account Downloader for Linux (v2023.9.2)

Additional Features

Based on review of the original repository, this tool contains changes from 1.10.2 that was released by GuVA. However, the following major changes have not been added:

  • File Extensions - Stiefel's version of implementing file extensions is different from GuVA's. It is also another reason why this repository did not incorporate GuVA's changes from versions 1.8.0 and 1.10.1 until this point due to the different logic to determine file extensions.

All third party libraries are also up-to-date at the time of writing. In addition, the following changes are in place:

  • Featured world records are being gathered.
  • BMPCUBE file types are accounted for.
  • Record information and assets are being downloaded at the same time as the tool continues to search for records.
  • Group-only record selections will show the Inventory & World and Assets progress.
  • Additional asset metadata is saved. This includes the asset's MIME type, Neos location, and file size.
  • Persistent user selections (will be changing to be folder specific, but keeping it here for now).
    • Known Issue: If the download button is still disabled, you may need to check/uncheck an option to enable it. I am looking into it.

FAQ (from GuVAnj8Gv3RJ)

How do I download this?

Follow the instructions above.

Why does this exist?

Backing up Neos content given the current circumstances seemed wise.

Can I restore this download into my Neos Account?

No.

What can I do with the downloaded files?

The files are mostly machine readable collections of entities from your account, feel free to poke around.

You could however, write additional tools that do stuff with them.

Can I import downloaded content into Unity?

This is not a supported use case of this utility. No effort will be made to support this. You could make your own tooling to do that though.

Should I use a new folder for each user I download?

Ideally no, the local store that this app builds will in some cases handle duplicate assets in a way that will reduce total file size if you use the same folder for multiple accounts.

Can I run this app for multiple users at the same time?

Yes, but if you do this, you'll need to use two separate folders which we do not recommend. You may also breach some rate limits Neos has in place on its cloud infrastructure.

Do subsequent downloads, re-download assets?

For assets, we skip downloading them if an existing asset is found. This makes many downloads incremental rather than starting from scratch.

Why is assets showing as 0/XYZ?

For assets, we skip downloading them if an existing asset is found. If your progress statistics or report etc. show 0/xyz etc then it means that no new assets were found.

What's the difference between Assets and Records/Items/Worlds/Avatars?

This diagram might help:

  • Assets: Anything that makes up an element in Neos that is not the structure of it within the inspector. So Image,Sounds,Videos,Model Files. These are downloaded incrementally
  • Records: Records contain a manifest of all assets that are required to represent an item or world. These are downloaded each time.
  • Everything Else: JSON Soup. Just JSON Files of various types. Contacts, Messages etc. These are downloaded each time.

Known Issues

Localization isn't instant

If you switch languages then the currently active page you're on will not update to the new language.

Localization defaults to your computer's language, so for most people this hopefully should not be a problem, but for now change your language on the Getting Started screen.

Progress Metrics aren't 100% Accurate

Neos assets and records are stored in a way that makes it difficult for us to estimate the total number of records required for download. Due to this we sometimes discover more that need to be queued for download as we go. Causing numbers to jump around a little bit.

Contributing

Please feel free to contribute to this repository if you would like. Please keep in mind that any additions made will be under the GPLv2 license. All work that was and will be performed on GuVAnj8Gv3RJ's repository will be licensed under MIT.

Contributors from GuVAnj8Gv3RJ's Repository

TheJebForge
TheJebForge

🌍
orange3134
orange3134

🌍
Stiefel Jackal
Stiefel Jackal

💻 🐛 🔬
Sharkmare
Sharkmare

🌍
GuVAnj8Gv3RJ
GuVAnj8Gv3RJ

💻 🚧
Cyro
Cyro

💻
Psychpsyo
Psychpsyo

💻 🌍
xLinka
xLinka

🔬
Rucio
Rucio

🐛
Samuel-Sann Laurin
Samuel-Sann Laurin

🐛
rampa3
rampa3

🌍
ThomFox
ThomFox

🔬
5H4D0W-X
5H4D0W-X

🐛
ProbablePrime
ProbablePrime

🐛

Contributors from this Repository

Thank you to the following people who contributed towards this repository!

Edward205
Edward205
Translation (Romanian)