Ftp Sync 3DS: Difference between revisions

From GameBrew
(Created page with "{{Infobox-3DS-Homebrews | title = Ftp Sync | image = https://dlhb.gamebrew.org/3dshomebrew/Ftp-Sync-3DS.jpg|250px | type = PC Utilities | version = unknown | lastupdated = 202...")
 
No edit summary
Line 1: Line 1:
{{Infobox-3DS-Homebrews
{{Infobox-3DS-Homebrews
| title = Ftp Sync
| title = Ftp Sync
| image = https://dlhb.gamebrew.org/3dshomebrew/Ftp-Sync-3DS.jpg|250px
| type = PC Utilities
| type = PC Utilities
| version = unknown
| version = 2021
| lastupdated = 2021/07/22
| lastupdated = 2021/07/22
| licence = Mixed
| licence = Mixed
| author = branflakes2
| author = branflakes2
| website = https://github.com/branflakes2/ftp_sync
| website = https://github.com/branflakes2/ftp_sync
| download = https://dlhb.gamebrew.org/3dshomebrew/Ftp-Sync-3DS.rar
| download = https://dlhb.gamebrew.org/3dshomebrew/ftp_sync.7z
| source = https://github.com/branflakes2/ftp_sync
| source = https://github.com/branflakes2/ftp_sync
}}
}}
<youtube></youtube>
==ftp sync==


