A small tool/utility to download your Neos Account contents to your local computer.
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.
This repository/software/project aims to do only a limited number of things:
- Download the contents of a Neos Account and any groups it is part of to a Local Hard Drive.
- Store the contents in a way that other software or projects can interact with.
- Preserve that contents in a way that allows peace of mind.
We do not intend to process the contents in a way that makes it compatible with other engines such as Unity, Unreal etc.
- Click this link
- Scroll to the section of the page that says "Assets".
- Click on the Asset(Zip File) that matches your operating system (Windows or Linux) (You DO NOT need the source code zips)
- It will download
- UnZip the downloaded Zip file
- Enter the folder from the Zip file
- Run the Exe (Neos Account Downloader.exe) by double clicking it.
Thanks for your interest in contributing, there are several ways you can contribute!
- Localization
- Bug Reporting
- Feature Requests
- Engineering / Programming
We appreciate any contributions, you'll get added to our Contributor list for pretty much any activity.
We'd love help with localization.
You have two options when localizing.
We're trying out Weblate for online localization, it will enable you to localize Neos Account Downloader without downloading anything from right in your browser, it is really cool. You can click the image below to go to our location on Weblate.
There's also a guide for using weblate available. If you're struggling you can always do the manual method as listed below.
It is recommended to use the same username and email as the one you have here on GitHub when registering/using Weblate. This will ensure that your changes are accredited to your regular GitHub user when they come across from Weblate.
- Duplicate: https://github.com/GuVAnj8Gv3RJ/NeosAccountDownloader/blob/main/AccountDownloader/Properties/Resources.resx
- Save it as Resources.
<your language code>.resx - Translate
- PR it
All software has bugs, this software included. Whenever a bug is encountered, please open an issue the format doesn't really matter provided you clearly explain your problem. Please provide a log file if you can though. We'll get to the bugs as soon as we can.
In the top bar menu for the tool click Help -> Open Log Folder. It'll take you right there.
Sure, email one to: guvanj8gv3rj.undertook642@passinbox.com . This email goes straight to the authors.
Feature requests are welcome, please open an issue where we can discuss the feature request. Do keep in mind our scope though.
We're happy to accept contributions in the form of PRs, but please open an issue to discuss your changes before making them. We can talk about suitability, method, approach etc.
Follow the download instructions.
Backing up Neos content given the current circumstances seemed wise.
No.
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.
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.
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. The download location can handle as many accounts as needed.
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.
For assets, we skip downloading them if an existing asset is found. This makes many downloads incremental rather than starting from scratch.
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.
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.
At the end of your download you might see asset or record failures.
- A record failure usually means that an entire item/world/avatar failed to download, you won't have any assets from that record because the tool could not download the Record to find them
- An asset failure means a part of a downloaded record could not be downloaded.
In both cases, make sure you take a look at the UI scrolling left and right etc. Better UI for this area might be a focus if we continue to see errors. In both events the details are logged to your log files too.
We understand that some of you have felt a degree of apprehension due to us remaining anonymous, citing concerns that we're not an active member of the Neos community.
This is not the case. We feel the situation surrounding Neos has created some anxiety concerning the future of the projects we've made on this platform, and this downloader is to help mitigate that by providing an opportunity to back up work should the worst come to pass.
Similarly, other efforts to restore content, such as the Neos wiki edits, have led to account locks for users, denying them the ability to access their assets entirely. This makes it difficult to provide back up options without risking access to the very content it aims to preserve.
Our anonymity is simply intended to provide a basic level of protection. We hope you can find it a not unreasonable one, and we welcome anyone to investigate the Github to verify the contents of the downloader.
You can also read Verifying Checksums to double check that what you see on GitHub is what you get.
If you'd like to build your trust in this software you can do so in a number of ways:
- Read the source code of the repository, there is no hidden code or components
- Read Verifying Checksums which verifies that the builds you obtain are built on GitHub using code on GitHub without outside interference.
- Discuss the software with the community, several members of the Neos community including Neos Team members have reviewed this code and confirmed it to be ok.
If you have further doubts feel free to open an issue or a discussion.
Sure you can email: guvanj8gv3rj.undertook642@passinbox.com to conduct a private conversation. Our preference is that conversations are kept public in issues or discussions.
We do not respond on Discord and use the account purely to post new versions.
If you'd like to double check the checksums/integrity of the built Binaries of this project. You can follow these steps:
- Download the latest release(1.10.7 onwards) for your operating system
- Also download the Checksum for that operating system. It is a text file.
- Check the Actions log for this repository, for the version you downloaded
- Locate the "Print Checksum" step
- Copy the printed checksum somewhere safe
- Now you can check the checksum of the downloaded files.
- On windows you can run:
certutil -hashfile <file> SHA256 - On Linux you can run:
sha256sum <file>
- On windows you can run:
- Compare the output of the command to the downloaded checksum file.
- Compare the output of the command to the checksum found in the GitHub Actions Log
- If all 3 match, then you know that this build that you've downloaded was generated purely from GH actions and not manipulated.
This should help to increase trust, that the builds of this tool are not manipulated by the author. What you see on GH is what gets built and served to you via the releases tab.
If you'd like to read more about this concept, you can read this Wikipedia article.
Below is a list of all of the awesome people who have helped to contribute to this software. If you feel you're missed, or that your contribution types aren't correct. Please feel free to open an issue.
We're still figuring out how to link in Weblate contributors for now, we'll manually add you here :)
- Spanish
- gallegonovato (6)