flixcoo/cabo-counter
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity

Merge pull request #82 from flixcoo/enhance/78-rework-im--and-exporting-game-mechanism

Browse Source 
Rework im- and exporting game mechanism
This commit is contained in:
Felix Kirchner
2025-07-08 00:02:22 +02:00
committed by GitHub
parent a13a3ac0c9 c279acfdeb
commit 420dcae58f
10 changed files with 364 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

291
assets/game-schema.json Normal file
View File

@@ -0,0 +1,291 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Generated schema for a single cabo counter game",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"gameTitle": {
"type": "string"
},
"players": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"pointLimit": {
"type": "integer"
},
"caboPenalty": {
"type": "integer"
},
"isPointsLimitEnabled": {
"type": "boolean"
},
"isGameFinished": {
"type": "boolean"
},
"winner": {
"type": "string"
},
"roundNumber": {
"type": "integer"
},
"playerScores": {
"type": "array",
"items": [
{
"type": "integer"
},
{
"type": "integer"
}
]
},
"roundList": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"roundNum": {
"type": "integer"
},
"caboPlayerIndex": {
"type": "integer"
},
"kamikazePlayerIndex": {
"type": "null"
},
"scores": {
"type": "array",
"items": [
{
"type": "integer"
},
{
"type": "integer"
}
]
},
"scoreUpdates": {
"type": "array",
"items": [
{
"type": "integer"
},
{
"type": "integer"
}
]
}
},
"required": [
"roundNum",
"caboPlayerIndex",
"kamikazePlayerIndex",
"scores",
"scoreUpdates"
]
},
{
"type": "object",
"properties": {
"roundNum": {
"type": "integer"
},
"caboPlayerIndex": {
"type": "integer"
},
"kamikazePlayerIndex": {
"type": "null"
},
"scores": {
"type": "array",
"items": [
{
"type": "integer"
},
{
"type": "integer"
}
]
},
"scoreUpdates": {
"type": "array",
"items": [
{
"type": "integer"
},
{
"type": "integer"
}
]
}
},
"required": [
"roundNum",
"caboPlayerIndex",
"kamikazePlayerIndex",
"scores",
"scoreUpdates"
]
},
{
"type": "object",
"properties": {
"roundNum": {
"type": "integer"
},
"caboPlayerIndex": {
"type": "integer"
},
"kamikazePlayerIndex": {
"type": "null"
},
"scores": {
"type": "array",
"items": [
{
"type": "integer"
},
{
"type": "integer"
}
]
},
"scoreUpdates": {
"type": "array",
"items": [
{
"type": "integer"
},
{
"type": "integer"
}
]
}
},
"required": [
"roundNum",
"caboPlayerIndex",
"kamikazePlayerIndex",
"scores",
"scoreUpdates"
]
},
{
"type": "object",
"properties": {
"roundNum": {
"type": "integer"
},
"caboPlayerIndex": {
"type": "integer"
},
"kamikazePlayerIndex": {
"type": "null"
},
"scores": {
"type": "array",
"items": [
{
"type": "integer"
},
{
"type": "integer"
}
]
},
"scoreUpdates": {
"type": "array",
"items": [
{
"type": "integer"
},
{
"type": "integer"
}
]
}
},
"required": [
"roundNum",
"caboPlayerIndex",
"kamikazePlayerIndex",
"scores",
"scoreUpdates"
]
},
{
"type": "object",
"properties": {
"roundNum": {
"type": "integer"
},
"caboPlayerIndex": {
"type": "integer"
},
"kamikazePlayerIndex": {
"type": "null"
},
"scores": {
"type": "array",
"items": [
{
"type": "integer"
},
{
"type": "integer"
}
]
},
"scoreUpdates": {
"type": "array",
"items": [
{
"type": "integer"
},
{
"type": "integer"
}
]
}
},
"required": [
"roundNum",
"caboPlayerIndex",
"kamikazePlayerIndex",
"scores",
"scoreUpdates"
]
}
]
}
},
"required": [
"id",
"createdAt",
"gameTitle",
"players",
"pointLimit",
"caboPenalty",
"isPointsLimitEnabled",
"isGameFinished",
"winner",
"roundNumber",
"playerScores",
"roundList"
]
}

2
assets/schema.json → assets/game_list-schema.json
View File

