minecraft-server-creator 3.0.0__tar.gz → 3.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. {minecraft_server_creator-3.0.0/src/minecraft_server_creator.egg-info → minecraft_server_creator-3.1.0}/PKG-INFO +27 -3
  2. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/README.md +25 -1
  3. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/pyproject.toml +2 -2
  4. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/config/settings.py +5 -0
  5. minecraft_server_creator-3.1.0/src/mcsc_gui/core/changelog.py +140 -0
  6. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/core/notifier.py +11 -0
  7. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/core/os_utils.py +15 -0
  8. minecraft_server_creator-3.1.0/src/mcsc_gui/core/server_manager.py +835 -0
  9. minecraft_server_creator-3.1.0/src/mcsc_gui/core/server_prefs.py +70 -0
  10. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/core/user_settings.py +34 -1
  11. minecraft_server_creator-3.1.0/src/mcsc_gui/localization/it.py +265 -0
  12. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/qt_main.py +4 -3
  13. minecraft_server_creator-3.1.0/src/mcsc_gui/static/changelog.json +63 -0
  14. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/backup_actions.py +70 -0
  15. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/config_files.py +15 -0
  16. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/dialogs/app_settings.py +63 -7
  17. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/dialogs/clone_server.py +146 -0
  18. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/dialogs/confirm_quit.py +10 -5
  19. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/dialogs/delete_server.py +14 -2
  20. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/dialogs/import_server.py +252 -0
  21. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/dialogs/restore_backup.py +49 -0
  22. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/dialogs/whats_new.py +156 -0
  23. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/main_window.py +146 -22
  24. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/navigator.py +27 -3
  25. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/pages/dashboard.py +26 -2
  26. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/pages/server_backups.py +94 -0
  27. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/pages/server_base.py +198 -0
  28. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/pages/server_configuration.py +74 -0
  29. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/pages/server_console.py +43 -0
  30. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/pages/server_overview.py +221 -0
  31. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/pages/server_settings.py +169 -0
  32. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/server_events.py +13 -1
  33. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/tasks.py +53 -2
  34. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/theme/icons.py +3 -0
  35. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/theme/qss.py +8 -0
  36. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/widgets/backup_list.py +225 -0
  37. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/console.py +9 -2
  38. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/widgets/context_menu.py +109 -0
  39. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/empty_state.py +3 -2
  40. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/widgets/server_card.py +135 -0
  41. minecraft_server_creator-3.1.0/src/mcsc_gui/ui/widgets/sidebar.py +217 -0
  42. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/stat_tile.py +21 -6
  43. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/status_badge.py +22 -9
  44. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0/src/minecraft_server_creator.egg-info}/PKG-INFO +27 -3
  45. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/minecraft_server_creator.egg-info/SOURCES.txt +20 -2
  46. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/minecraft_server_creator.egg-info/requires.txt +1 -1
  47. minecraft_server_creator-3.1.0/tests/test_backups.py +402 -0
  48. minecraft_server_creator-3.1.0/tests/test_changelog.py +92 -0
  49. minecraft_server_creator-3.1.0/tests/test_clone.py +166 -0
  50. minecraft_server_creator-3.1.0/tests/test_draft_changelog.py +118 -0
  51. minecraft_server_creator-3.0.0/src/mcsc_gui/core/server_manager.py +0 -327
  52. minecraft_server_creator-3.0.0/src/mcsc_gui/localization/it.py +0 -142
  53. minecraft_server_creator-3.0.0/src/mcsc_gui/ui/dialogs/edit_server.py +0 -79
  54. minecraft_server_creator-3.0.0/src/mcsc_gui/ui/pages/server_detail.py +0 -247
  55. minecraft_server_creator-3.0.0/src/mcsc_gui/ui/widgets/server_card.py +0 -68
  56. minecraft_server_creator-3.0.0/src/mcsc_gui/ui/widgets/sidebar.py +0 -103
  57. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/LICENSE +0 -0
  58. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/setup.cfg +0 -0
  59. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/__init__.py +0 -0
  60. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/__main__.py +0 -0
  61. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/_pymcsc_check.py +0 -0
  62. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/core/__init__.py +0 -0
  63. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/core/async_bridge.py +0 -0
  64. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/core/logger.py +0 -0
  65. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/core/migration.py +0 -0
  66. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/core/shortcuts.py +0 -0
  67. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/core/shutdown.py +0 -0
  68. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/core/translations.py +0 -0
  69. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/static/logo-512.png +0 -0
  70. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/static/logo.ico +0 -0
  71. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/static/logo.png +0 -0
  72. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/static/logo.svg +0 -0
  73. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/telemetry.py +0 -0
  74. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/__init__.py +0 -0
  75. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/config_model.py +0 -0
  76. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/dialogs/__init__.py +0 -0
  77. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/dialogs/create_server.py +0 -0
  78. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/dialogs/fields.py +0 -0
  79. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/dialogs/shortcut.py +0 -0
  80. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/dialogs/update_app.py +0 -0
  81. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/invoke.py +0 -0
  82. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/pages/__init__.py +0 -0
  83. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/pages/config_editor.py +0 -0
  84. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/single_instance.py +0 -0
  85. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/theme/__init__.py +0 -0
  86. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/theme/fonts.py +0 -0
  87. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/theme/tokens.py +0 -0
  88. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/usage.py +0 -0
  89. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/__init__.py +0 -0
  90. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/card.py +0 -0
  91. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/common.py +0 -0
  92. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/overlay_dialog.py +0 -0
  93. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/ram_slider.py +0 -0
  94. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/sparkline.py +0 -0
  95. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/spinner.py +0 -0
  96. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/title_bar.py +0 -0
  97. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/ui/widgets/toast.py +0 -0
  98. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/update.py +0 -0
  99. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/updater.py +0 -0
  100. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/mcsc_gui/utils.py +0 -0
  101. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/minecraft_server_creator.egg-info/dependency_links.txt +0 -0
  102. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/minecraft_server_creator.egg-info/entry_points.txt +0 -0
  103. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/src/minecraft_server_creator.egg-info/top_level.txt +0 -0
  104. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/tests/test_async_bridge.py +0 -0
  105. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/tests/test_entrypoints.py +0 -0
  106. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/tests/test_migration.py +0 -0
  107. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/tests/test_os_utils.py +0 -0
  108. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/tests/test_pymcsc_check.py +0 -0
  109. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/tests/test_server_manager.py +0 -0
  110. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/tests/test_shortcuts.py +0 -0
  111. {minecraft_server_creator-3.0.0 → minecraft_server_creator-3.1.0}/tests/test_updater.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: minecraft-server-creator
