Skip to content

Commit 3e19e7c

Browse files
Copilotthawn
andcommitted
Address review feedback: simplify migration options and remove obsolete sections
Co-authored-by: thawn <1308449+thawn@users.noreply.github.com>
1 parent 175fc8b commit 3e19e7c

File tree

1 file changed

+20
-51
lines changed

1 file changed

+20
-51
lines changed

docs/migration.md

Lines changed: 20 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ If you started ttmp32gme with `--database` or `--library` flags, your data is in
3131

3232
## Migration Steps
3333

34-
### Option 1: Complete Migration (Recommended)
34+
### Option 1: Same-Platform Migration (Recommended)
35+
36+
Use this method when migrating between computers running the same operating system (Linux to Linux, macOS to macOS, Windows to Windows) or between Linux and macOS.
3537

3638
Migrate both database and library to preserve all data and settings.
3739

@@ -52,53 +54,29 @@ Migrate both database and library to preserve all data and settings.
5254
4. Copy the entire directory from your backup to this location
5355
5. Start ttmp32gme - all albums, settings, and files will be available
5456

55-
### Option 2: Database Only Migration
56-
57-
Migrate only the configuration database to preserve settings and album metadata. You'll need to regenerate GME files.
58-
59-
**On the source computer**:
60-
61-
1. Stop ttmp32gme if running
62-
2. Copy `config.sqlite` from the data directory to a USB drive or network location
63-
64-
**On the destination computer**:
57+
### Option 2: Cross-Platform Migration (Windows to macOS/Linux)
6558

66-
1. Install ttmp32gme
67-
2. Stop ttmp32gme if running
68-
3. Copy `config.sqlite` to the data directory
69-
4. Start ttmp32gme
70-
5. Regenerate GME files by clicking "Create GME" for each album in the Library page
59+
Use this method **only** when migrating between Windows and another operating system (macOS or Linux). This process requires re-importing your audio files.
7160

72-
**Note**: Audio files and cover images are stored in the library folder. If you only migrate the database, you'll need to re-upload these files or manually copy the library folder.
61+
**Note**: For migrations between macOS and Linux, use **Option 1** instead.
7362

74-
### Option 3: Library Only Migration
75-
76-
Migrate the library folder while keeping default settings on the new computer.
77-
78-
**On the source computer**:
63+
**On the source computer (Windows)**:
7964

8065
1. Stop ttmp32gme if running
81-
2. Copy the entire `library/` folder to a USB drive or network location
82-
83-
**On the destination computer**:
84-
85-
1. Install ttmp32gme
86-
2. Stop ttmp32gme if running
87-
3. Copy the `library/` folder to the data directory
88-
4. Start ttmp32gme
89-
5. Albums will appear in the Library page with their existing GME files
90-
91-
**Note**: Settings, OID assignments, and metadata are stored in the database. If you only migrate the library, you'll need to reconfigure settings in the Config page.
66+
2. Locate your library folder: `%APPDATA%\ttmp32gme\library\`
67+
3. Copy all album folders from the library to a USB drive or network location
68+
4. Each album folder contains the original MP3 files and cover images
9269

93-
## Cross-Platform Migration
70+
**On the destination computer (macOS/Linux)**:
9471

95-
When migrating between different operating systems (e.g., Windows to Linux):
96-
97-
1. Follow **Option 1** steps above
98-
2. After copying, update the library path in Config page if needed:
99-
- Open Config page in ttmp32gme
100-
- Update "Library Path" to match the new system's path format
101-
- Save configuration
72+
1. Install ttmp32gme (see [Installation](installation.md))
73+
2. Start ttmp32gme to create the initial configuration
74+
3. For each album from your backup:
75+
- Navigate to the Upload page
76+
- Upload the MP3 files from the album folder
77+
- Upload the cover image (if present: `cover.jpg` or `cover.png`)
78+
- Configure album settings (title, artist, OID) to match your original setup
79+
- Click "Create GME" to generate the GME files
10280

10381
## Custom Paths
10482

@@ -118,23 +96,14 @@ After migration:
11896
2. Check Library page - all albums should be visible
11997
3. Check Config page - settings should match your old setup
12098
4. Test printing a control sheet to verify OID codes are preserved
121-
5. If GME files were not migrated, click "Create GME" to regenerate them
12299

123100
## Troubleshooting
124101

125102
**Albums missing after migration**:
126-
- Verify you copied the `config.sqlite` file
103+
- Verify you copied the entire data directory including `config.sqlite`
127104
- Refresh the Library page (F5)
128105
- Check that the database file has read/write permissions
129106

130-
**GME files missing**:
131-
- If you only migrated the database, regenerate GME files using "Create GME" button
132-
- Verify the library folder was copied completely
133-
134-
**Path errors**:
135-
- Update library path in Config page to match the new system
136-
- Ensure the library folder exists and is accessible
137-
138107
**Permission errors**:
139108
- Ensure copied files have proper read/write permissions
140109
- On Linux: `chmod -R u+rw ~/.ttmp32gme/`

0 commit comments

Comments
 (0)