# ftp sync
Sync file pairs over ftp and apply patches to them. Useful for using [https://github.com/mtheall/ftpd ftpd] to transfer ROM save files to and from your DS if you also play on an emulator. Setup a cron job to check for your DS's ftp server periodically to setup automatic syncing.


Sync file pairs over ftp and apply patches to them. Useful for using [ftpd](https://github.com/mtheall/ftpd) to transfer ROM save files to and from your DS if you also play on an emulator. Setup a cron job to check for your DS's ftp server periodically to setup automatic syncing.
== Installation==


## Installation
Clone this repo, cd into it, pip3 install .


Clone this repo, cd into it, `pip3 install .`
== Config file format==
 
## Config file format


Default config file location:
Default config file location:
- Windows: `Documents\ftp_sync\ftp_sync.yaml`
* Windows: Documents\ftp_sync\ftp_sync.yaml
- Linux/MacOS: `~/.config/ftp_sync/ftp_sync.yaml`
* Linux/MacOS: ~/.config/ftp_sync/ftp_sync.yaml


Use either yaml or json. An example yaml file is provided with all of the currently supported options.
Use either yaml or json. An example yaml file is provided with all of the currently supported options.
Line 31: Line 28:
If the patcher option is not specified, files will be transfered unmodified.
If the patcher option is not specified, files will be transfered unmodified.


## Automatic sync behavior
== Automatic sync behavior==


On your first run, you'll likely have to specify one of the to/from commands if both remote and local files exist.
On your first run, you'll likely have to specify one of the to/from commands if both remote and local files exist.


- Will sync if either remote or local file do not exist
* Will sync if either remote or local file do not exist
- Will sync if either local or remote files change, not both.
* Will sync if either local or remote files change, not both.
- Will not sync if both files change
* Will not sync if both files change


## Usage
== Usage==


```
Usage: python -m ftp_sync [OPTIONS] COMMAND [ARGS]...
Usage: python -m ftp_sync [OPTIONS] COMMAND [ARGS]...


Options:
'''Options:'''
-c, --config-file TEXT Yaml or json config file defining connection and
 
sync pair settings
* -c, --config-file TEXT Yaml or json config file defining connection and sync pair settings
-d, --debug
* -d, --debug
--help Show this message and exit.
* --help Show this message and exit.


Commands:
'''Commands:'''
sync Automatically sync a specified sync pair.
* sync Automatically sync a specified sync pair.
sync-all Automatically sync all sync pairs.
* sync-all Automatically sync all sync pairs.
sync-all-from Sync all sync pairs remote to local.
* sync-all-from Sync all sync pairs remote to local.
sync-all-to Sync all sync pairs local to remote.
* sync-all-to Sync all sync pairs local to remote.
sync-from Sync a pair remote to local.
* sync-from Sync a pair remote to local.
sync-to Sync a pair local to remote.
* sync-to Sync a pair local to remote.
```


The singular sync commands (the ones that aren't sync-all\*) take a `-n/--name` argument which specifies the sync pair to use.
The singular sync commands (the ones that aren't sync-all\*) take a -n/--name argument which specifies the sync pair to use.


Ex: `python3 -m ftp_sync sync -n pokemon_pearl` will sync the `pokemon_pearl` sync pair in the example yaml file.
Ex: python3 -m ftp_sync sync -n pokemon_pearl will sync the pokemon_pearl sync pair in the example yaml file.


## Future work
== Future work==


- [x] Windows support
* [x] Windows support
- [ ] Add directory sync support
* [ ] Add directory sync support
- [ ] Sync between multiple sources/servers
* [ ] Sync between multiple sources/servers
- [ ] Cleanup old backup files
* [ ] Cleanup old backup files
- [ ] Define and enforce config file schema
* [ ] Define and enforce config file schema
- [ ] Add more patchers (Would love to extract/inject saves from/to VC)
* [ ] Add more patchers (Would love to extract/inject saves from/to VC)
- [ ] Make this README better
* [ ] Make this README better
- [ ] If enough people like this I'll consider adding it to pypi and turning this into a real REPO with CI, unit tests, etc
* [ ] If enough people like this I'll consider adding it to pypi and turning this into a real REPO with CI, unit tests, etc
- [ ] Suggestions?
* [ ] Suggestions?


[[Category:PC utilities for 3DS homebrew]]
[[Category:PC utilities for 3DS homebrew]]
[[Category:PC utilities for 3DS homebrew]]

Revision as of 07:48, 27 September 2021

Template:Infobox-3DS-Homebrews

ftp sync

Sync file pairs over ftp and apply patches to them. Useful for using ftpd to transfer ROM save files to and from your DS if you also play on an emulator. Setup a cron job to check for your DS's ftp server periodically to setup automatic syncing.

Installation

Clone this repo, cd into it, pip3 install .

Config file format

Default config file location:

  • Windows: Documents\ftp_sync\ftp_sync.yaml
  • Linux/MacOS: ~/.config/ftp_sync/ftp_sync.yaml

Use either yaml or json. An example yaml file is provided with all of the currently supported options.

If the patcher option is not specified, files will be transfered unmodified.

Automatic sync behavior

On your first run, you'll likely have to specify one of the to/from commands if both remote and local files exist.

  • Will sync if either remote or local file do not exist
  • Will sync if either local or remote files change, not both.
  • Will not sync if both files change

Usage

Usage: python -m ftp_sync [OPTIONS] COMMAND [ARGS]...

Options:

  • -c, --config-file TEXT Yaml or json config file defining connection and sync pair settings
  • -d, --debug
  • --help Show this message and exit.

Commands:

  • sync Automatically sync a specified sync pair.
  • sync-all Automatically sync all sync pairs.
  • sync-all-from Sync all sync pairs remote to local.
  • sync-all-to Sync all sync pairs local to remote.
  • sync-from Sync a pair remote to local.
  • sync-to Sync a pair local to remote.

The singular sync commands (the ones that aren't sync-all\*) take a -n/--name argument which specifies the sync pair to use.

Ex: python3 -m ftp_sync sync -n pokemon_pearl will sync the pokemon_pearl sync pair in the example yaml file.

Future work

  • [x] Windows support
  • [ ] Add directory sync support
  • [ ] Sync between multiple sources/servers
  • [ ] Cleanup old backup files
  • [ ] Define and enforce config file schema
  • [ ] Add more patchers (Would love to extract/inject saves from/to VC)
  • [ ] Make this README better
  • [ ] If enough people like this I'll consider adding it to pypi and turning this into a real REPO with CI, unit tests, etc
  • [ ] Suggestions?
Retrieved from ‘https://www.gamebrew.org/index.php?title=Ftp_Sync_3DS&oldid=37475’

Advertising: