switched to json storage to allow sharing

This commit is contained in:
tom.hempel
2025-10-15 12:20:27 +02:00
parent c15d1d1e49
commit 67dd2de460
7 changed files with 157 additions and 26 deletions

View File

@ -2,6 +2,21 @@
A small and simple Tool to send UDP packages over custom ports to control logic in Unity projects. A small and simple Tool to send UDP packages over custom ports to control logic in Unity projects.
## Storage
All projects and packages are stored in a **JSON file** located in your Documents folder:
- **Windows**: `C:\Users\<YourUsername>\Documents\unityudp_projects.json`
- **macOS**: `~/Documents/unityudp_projects.json`
- **Linux**: `~/Documents/unityudp_projects.json`
This makes it easy to:
- 📤 **Share** projects with other users
- 💾 **Backup** your configurations
- 📝 **Edit** manually if needed (JSON format)
- 🔄 **Version control** with Git
Click the folder icon in the app to see the exact file location on your system.
## Getting Started ## Getting Started
### Prerequisites ### Prerequisites

View File

@ -90,6 +90,53 @@ class _HomeScreenState extends State<HomeScreen> {
); );
} }
Future<void> _showStorageInfo() async {
final filePath = await _storageService.getProjectsFilePath();
if (!mounted) return;
showDialog(
context: context,
builder: (context) => AlertDialog(
title: const Row(
children: [
Icon(Icons.folder_open),
SizedBox(width: 8),
Text('Storage Location'),
],
),
content: Column(
mainAxisSize: MainAxisSize.min,
crossAxisAlignment: CrossAxisAlignment.start,
children: [
const Text(
'Your projects are saved in:',
style: TextStyle(fontWeight: FontWeight.bold),
),
const SizedBox(height: 8),
SelectableText(
filePath,
style: const TextStyle(
fontFamily: 'monospace',
fontSize: 12,
),
),
const SizedBox(height: 16),
const Text(
'You can share this file with other users or back it up for safekeeping.',
style: TextStyle(fontSize: 12),
),
],
),
actions: [
TextButton(
onPressed: () => Navigator.pop(context),
child: const Text('Close'),
),
],
),
);
}
void _showWebWarning() { void _showWebWarning() {
showDialog( showDialog(
context: context, context: context,
@ -137,6 +184,12 @@ class _HomeScreenState extends State<HomeScreen> {
tooltip: 'Web Platform Limitations', tooltip: 'Web Platform Limitations',
), ),
), ),
if (!kIsWeb)
IconButton(
icon: const Icon(Icons.folder),
onPressed: _showStorageInfo,
tooltip: 'Storage Location',
),
IconButton( IconButton(
icon: const Icon(Icons.info_outline), icon: const Icon(Icons.info_outline),
onPressed: _showAboutDialog, onPressed: _showAboutDialog,

View File

@ -1,22 +1,27 @@
import 'dart:convert'; import 'dart:convert';
import 'package:shared_preferences/shared_preferences.dart'; import 'dart:io';
import 'package:path_provider/path_provider.dart';
import '../models/project.dart'; import '../models/project.dart';
class StorageService { class StorageService {
static const String _projectsKey = 'projects'; static const String _projectsFileName = 'unityudp_projects.json';
static const String _currentPortKey = 'current_port';
Future<String> get _localPath async {
final directory = await getApplicationDocumentsDirectory();
return directory.path;
}
Future<File> get _projectsFile async {
final path = await _localPath;
return File('$path/$_projectsFileName');
}
Future<void> saveProjects(List<Project> projects) async { Future<void> saveProjects(List<Project> projects) async {
try { try {
final prefs = await SharedPreferences.getInstance(); final file = await _projectsFile;
final jsonList = projects.map((p) => p.toJson()).toList(); final jsonList = projects.map((p) => p.toJson()).toList();
final jsonString = json.encode(jsonList); final jsonString = const JsonEncoder.withIndent(' ').convert(jsonList);
final success = await prefs.setString(_projectsKey, jsonString); await file.writeAsString(jsonString);
if (!success) {
throw Exception('Failed to save projects to storage');
}
// Force a commit on web
await prefs.reload();
} catch (e) { } catch (e) {
rethrow; rethrow;
} }
@ -24,31 +29,60 @@ class StorageService {
Future<List<Project>> loadProjects() async { Future<List<Project>> loadProjects() async {
try { try {
final prefs = await SharedPreferences.getInstance(); final file = await _projectsFile;
// Reload to ensure we get the latest data
await prefs.reload();
final jsonString = prefs.getString(_projectsKey);
if (jsonString == null || jsonString.isEmpty) { // Check if file exists
if (!await file.exists()) {
return []; return [];
} }
final List<dynamic> jsonList = json.decode(jsonString); final contents = await file.readAsString();
if (contents.isEmpty) {
return [];
}
final List<dynamic> jsonList = json.decode(contents);
return jsonList.map((json) => Project.fromJson(json)).toList(); return jsonList.map((json) => Project.fromJson(json)).toList();
} catch (e) { } catch (e) {
return []; return [];
} }
} }
Future<void> saveCurrentPort(int port) async { Future<String> getProjectsFilePath() async {
final prefs = await SharedPreferences.getInstance(); final file = await _projectsFile;
await prefs.setInt(_currentPortKey, port); return file.path;
} }
Future<int> loadCurrentPort() async { Future<bool> importProjectsFromFile(String filePath) async {
final prefs = await SharedPreferences.getInstance(); try {
return prefs.getInt(_currentPortKey) ?? 8888; final importFile = File(filePath);
if (!await importFile.exists()) {
return false;
}
final contents = await importFile.readAsString();
final List<dynamic> jsonList = json.decode(contents);
final projects = jsonList.map((json) => Project.fromJson(json)).toList();
// Save the imported projects
await saveProjects(projects);
return true;
} catch (e) {
return false;
} }
} }
Future<bool> exportProjectsToFile(String filePath, List<Project> projects) async {
try {
final exportFile = File(filePath);
final jsonList = projects.map((p) => p.toJson()).toList();
final jsonString = const JsonEncoder.withIndent(' ').convert(jsonList);
await exportFile.writeAsString(jsonString);
return true;
} catch (e) {
return false;
}
}
}

View File

@ -35,7 +35,7 @@ class AppAboutDialog extends StatelessWidget {
const Text('• Configure custom UDP ports'), const Text('• Configure custom UDP ports'),
const Text('• Store pre-defined packages'), const Text('• Store pre-defined packages'),
const Text('• Quick send functionality'), const Text('• Quick send functionality'),
const Text('Persistent local storage'), const Text('JSON file storage (easily shareable)'),
const SizedBox(height: 16), const SizedBox(height: 16),
const Divider(), const Divider(),
const SizedBox(height: 16), const SizedBox(height: 16),

View File

@ -5,8 +5,10 @@
import FlutterMacOS import FlutterMacOS
import Foundation import Foundation
import path_provider_foundation
import shared_preferences_foundation import shared_preferences_foundation
func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) { func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
PathProviderPlugin.register(with: registry.registrar(forPlugin: "PathProviderPlugin"))
SharedPreferencesPlugin.register(with: registry.registrar(forPlugin: "SharedPreferencesPlugin")) SharedPreferencesPlugin.register(with: registry.registrar(forPlugin: "SharedPreferencesPlugin"))
} }

View File

@ -360,6 +360,30 @@ packages:
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.9.1" version: "1.9.1"
path_provider:
dependency: "direct main"
description:
name: path_provider
sha256: "50c5dd5b6e1aaf6fb3a78b33f6aa3afca52bf903a8a5298f53101fdaee55bbcd"
url: "https://pub.dev"
source: hosted
version: "2.1.5"
path_provider_android:
dependency: transitive
description:
name: path_provider_android
sha256: "3b4c1fc3aa55ddc9cd4aa6759984330d5c8e66aa7702a6223c61540dc6380c37"
url: "https://pub.dev"
source: hosted
version: "2.2.19"
path_provider_foundation:
dependency: transitive
description:
name: path_provider_foundation
sha256: "16eef174aacb07e09c351502740fa6254c165757638eba1e9116b0a781201bbd"
url: "https://pub.dev"
source: hosted
version: "2.4.2"
path_provider_linux: path_provider_linux:
dependency: transitive dependency: transitive
description: description:

View File

@ -41,6 +41,9 @@ dependencies:
# Local storage for persistence # Local storage for persistence
shared_preferences: ^2.2.2 shared_preferences: ^2.2.2
# File path access
path_provider: ^2.1.2
# JSON serialization # JSON serialization
json_annotation: ^4.9.0 json_annotation: ^4.9.0