Stuck Sync

From Neos Wiki
Jump to navigation Jump to search
This page contains changes which are not marked for translation.
Other languages:
English • ‎中文 • ‎日本語

Sometimes, when your account is syncing, the sync status as shown on the dashboard will stick at various percentages(0% and 10% are common). This indicates that there was a problem while syncing that is halting or pausing the sync process. This guide aims to aid you in resolving a stuck sync. Please follow each step.

Ensure you're reading the right guide

First, We have multiple guides for Sync related matters, please ensure you are reading the correct one for your problem, if you sync is not stuck or you're experiencing some other sync issue please see Sync Errors BEFORE you start.

These problems are slightly different and may require differing steps, so we've split them into separate guides.


DO NOT

  • Delete your Neos data/database or cache files. Doing this will likely make you lose your unsynced items, and can cause other side effects
  • Try to save and sync any more items/worlds. Doing this will add to your sync queue and if your items/worlds are not syncing properly.
  • Click "Exit & Save Homes". Doing this will also add to your sync queue.
  • Send any objects or voice messages through the Contacts tab. Doing this will also add to your sync queue and will not send until any syncing issues are fixed.
  • Change any settings. Doing this will also add to your sync queue and will not save properly until any syncing issues are fixed.
  • Reinstall Neos. Doing this does not help syncing issues, as these are stored in a separate location.

Diagnosing a Stuck Sync

The first step for fixing a Stuck Sync, is to ensure it really is stuck. Sometimes syncing may take a long time or appear stuck but, it's just being slow. Follow these steps to confirm the issue:

  1. Examine the sync status section of your Dash menu. It is in the top bar of the dash and will usually display "All Synced" in green
  2. If it says "Syncing" and then a percentage, examine this percentage. See if it changes or increases. Give it a few minutes to double check that its not just being slow.
  3. If it is still not moving, then you have a stuck sync!

Fixing a Stuck Sync

Fixing a stuck sync, is a little challenging depending on what exactly is wrong so make sure to follow our steps.

First, let's try some steps which are common to many sync issues:

  1. Try restarting Neos, this will re-start the sync process and can sometimes get it unstuck.
  2. Try disabling any mods, plugins or other modifications you have made to Neos, these may affect syncing.

If you've tried these initial steps then let's move on to discovering exactly what's wrong:

  1. Examine your Log Files, Sync issues are usually shown in the "Regular" logs.
  2. The most recent file from the log folder should usually be the one to look at, it's more likely to show a stuck sync.
  3. Scroll through the file looking for the phrase "Sync".
    • This term is usually quite overloaded as some of Neos' internals are also called "Sync".
    • Make sure you're looking for obvious errors, things that have the words "Fail" or "Error" in their text.
  4. Once you've found a relevant log file selection please read below in the following list ("Common Stuck Sync Causes"), to see if you can match any of the problems to your problem.
  5. If you can find a match, click its name in the table to find a dedicated guide just for that problem.
  6. If you cannot find a matching section, or have trouble with reading your log files, then please share a log file in the #questions-help channel, where another user can examine it to see what is wrong.

Common Stuck Sync Causes

Name/Link Example Log File contents Description
Out Of Space Fail Reason: Out of space Your Neos Account's storage is full. Read the Out Of Space page for more help.
Too Many Requests Fail Reason: Response status code does not indicate success: TooManyRequests (429); The Neos Cloud is making too many requests at the moment. Read the Too Many Requests for more help.
Conflict Anything that has the word "Conflict" Your have a sync conflict. Read the Conflict page for more help.

Something else?

If you can't find something that matches the above list. Please report it on our issue tracker or in our Discord. In both cases make sure to provide a log file. For a technical reason on why stuck syncs occur and break the syncing loop, see #3915 on the Neos Public GitHub.