3
- Version: 3.0.0
3
+ Version: 3.1.0
4
4
  Summary: Minecraft Server Creator - Manage Minecraft servers
5
5
  Author-email: ddavidel <ddavidel@proton.me>
6
6
  License: This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
@@ -11,7 +11,7 @@ Description-Content-Type: text/markdown
11
11
  License-File: LICENSE
12
12
  Requires-Dist: requests
13
13
  Requires-Dist: appdirs
14
- Requires-Dist: pymcsc>=0.1.0
14
+ Requires-Dist: pymcsc==0.2.0
15
15
  Requires-Dist: PySide6-Essentials>=6.8
16
16
  Requires-Dist: qtawesome
17
17
  Provides-Extra: dev
@@ -22,7 +22,7 @@ Dynamic: license-file
22
22
 
23
23
  [![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey)](./LICENSE)
24
24
 
25
- ![Demo Image](https://i.imgur.com/K0jyPsE.png)
25
+ ![MCSC dashboard](https://raw.githubusercontent.com/ddavidel/minecraft-server-creator/main/assets/screenshots/dashboard.png)
26
26
  # MCSC - Minecraft Server Creator
27
27
  MCSC is a user-friendly tool written in Python with a GUI that simplifies the process of creating and managing Minecraft servers. Whether you're a beginner or experienced, MCSC allows you to easily set up, run, and control multiple Minecraft servers from a single interface.
28
28
  > **Warning**: MCSC is still in development, thus it may not be completely error free.
@@ -34,6 +34,17 @@ MCSC is a user-friendly tool written in Python with a GUI that simplifies the pr
34
34
  - **Edit server.properties**: Customize your Minecraft server settings by editing the `server.properties` file with a built-in editor.
35
35
  - **User-Friendly GUI**: A simple and intuitive interface designed for both beginners and experienced users.
36
36
  - **Manage Server Instances**: Keep track of all your servers in one place.
37
+ - **Backups**: Back up a server with one click and restore it later (the current state is saved first). Backups can also be automatic, when a server starts or stops (app-wide or per server), keeping the latest ones. They are stored in the app data folder, under `backups/<server id>/`.
38
+ - **Export and Import**: Export a server to a single `.zip` to move it to another PC, then import it there, or import an existing server folder made outside MCSC (it is copied, never moved).
39
+
40
+ ## Screenshots
41
+ | Server console and resources | Config editor |
42
+ | --- | --- |
43
+ | ![Server detail page](https://raw.githubusercontent.com/ddavidel/minecraft-server-creator/main/assets/screenshots/server.png) | ![server.properties editor](https://raw.githubusercontent.com/ddavidel/minecraft-server-creator/main/assets/screenshots/editor.png) |
44
+
45
+ | New server |
46
+ | --- |
47
+ | ![New server dialog](https://raw.githubusercontent.com/ddavidel/minecraft-server-creator/main/assets/screenshots/new-server.png) |
37
48
 
38
49
  ## Installation
39
50
  ### Windows installer (no Python needed)
@@ -65,6 +76,19 @@ To run it from the source code:
65
76
  - Server management (creating, running, monitoring and configuring servers) is provided by the
66
77
  [pymcsc](https://pypi.org/project/pymcsc/) library, imported as `mcsc`.
67
78
 
79
+ ## Release notes
80
+ The "What's New" popup (shown once after an update) and the changelog in the App Settings
81
+ read `src/mcsc_gui/static/changelog.json`. The notes are written **once per release**, not in
82
+ every PR — just keep using conventional commit messages (`feat(scope): …`, `fix: …`).
83
+
84
+ 1. In the release PR (`develop` → `main`), draft the entry from the commits since the last tag:
85
+ `python scripts/draft_changelog.py` (`--dry-run` to only print it, `--include-fixes` to list
86
+ the fixes too, `--version X.Y.Z` to choose the version).
87
+ 2. Edit the draft: user-facing wording, remove internal changes, add the `it` translation
88
+ (missing languages fall back to English).
89
+ 3. Commit it in the release PR. The release workflow fails on a minor/major release without
90
+ notes (patch releases only get a warning, and the app shows nothing for them).
91
+
68
92
  ## Code signing policy
69
93
  Free code signing provided by [SignPath.io](https://about.signpath.io/), certificate by
70
94
  [SignPath Foundation](https://signpath.org/).
@@ -1,6 +1,6 @@
1
1
  [![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey)](./LICENSE)
2
2
 
3
- ![Demo Image](https://i.imgur.com/K0jyPsE.png)
3
+ ![MCSC dashboard](https://raw.githubusercontent.com/ddavidel/minecraft-server-creator/main/assets/screenshots/dashboard.png)
4
4
  # MCSC - Minecraft Server Creator
5
5
  MCSC is a user-friendly tool written in Python with a GUI that simplifies the process of creating and managing Minecraft servers. Whether you're a beginner or experienced, MCSC allows you to easily set up, run, and control multiple Minecraft servers from a single interface.
6
6
  > **Warning**: MCSC is still in development, thus it may not be completely error free.
@@ -12,6 +12,17 @@ MCSC is a user-friendly tool written in Python with a GUI that simplifies the pr
12
12
  - **Edit server.properties**: Customize your Minecraft server settings by editing the `server.properties` file with a built-in editor.
13
13
  - **User-Friendly GUI**: A simple and intuitive interface designed for both beginners and experienced users.
14
14
  - **Manage Server Instances**: Keep track of all your servers in one place.
15
+ - **Backups**: Back up a server with one click and restore it later (the current state is saved first). Backups can also be automatic, when a server starts or stops (app-wide or per server), keeping the latest ones. They are stored in the app data folder, under `backups/<server id>/`.
16
+ - **Export and Import**: Export a server to a single `.zip` to move it to another PC, then import it there, or import an existing server folder made outside MCSC (it is copied, never moved).
17
+
18
+ ## Screenshots
19
+ | Server console and resources | Config editor |
20
+ | --- | --- |
21
+ | ![Server detail page](https://raw.githubusercontent.com/ddavidel/minecraft-server-creator/main/assets/screenshots/server.png) | ![server.properties editor](https://raw.githubusercontent.com/ddavidel/minecraft-server-creator/main/assets/screenshots/editor.png) |
22
+
23
+ | New server |
24
+ | --- |
25
+ | ![New server dialog](https://raw.githubusercontent.com/ddavidel/minecraft-server-creator/main/assets/screenshots/new-server.png) |
15
26
 
16
27
  ## Installation
17
28
  ### Windows installer (no Python needed)
@@ -43,6 +54,19 @@ To run it from the source code:
43
54
  - Server management (creating, running, monitoring and configuring servers) is provided by the
44
55
  [pymcsc](https://pypi.org/project/pymcsc/) library, imported as `mcsc`.
45
56
 
57
+ ## Release notes
58
+ The "What's New" popup (shown once after an update) and the changelog in the App Settings
59
+ read `src/mcsc_gui/static/changelog.json`. The notes are written **once per release**, not in
60
+ every PR — just keep using conventional commit messages (`feat(scope): …`, `fix: …`).
61
+
62
+ 1. In the release PR (`develop` → `main`), draft the entry from the commits since the last tag:
63
+ `python scripts/draft_changelog.py` (`--dry-run` to only print it, `--include-fixes` to list
64
+ the fixes too, `--version X.Y.Z` to choose the version).
65
+ 2. Edit the draft: user-facing wording, remove internal changes, add the `it` translation
66
+ (missing languages fall back to English).
67
+ 3. Commit it in the release PR. The release workflow fails on a minor/major release without
68
+ notes (patch releases only get a warning, and the app shows nothing for them).
69
+
46
70
  ## Code signing policy
47
71
  Free code signing provided by [SignPath.io](https://about.signpath.io/), certificate by
48
72
  [SignPath Foundation](https://signpath.org/).
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "minecraft-server-creator"
7
- version = "3.0.0"
7
+ version = "3.1.0"
8
8
  description = "Minecraft Server Creator - Manage Minecraft servers"
9
9
  authors = [{ name = "ddavidel", email = "ddavidel@proton.me" }]
10
10
  readme = "README.md"
@@ -12,7 +12,7 @@ license = { file = "LICENSE" }
12
12
  dependencies = [
13
13
  "requests",
14
14
  "appdirs",
15
- "pymcsc>=0.1.0", # server management, imported as `mcsc`
15
+ "pymcsc==0.2.0", # server management, imported as `mcsc` (pinned: bump deliberately after testing)
16
16
  "PySide6-Essentials>=6.8",
17
17
  "qtawesome",
18
18
  ]
@@ -31,3 +31,8 @@ SERVERS_JSON_PATH = os.path.join(DATA_DIR_PATH, "config", "servers.json")
31
31
  JAR_VERSIONS_FILTER = "stable" # "stable", "none"
32
32
  MAX_LOG_LINES = 300
33
33
  SERVER_STOP_TIMEOUT = 60 # seconds before a server that doesn't stop gets killed
34
+
35
+ # BACKUPS (archives are created by pymcsc in BACKUPS_DIR_PATH/<server id>/)
36
+ BACKUPS_DIR_PATH = os.path.join(DATA_DIR_PATH, "backups")
37
+ # Per-server app preferences (automatic backup override), keyed by server id
38
+ SERVER_PREFS_PATH = os.path.join(DATA_DIR_PATH, "config", "server_prefs.json")
@@ -0,0 +1,140 @@
1
+ """
2
+ Release notes ("What's New").
3
+
4
+ The notes ship with the app in ``static/changelog.json`` (no network needed):
5
+ one entry per release, newest first, with the highlights in each language.
6
+ They're written once per release, from the draft made by
7
+ ``scripts/draft_changelog.py``.
8
+ """
9
+
10
+ from __future__ import annotations
11
+
12
+ import json
13
+ import logging
14
+ import re
15
+ from dataclasses import dataclass, field
16
+ from datetime import date
17
+ from functools import lru_cache
18
+ from pathlib import Path
19
+
20
+ from mcsc_gui.utils import get_static_path
21
+
22
+ logger = logging.getLogger(__name__)
23
+
24
+ CHANGELOG_FILENAME = "changelog.json"
25
+ FALLBACK_LANGUAGE = "en"
26
+
27
+ _VERSION_RE = re.compile(r"^\s*v?(\d+)\.(\d+)\.(\d+)")
28
+
29
+ Version = tuple[int, int, int]
30
+
31
+
32
+ def parse_version(value) -> Version | None:
33
+ """``"v3.1.0"`` / ``"3.1.0.dev1"`` -> ``(3, 1, 0)``; anything else -> None."""
34
+ if not isinstance(value, str):
35
+ return None
36
+ match = _VERSION_RE.match(value)
37
+ if match is None:
38
+ return None
39
+ return tuple(int(part) for part in match.groups()) # type: ignore[return-value]
40
+
41
+
42
+ @dataclass(frozen=True)
43
+ class ReleaseNote:
44
+ """The notes of one release."""
45
+
46
+ version: str
47
+ date: date | None
48
+ highlights: dict[str, tuple[str, ...]]
49
+ title: dict[str, str] = field(default_factory=dict)
50
+
51
+ @property
52
+ def key(self) -> Version:
53
+ return parse_version(self.version) or (0, 0, 0)
54
+
55
+ def items(self, language: str) -> tuple[str, ...]:
56
+ """The highlights in ``language``, in English if it has none."""
57
+ return self.highlights.get(language) or self.highlights.get(FALLBACK_LANGUAGE, ())
58
+
59
+ def heading(self, language: str) -> str:
60
+ """The title in ``language`` (English fallback), or ``""``."""
61
+ return self.title.get(language) or self.title.get(FALLBACK_LANGUAGE, "")
62
+
63
+
64
+ def _texts(value, name: str) -> dict[str, tuple[str, ...]]:
65
+ if not isinstance(value, dict):
66
+ raise ValueError(f"'{name}' must be an object")
67
+ result = {}
68
+ for language, items in value.items():
69
+ if not isinstance(items, list) or not all(isinstance(i, str) and i.strip() for i in items):
70
+ raise ValueError(f"'{name}.{language}' must be a list of strings")
71
+ result[str(language)] = tuple(i.strip() for i in items)
72
+ return result
73
+
74
+
75
+ def parse_entry(entry) -> ReleaseNote:
76
+ """A :class:`ReleaseNote` from a ``releases`` item; ValueError if it's invalid."""
77
+ if not isinstance(entry, dict):
78
+ raise ValueError("an entry must be an object")
79
+ version = entry.get("version")
80
+ if parse_version(version) is None:
81
+ raise ValueError(f"invalid version: {version!r}")
82
+ raw_date = entry.get("date")
83
+ try:
84
+ day = date.fromisoformat(raw_date) if raw_date else None
85
+ except (TypeError, ValueError) as e:
86
+ raise ValueError(f"invalid date: {raw_date!r}") from e
87
+ highlights = _texts(entry.get("highlights"), "highlights")
88
+ if not highlights.get(FALLBACK_LANGUAGE):
89
+ raise ValueError(f"no '{FALLBACK_LANGUAGE}' highlights")
90
+ title = entry.get("title") or {}
91
+ if not isinstance(title, dict) or not all(isinstance(t, str) for t in title.values()):
92
+ raise ValueError("'title' must be an object of strings")
93
+ return ReleaseNote(version.strip().lstrip("v"), day, highlights, dict(title))
94
+
95
+
96
+ def parse_changelog(data) -> list[ReleaseNote]:
97
+ """The valid entries of a changelog document, newest first (invalid ones are skipped)."""
98
+ releases = data.get("releases") if isinstance(data, dict) else None
99
+ if not isinstance(releases, list):
100
+ logger.warning("Changelog without a 'releases' list")
101
+ return []
102
+ notes = []
103
+ for entry in releases:
104
+ try:
105
+ notes.append(parse_entry(entry))
106
+ except ValueError as e:
107
+ logger.warning(f"Skipping invalid changelog entry: {e}")
108
+ notes.sort(key=lambda note: note.key, reverse=True)
109
+ return notes
110
+
111
+
112
+ def read_changelog(path: str | Path | None = None) -> list[ReleaseNote]:
113
+ """Load the notes from ``path`` (the bundled file by default). Never raises."""
114
+ try:
115
+ source = Path(path) if path is not None else get_static_path(CHANGELOG_FILENAME)
116
+ data = json.loads(source.read_text(encoding="utf-8"))
117
+ except (OSError, ValueError) as e:
118
+ logger.warning(f"Can't read the changelog: {e}")
119
+ return []
120
+ return parse_changelog(data)
121
+
122
+
123
+ @lru_cache(maxsize=1)
124
+ def _bundled() -> tuple[ReleaseNote, ...]:
125
+ return tuple(read_changelog())
126
+
127
+
128
+ def load_changelog() -> list[ReleaseNote]:
129
+ """The bundled release notes, newest first (read once)."""
130
+ return list(_bundled())
131
+
132
+
133
+ def notes_between(notes, after: str | None, up_to: str) -> list[ReleaseNote]:
134
+ """Notes of the releases newer than ``after`` (None = all) up to ``up_to`` included."""
135
+ top = parse_version(up_to)
136
+ if top is None:
137
+ return []
138
+ bottom = parse_version(after) if after else None
139
+ return [note for note in notes
140
+ if note.key <= top and (bottom is None or note.key > bottom)]
@@ -24,6 +24,8 @@ class Notifier(Protocol):
24
24
 
25
25
  def error(self, message: str) -> None: ...
26
26
 
27
+ # Optional: notifiers without ``warning`` get :meth:`error` (see :func:`notify_warning`).
28
+
27
29
 
28
30
  class NullNotifier:
29
31
  """Default notifier: only logs. Used in tests and before the UI is ready."""
@@ -34,6 +36,9 @@ class NullNotifier:
34
36
  def success(self, message: str) -> None:
35
37
  logger.info(message)
36
38
 
39
+ def warning(self, message: str) -> None:
40
+ logger.warning(message)
41
+
37
42
  def error(self, message: str) -> None:
38
43
  logger.error(message)
39
44
 
@@ -50,3 +55,9 @@ def set_notifier(notifier: Notifier | None) -> None:
50
55
  def get_notifier() -> Notifier:
51
56
  """The currently registered notifier."""
52
57
  return _notifier
58
+
59
+
60
+ def notify_warning(message: str) -> None:
61
+ """Show a warning through the registered notifier (as an error if it has no ``warning``)."""
62
+ notifier = get_notifier()
63
+ getattr(notifier, "warning", notifier.error)(message)
@@ -5,6 +5,7 @@ from __future__ import annotations
5
5
  import logging
6
6
  import os
7
7
  import platform
8
+ import socket
8
9
  import subprocess
9
10
 
10
11
  logger = logging.getLogger(__name__)
@@ -57,3 +58,17 @@ def hide_child_consoles() -> bool:
57
58
  subprocess.Popen.__init__ = init # type: ignore[method-assign]
58
59
  logger.info("No console: child processes will run without a window")
59
60
  return True
61
+
62
+
63
+ def local_ip_address() -> str | None:
64
+ """This PC's address on the local network (``None`` if there's no network).
65
+
66
+ Connecting a UDP socket only picks the outgoing interface: nothing is sent.
67
+ """
68
+ try:
69
+ with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as sock:
70
+ sock.connect(("10.255.255.255", 1))
71
+ address = sock.getsockname()[0]
72
+ except OSError:
73
+ return None
74
+ return None if address.startswith("0.") else address