@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Generated schema for cabo game data",
"title": "Generated schema for the cabo counter game data",
"type": "array",
"items": {
"type": "object",

5
lib/main.dart
View File

@@ -2,7 +2,6 @@ import 'package:cabo_counter/l10n/app_localizations.dart';
import 'package:cabo_counter/services/config_service.dart';
import 'package:cabo_counter/services/local_storage_service.dart';
import 'package:cabo_counter/utility/custom_theme.dart';
import 'package:cabo_counter/utility/globals.dart';
import 'package:cabo_counter/views/tab_view.dart';
import 'package:flutter/cupertino.dart';
import 'package:flutter/services.dart';
@@ -12,8 +11,8 @@ Future<void> main() async {
await SystemChrome.setPreferredOrientations(
[DeviceOrientation.portraitUp, DeviceOrientation.portraitDown]);
await ConfigService.initConfig();
Globals.pointLimit = await ConfigService.getPointLimit();
Globals.caboPenalty = await ConfigService.getCaboPenalty();
ConfigService.pointLimit = await ConfigService.getPointLimit();
ConfigService.caboPenalty = await ConfigService.getCaboPenalty();
runApp(const App());
}

13
lib/services/config_service.dart
View File

@@ -1,4 +1,3 @@
import 'package:cabo_counter/utility/globals.dart';
import 'package:shared_preferences/shared_preferences.dart';
/// This class handles the configuration settings for the app.
@@ -7,8 +6,12 @@ import 'package:shared_preferences/shared_preferences.dart';
class ConfigService {
static const String _keyPointLimit = 'pointLimit';
static const String _keyCaboPenalty = 'caboPenalty';
static const int _defaultPointLimit = 100; // Default Value
static const int _defaultCaboPenalty = 5; // Default Value
// Actual values used in the app
static int pointLimit = 100;
static int caboPenalty = 5;
// Default values
static const int _defaultPointLimit = 100;
static const int _defaultCaboPenalty = 5;
static Future<void> initConfig() async {
final prefs = await SharedPreferences.getInstance();
@@ -48,8 +51,8 @@ class ConfigService {
/// Resets the configuration to default values.
static Future<void> resetConfig() async {
Globals.pointLimit = _defaultPointLimit;
Globals.caboPenalty = _defaultCaboPenalty;
ConfigService.pointLimit = _defaultPointLimit;
ConfigService.caboPenalty = _defaultCaboPenalty;
final prefs = await SharedPreferences.getInstance();
await prefs.setInt(_keyPointLimit, _defaultPointLimit);
await prefs.setInt(_keyCaboPenalty, _defaultCaboPenalty);

59
lib/services/local_storage_service.dart
View File

@@ -70,7 +70,7 @@ class LocalStorageService {
return false;
}
if (!await validateJsonSchema(jsonString)) {
if (!await validateJsonSchema(jsonString, true)) {
print(
'[local_storage_service.dart] Die Datei konnte nicht validiert werden');
gameManager.gameList = [];
@@ -162,16 +162,28 @@ class LocalStorageService {
try {
final jsonString = await _readFileContent(path.files.single);
if (!await validateJsonSchema(jsonString)) {
if (await validateJsonSchema(jsonString, true)) {
// Checks if the JSON String is in the gameList format
final jsonData = json.decode(jsonString) as List<dynamic>;
List<GameSession> importedList = jsonData
.map((jsonItem) =>
GameSession.fromJson(jsonItem as Map<String, dynamic>))
.toList();
for (GameSession s in importedList) {
importSession(s);
}
} else if (await validateJsonSchema(jsonString, false)) {
// Checks if the JSON String is in the single game format
final jsonData = json.decode(jsonString) as Map<String, dynamic>;
importSession(GameSession.fromJson(jsonData));
} else {
return ImportStatus.validationError;
}
final jsonData = json.decode(jsonString) as List<dynamic>;
gameManager.gameList = jsonData
.map((jsonItem) =>
GameSession.fromJson(jsonItem as Map<String, dynamic>))
.toList();
print(
'[local_storage_service.dart] Die Datei wurde erfolgreich Importiertn');
'[local_storage_service.dart] Die Datei wurde erfolgreich Importiert');
await saveGameSessions();
return ImportStatus.success;
} on FormatException catch (e) {
@@ -185,6 +197,18 @@ class LocalStorageService {
}
}
/// Imports a single game session into the gameList.
static Future<void> importSession(GameSession session) async {
if (gameManager.gameExistsInGameList(session.id)) {
print(
'[local_storage_service.dart] Die Session mit der ID ${session.id} existiert bereits. Sie wird überschrieben.');
gameManager.removeGameSessionById(session.id);
}
gameManager.addGameSession(session);
print(
'[local_storage_service.dart] Die Session mit der ID ${session.id} wurde erfolgreich importiert.');
}
/// Helper method to read file content from either bytes or path
static Future<String> _readFileContent(PlatformFile file) async {
if (file.bytes != null) return utf8.decode(file.bytes!);
@@ -194,15 +218,28 @@ class LocalStorageService {
}
/// Validates the JSON data against the schema.
static Future<bool> validateJsonSchema(String jsonString) async {
/// This method checks if the provided [jsonString] is valid against the
/// JSON schema. It takes a boolean [isGameList] to determine
/// which schema to use (game list or single game).
static Future<bool> validateJsonSchema(
String jsonString, bool isGameList) async {
final String schemaString;
if (isGameList) {
schemaString =
await rootBundle.loadString('assets/game_list-schema.json');
} else {
schemaString = await rootBundle.loadString('assets/game-schema.json');
}
try {
final schemaString = await rootBundle.loadString('assets/schema.json');
final schema = JsonSchema.create(json.decode(schemaString));
final jsonData = json.decode(jsonString);
final result = schema.validate(jsonData);
if (result.isValid) {
print('[local_storage_service.dart] JSON ist erfolgreich validiert.');
print(
'[local_storage_service.dart] JSON ist erfolgreich validiert. Typ: ${isGameList ? 'Game List' : 'Single Game'}');
return true;
}
print(

2
lib/utility/globals.dart
View File

@@ -1,5 +1,3 @@
class Globals {
static int pointLimit = 100;
static int caboPenalty = 5;
static String appDevPhase = 'Beta';
}

10
lib/views/create_game_view.dart
View File

@@ -1,8 +1,8 @@
import 'package:cabo_counter/data/game_manager.dart';
import 'package:cabo_counter/data/game_session.dart';
import 'package:cabo_counter/l10n/app_localizations.dart';
import 'package:cabo_counter/services/config_service.dart';
import 'package:cabo_counter/utility/custom_theme.dart';
import 'package:cabo_counter/utility/globals.dart';
import 'package:cabo_counter/views/active_game_view.dart';
import 'package:cabo_counter/views/mode_selection_view.dart';
import 'package:flutter/cupertino.dart';
@@ -96,7 +96,7 @@ class _CreateGameViewState extends State<CreateGameView> {
_isPointsLimitEnabled == null
? AppLocalizations.of(context).select_mode
: (_isPointsLimitEnabled!
? '${Globals.pointLimit} ${AppLocalizations.of(context).points}'
? '${ConfigService.pointLimit} ${AppLocalizations.of(context).points}'
: AppLocalizations.of(context).unlimited),
),
const SizedBox(width: 3),
@@ -108,7 +108,7 @@ class _CreateGameViewState extends State<CreateGameView> {
context,
CupertinoPageRoute(
builder: (context) => ModeSelectionMenu(
pointLimit: Globals.pointLimit,
pointLimit: ConfigService.pointLimit,
),
),
);
@@ -315,8 +315,8 @@ class _CreateGameViewState extends State<CreateGameView> {
createdAt: DateTime.now(),
gameTitle: _gameTitleTextController.text,
players: players,
pointLimit: Globals.pointLimit,
caboPenalty: Globals.caboPenalty,
pointLimit: ConfigService.pointLimit,
caboPenalty: ConfigService.caboPenalty,
isPointsLimitEnabled: _isPointsLimitEnabled!,
);
final index = await gameManager.addGameSession(gameSession);

4
lib/views/main_menu_view.dart
View File

@@ -1,8 +1,8 @@
import 'package:cabo_counter/data/game_manager.dart';
import 'package:cabo_counter/l10n/app_localizations.dart';
import 'package:cabo_counter/services/config_service.dart';
import 'package:cabo_counter/services/local_storage_service.dart';
import 'package:cabo_counter/utility/custom_theme.dart';
import 'package:cabo_counter/utility/globals.dart';
import 'package:cabo_counter/views/active_game_view.dart';
import 'package:cabo_counter/views/create_game_view.dart';
import 'package:cabo_counter/views/settings_view.dart';
@@ -199,7 +199,7 @@ class _MainMenuViewState extends State<MainMenuView> {
/// If [pointLimit] is true, it returns '101 Punkte', otherwise it returns 'Unbegrenzt'.
String _translateGameMode(bool pointLimit) {
if (pointLimit) {
return '${Globals.pointLimit} ${AppLocalizations.of(context).points}';
return '${ConfigService.pointLimit} ${AppLocalizations.of(context).points}';
}
return AppLocalizations.of(context).unlimited;
}

8
lib/views/settings_view.dart
View File

@@ -52,14 +52,14 @@ class _SettingsViewState extends State<SettingsView> {
AppLocalizations.of(context).cabo_penalty_subtitle),
trailing: Stepper(
key: _stepperKey1,
initialValue: Globals.caboPenalty,
initialValue: ConfigService.caboPenalty,
minValue: 0,
maxValue: 50,
step: 1,
onChanged: (newCaboPenalty) {
setState(() {
ConfigService.setCaboPenalty(newCaboPenalty);
Globals.caboPenalty = newCaboPenalty;
ConfigService.caboPenalty = newCaboPenalty;
});
},
),
@@ -73,14 +73,14 @@ class _SettingsViewState extends State<SettingsView> {
Text(AppLocalizations.of(context).point_limit_subtitle),
trailing: Stepper(
key: _stepperKey2,
initialValue: Globals.pointLimit,
initialValue: ConfigService.pointLimit,
minValue: 30,
maxValue: 1000,
step: 10,
onChanged: (newPointLimit) {
setState(() {
ConfigService.setPointLimit(newPointLimit);
Globals.pointLimit = newPointLimit;
ConfigService.pointLimit = newPointLimit;
});
},
),

5
pubspec.yaml
View File

@@ -2,7 +2,7 @@ name: cabo_counter
description: "Mobile app for the card game Cabo"
publish_to: 'none'
version: 0.3.7+325
version: 0.3.8+327
environment:
sdk: ^3.5.4
@@ -39,4 +39,5 @@ flutter:
uses-material-design: false
assets:
- assets/cabo_counter-logo_rounded.png
- assets/schema.json
- assets/game_list-schema.json
- assets/game-schema.json