• Overview
    • Introduction
    • User Interface Description
    • Installing Umajin
    • Shortcuts
    • Asset Management
    • Responsive Content
    • Project Icon
    • Text Styles
    • Guidewires
    • Presets
    • Glossary
    • Multi-user
  • Components
    • Intro
    • Page
    • Basic
      • Arrow
      • Button
      • Circle
      • HTML Article
      • Image
      • Image Zoomer
      • Nine Slice
      • Rectangle
      • Text
      • Tiler
      • Toggle Button
      • Web View
    • Navigation
      • Carousel
      • Dropdown Menu
      • Glass Shelf
      • Hamburger Menu
      • Tool Bar
    • Data Driven
      • Animated Feed
      • Dynamic Article
      • Feed Item View
      • Feed List
    • Forms
      • Form
      • Text Entry
    • Layout
      • Gallery
      • Group
      • Layout Group
      • Scroll Panel
    • Media
      • 3D Model
      • Spine Animation
      • Lottie Animation
      • Avatar
      • Canvas
      • Particle
      • Render Kit
      • Speech Player
      • Video
    • Maps
      • Google Maps
      • Offline Map
      • Offline Map Route Editor
      • Map creation guide
      • Beacon installation for indoor mapping
    • Internet of Things (IoT)
      • Bluetooth BLE
    • Masters
    • Custom Components
  • Actions
    • Add and Configure Actions
    • Basic Actions
    • Navigation Actions
    • Layout Actions
    • Appearance Actions
    • Animation Actions
    • Media Actions
    • Avatar Actions
    • Gallery Actions
    • Form Actions
    • Data Driven Actions
    • Maps Actions
    • IOT (Internet of Things) Actions
    • Advanced Actions
    • Custom Actions
  • Tutorials
  • Cloud Services
    • Overview of Cloud Services
    • Google Analytics
    • Umajin Analytics
  • Publishing
    • Introduction
    • Umajin Editor Lite
    • iOS – Apple App Store
    • Android – Google Play Store
    • Mac
    • Windows
Menu
  • Overview
    • Introduction
    • User Interface Description
    • Installing Umajin
    • Shortcuts
    • Asset Management
    • Responsive Content
    • Project Icon
    • Text Styles
    • Guidewires
    • Presets
    • Glossary
    • Multi-user
  • Components
    • Intro
    • Page
    • Basic
      • Arrow
      • Button
      • Circle
      • HTML Article
      • Image
      • Image Zoomer
      • Nine Slice
      • Rectangle
      • Text
      • Tiler
      • Toggle Button
      • Web View
    • Navigation
      • Carousel
      • Dropdown Menu
      • Glass Shelf
      • Hamburger Menu
      • Tool Bar
    • Data Driven
      • Animated Feed
      • Dynamic Article
      • Feed Item View
      • Feed List
    • Forms
      • Form
      • Text Entry
    • Layout
      • Gallery
      • Group
      • Layout Group
      • Scroll Panel
    • Media
      • 3D Model
      • Spine Animation
      • Lottie Animation
      • Avatar
      • Canvas
      • Particle
      • Render Kit
      • Speech Player
      • Video
    • Maps
      • Google Maps
      • Offline Map
      • Offline Map Route Editor
      • Map creation guide
      • Beacon installation for indoor mapping
    • Internet of Things (IoT)
      • Bluetooth BLE
    • Masters
    • Custom Components
  • Actions
    • Add and Configure Actions
    • Basic Actions
    • Navigation Actions
    • Layout Actions
    • Appearance Actions
    • Animation Actions
    • Media Actions
    • Avatar Actions
    • Gallery Actions
    • Form Actions
    • Data Driven Actions
    • Maps Actions
    • IOT (Internet of Things) Actions
    • Advanced Actions
    • Custom Actions
  • Tutorials
  • Cloud Services
    • Overview of Cloud Services
    • Google Analytics
    • Umajin Analytics
  • Publishing
    • Introduction
    • Umajin Editor Lite
    • iOS – Apple App Store
    • Android – Google Play Store
    • Mac
    • Windows
