Introduction

Welcome! This is the documentation for Round Sync!

Round Sync is a versatile android application that makes use of the venerable Rclone. This allows you to interact with all your favorite Cloud-Providers in an easy-to-use app! We even allow you to automate some of the more tedious tasks!

Anyone is welcome to contribute and help out. However, hate, discrimination and racism are decidedly unwelcome here. If you feel offended by this, you might belong to the group of people who are not welcome. I will not tolerate hate in any way.

🇺🇦 🏳️‍⚧️ 🏳️‍🌈

History

Round Sync has a long history. It was first concieved as "Rclone Explorer" by Patryk Kaczmarkiewicz. After this, x0b took over, with rcx as a new name.

After that it became Round Sync.

Who am I?

I am a computer sience student that does software development in his free time. I like open formats, and rclone makes accessing different protocols as easy as it gets. With Round Sync i am trying to make rclone as accessible as possible on android. Since i forked rcx, i was able to make substantial progress of achieving this goal.

Since i am doing this in my free time, any help is appreciated. This can be in form of contributions(Like reporting bugs or contributing code), but if you want to make a donation, you are more than welcome!

What is Rclone?

Rclone is a command line tool primarily written for Linux, Windows and macOS. It allows you to interface with all the major cloud providers and protocols.

You can find more on their website:

Rclone.org

Usage

Getting Started

Rclone Configuration

If you need to make specific changes to the rclone configuration and you dont want to use this apps user interface, this will explain how you can apply changes manually.

First you need to export your current config. Please refer to this section about exporting.

After you have created your backup, transfer it to the pc of your choice. Then you need to extract all the files in the backup, you can use any program that can extract .zip-files.

The backup is structured the following way:

backup.zip
|-rcx.prefs
|-rcx.json
|-rclone.conf

Assuming you are in the folder where you extracted rclone.conf to, you can use the following command to edit the config with rclone.

rclone --config ./rclone.conf config

It is also possible to manually edit the configuration via text-editor.

When you made all those changes, transfer the configuration file back to your device. Please follow the import guide to restore the changed config.

Warning

With the upcoming overhaul, all available configuration options will be exposed via the UI. It should not be nessessary to edit the configuration in such a manner. There will be no support for changes made this way.

Import/Export

If you want to migrate this application to another device, or restore the configuration, you can refer to this section.

First, open the navigation drawer.

In the options-section you will find both the import and export buttons.

Export:

To export all application-settings, triggers, tasks and remotes, just click the "Export Config"-button. You will then be asked to select a folder where the backup will be stored.

Import:

To restore such a backup, start the application. Then open the navigation drawer, and click the "Import Config"-button. You will then be asked to select a file.

You can either select the backup you created earlier, or a standalone rclone.conf-file.

Access from other Apps

Android File Explorer / Storage Access Framework

Development

This Guide will show you how to get started with developing round sync yourself!

1. Reporting Bugs
2. Suggesting Features
3. Translations
4. Development Setup
5. Roadmap

If you just want to report a bug, please refer to the "Reporting Bugs"-Section.
The same applies to new features: Suggesting Features.

If you want to actively contribute code by implementing a feature or fixing a bug, you can follow the development guide.

Reporting Bugs

If you found that something broke, you can report it here: Round Sync - Issue Tracker. The link will lead you to github, where you will need an account to actually create an issue. Before you do, please search if your issue was already reported. I would also like you to fill out the provided template, this will make sure your issue can be worked on fast.

Suggesting Features

If you have an idea or a suggestion on how to improve this app, you can report it here: Round Sync - Issue Tracker. The link will lead you to github, where you will need an account to actually create an issue. Before you do, please search if your feature was already requested.

Translations

Android Studio

The easiest way to edit translations is via the Android Studio Translations-Editor. You can open it by navigating to the res-folder in the project view (left sidebar). In there, select the values folder and open the strings.xml. Android Studio will now ask you to use the Editor. Select Open editor in the upper-right corner.

Manually

You can also check out the repository without Android Studio, and edit the translation-files directly. The "base"-file is this one: app/src/main/res/values/strings.xml The german translation is in this file: app/src/main/res/values-de/strings.xml As you can see, you need to create an value-XX folder, and then tanslate the strings.xml file. XX corresponds to your language's ISO 639 code.

Wikipedia has a list of valid codes.

Contributions are welcome!

Development Setup

Android Studio

If you have not already installed Android Studio, please do so now. You can get it here:

Android Studio

Clone the Repository

First you need to check out the repository:

$ git clone https://github.com/newhinton/Round-Sync

Alternatively, you can use this url to check out the project via android studio.

https://github.com/newhinton/Round-Sync

You can do so by opening:

File>New...>Project from Version Control

After the Project was imported, you can start coding! When you are ready to build your app to run it on your device or emulator, the build-process will build the app, and rclone. For this you need a working go-installation.

Go

Follow the instructions here: Install Go

You will also need to set up the environmental variables so that the go-executable can be found in GOPATH.

The minimum required go version is 1.19. We currently use 1.21.1.

NDK

To embedd the rclone-binary in the app, you will need the ndk. Please install it via Android Studio in the correct version.

The gradle.properties-file contains some definitions you might need for this.

This specifies the used NDK-version:

de.felixnuesse.extract.ndkVersion=25.2.9519653

Rclone

When this app builds, it automatically builds rclone aswell. For that it is nessessary that you set up Go and the NDK beforehand.

If you want to use a different version of rclone to be build, you can edit the gradle.properties-file:

de.felixnuesse.extract.rCloneVersion=1.63.1

If you did not set up the ndk or go properly, the logs will tell you.

You are now done! Enjoy! If you think this documentation is lacking, you can always make suggestions or change it. In the top-right is a pen-icon which lets you do so. Thanks!

Roadmap

1. Release on Google Play
2. Release on F-Droid (Postponed)
3. Unify Download/Upload/etc-services and notifications
4. Rewrite the java-rclone interface as a library
5. Make the SAF-Integration stable and more easy to use
6. Migration to Bottombar-Design
7. Tablet overhaul
8. Translations

This is the general outline of what i want to do in the near future. This is not a strict order, might change at any time. It also might not reflect my actual roadmap since i might not have updated this roadmap after i changed priorities.

If you want to add something, open a request here!

Frequently Asked Questions

Is it available in Google Play?

Not currently.

Do you plan on releasing it on Google Play?

Yes. However, it will cost a bit.

Wait, you want money?

Since developing apps costs time, and resources like hosting documentation, yes. It wont cost you a months wage, but it will not be free on google play.

However, the f-droid version will be free (and stay free!). I also provide source code via github, so you will never loose access to this app, even if you dont want to pay. I consider you choosing google play over f-droid as you wanting to support me, so thank you very much, it is appreciated!

Is it available in F-Droid?

Sadly no. There is currently an ongoing issue which prevents me from releasing. I am tracking this and will update the corresponsive github-ticket when i have more information.

You can find the ticket here: Github.com: Publish on F-Droid #1

I cant figure out how to set up my remote with a specific setting.

That is not a question. Who is writing his FAQ?

Anyway, you can see here how you can manually edit a configuration.

Can i edit a remote?

Yes! The ability to edit a remote was added with the dynamic config provider. You can now choose to edit a remote via the three-dot-menu in the remote list. However, you cannot rename a remote for techical reasons.

Can you implement X?

Maybe, head over to the issue tracker and open a ticket! We can discuss your ideas there.

Can i donate?

Sure! Any help is appreciated:

Donations

Can i donate?

Sure! Any help is appreciated:

If you want to contribute to this app but dont have funds to spare, you can also contribute in different ways like adding translations or working on bug-reports. Nothing is mandatory though, you can just use the app without helping out! Have fun!

License

This app is released under the terms of the GPLv3 license. Community contributions are licensed under the MIT license, and CLA Assistant will ask you to confirm a CLA stating that if create a PR.

This is a fork of RCX by x0b which is itself a fork of rcloneExplorer by Patryk Kaczmarkiewicz. For the original repository, see kaczmarkiewiczp/rcloneExplorer or x0b/rcx. If you want to convey a modified version (fork), we ask you to use a different name, app icon and package id as well as proper attribution to avoid user confusion.

Copyright Notes for this site