Uncategorized > Managing project files outside Umajin Cloud (No sync mode)
Managing project files outside Umajin Cloud (No sync mode)
Uncategorized
  
February 1, 2021
  
Aaron Lawrence

With the release of Umajin Editor 3.6.1 we offer the ability to use “No sync mode” for individual projects.

In this mode, Umajin Editor will not use Umajin Cloud to synchronize project files. Instead, it will simply save and load them from local files, and it’s up to you to store the files externally, such as in a version control system (VCS) like Git.

Multi-user editing is also disabled in No Sync Mode, because that relies on keeping all users in sync on files (especially the project.u file).

Initial sync

When you first open a project that is in No Sync Mode, Umajin Editor will download it one time, to give you a starting point. This will be whatever was last pushed to the cloud.

Push to cloud for Umajin Editor Lite

When you wish to test the project in Umajin Editor Lite, you need to use the new File > Push to Cloud menu.

This will first do a local save (same as File > Save) and then push to the Umajin Cloud, the current local files on your computer. This is a one-way push; any changes on the server by another user will be overwritten, including deleting or adding files.

How to opt-in to No Sync Mode

By default, any new or cloned project created with Umajin Editor is in normal sync mode, using Umajin Cloud to store project files.

If you wish to use No Sync Mode on a project, please contact Umajin support with the details of your project including the project ID.

Identifying projects sync mode

In the “Open project” popup, you can tell whether a project is in normal Umajin cloud sync mode, or no sync mode, by looking at the info panel on the right.

How to manage files locally

Umajin Editor expects project files to be stored in your user data folders, even if using No Sync Mode.

Windows: C:\Users\<username>\AppData\Roaming\umajin\projects\<project ID>

MacOS: /Users/<username>/Library/umajin/projects/<project ID>

Use File – Open Resources Folder to open this location.

You can then setup external tools to manage the files in this location.

Special files used by Umajin Editor

Umajin uses many special files to store data and meta-data about the project.

PathFunctionWhat to do

Project definition

These files form basic information about the project and should be stored.

project.uLast/current saveStore.
version.txtProject version numberStore

Local working data

These are temporary files and local data storage for the editor, and should be ignored.

.sync_temp

.sync_last

.sync_base

.sync_merge

Working folders for sync to Umajin CloudIgnore
*.partTemporary download filesIgnore
cache/*Feeds, web resources and local databasesIgnore
temp/*User data and temporary working filesIgnore
project_backup.uUnsaved changesIgnore
project_old_copy.uPre-save copyIgnore

Tracking local state

The editor tracks some settings and other status locally, this must not be stored as it differes between editors.

cache/settings.dbProject settingsIgnore
multi_user_changes.jsonUnsent changesIgnore
revision.txtLast synched project revision

Ignore.

In no sync mode, this is ignored except for being written after each Push to Cloud.

revision_old.txtPre-save revisionIgnore
page_previews/current_orientation.txtCurrent device and orientationIgnore

Generated meta-data

This data is generated by the editor on each save or push to cloud. Changes need not be stored, as they can be regenerated each time.

project.uzCompressed version of project.uStore or ignore
cache_manifest.txtList of files in cache folderStore or ignore
fonts/font_manifest.txtList of font filesStore or ignore
manifest/package.txtFiles for publishing appStore or ignore
page_previews/*.pngThumbnails of pagesStore or ignore
page_previews/project_icon.pngAndroid project icon for project listingsStore or ignore
scripts/script_manifest.txtList of script filesStore or ignore

Compared to Offline Mode

Offline mode allows the editor to work in a limited way when offline. It has some of the same behaviours as No Sync Mode; files are only saved and loaded locally.

However No Sync Mode also provides the Push to Cloud option to allow sending to Umajin Cloud without concern of conflicts with other users; it also allows the app to work normally making web calls for content such as feeds and credentials. The previous option to “allow HTTP calls while offline” has been removed as No Sync Mode solves this more cleanly.

 

  • Umajin
  • Developers
  • Support Home
Menu
  • Umajin
  • Developers
  • Support Home