Compare commits
28 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 3c9f19c5da | |||
| 0a57ac1a1e | |||
| a663286c0a | |||
| 3de3a2f113 | |||
| bce3326a0b | |||
| 2183241e08 | |||
| f6eb93ad16 | |||
| 827ba59c7b | |||
| b9878a9c33 | |||
| d0ea56daa4 | |||
| 4549fb4471 | |||
| 86303f8b84 | |||
| 2dd3ea2562 | |||
| 676e24e78d | |||
| d346ec4f97 | |||
| e85ae3f59f | |||
| c4942aa714 | |||
| dc784050bf | |||
| 76c182313e | |||
| 8579f15868 | |||
| bf6873cfd7 | |||
| 5f9a28e96c | |||
| 64742d6aad | |||
| 8e52ed21a5 | |||
| e7b95098b2 | |||
| d060697aa9 | |||
| ea8ac3831f | |||
| b868f3289b |
+15
-2
@@ -104,5 +104,18 @@ $RECYCLE.BIN/
|
||||
## Jenv
|
||||
.java-version
|
||||
|
||||
## VSCode
|
||||
.vscode
|
||||
## diagrams.net / draw.io
|
||||
# Draw.io temporary files
|
||||
*.drawio.bkp
|
||||
*.drawio.tmp
|
||||
|
||||
# Auto-save files
|
||||
*.drawio.autosave
|
||||
|
||||
# Exported images (optional – nur wenn du Exporte nicht versionieren willst)
|
||||
*.drawio.png
|
||||
*.drawio.svg
|
||||
*.drawio.pdf
|
||||
|
||||
## IntelliJ
|
||||
.idea
|
||||
Vendored
+7
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"recommendations": [
|
||||
"vscjava.vscode-java-pack",
|
||||
"mhutchie.git-graph",
|
||||
"gitlab.gitlab-workflow",
|
||||
]
|
||||
}
|
||||
Vendored
+17
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"label": "Export drawio to SVG",
|
||||
"type": "shell",
|
||||
"command": "./scripts/export-drawio.sh",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Export puml to SVG",
|
||||
"type": "shell",
|
||||
"command": "./scripts/export-plantuml.sh",
|
||||
"problemMatcher": []
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -35,6 +35,8 @@ This protocol handles game state synchronization, player actions, lobby and glob
|
||||
│ └── test/ # Unit tests
|
||||
├── documents/ # Project resources and documentation
|
||||
│ ├── images/ # Images for README and documentation
|
||||
│ ├── diary # Diary files for each organizational meetup
|
||||
│ ├── blog # Blog files covering project-related topics
|
||||
│ ├── docs # Documentation
|
||||
│ ├── milestones/ # Milestone deliverables (6 milestones)
|
||||
│ └── (Other resources) # Additional project materials
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
# Blog
|
||||
|
||||
## Purpose
|
||||
This folder contains a collection of blog posts documenting the development process of our application. These blogs serve two key purposes:
|
||||
|
||||
1. **For External Audiences**
|
||||
|
||||
The blogs provide insights into the internal program flow and the interaction between components without requiring readers to dive into the source code. They offer a mixed-level overview of how different parts of the system work together.
|
||||
|
||||
2. **For Our Team**
|
||||
|
||||
The blogs serve as a record of our decision-making process. By documenting what decisions were made and why, we can track the evolution of our design choices and understand the reasoning behind them. This is invaluable for maintaining consistency across the team.
|
||||
|
||||
But keep in mind that these blogs **do not replace** the detailed source code documentation.
|
||||
|
||||
## Format
|
||||
All blog posts follow the naming convention: `<YYYY-MM-DD>_<Title>.md`
|
||||
|
||||
## Blog Posts
|
||||
|
||||
### General
|
||||
*(No posts yet)*
|
||||
|
||||
### Client
|
||||
*(No posts yet)*
|
||||
|
||||
### Server
|
||||
*(No posts yet)*
|
||||
Executable
+72
@@ -0,0 +1,72 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Check for draw.io installation
|
||||
DRAWIO_PATH=""
|
||||
check_drawio_installed() {
|
||||
if command -v drawio &>/dev/null; then
|
||||
DRAWIO_PATH=$(command -v drawio)
|
||||
return 0 # drawio via PATH
|
||||
elif [[ -x "/Applications/draw.io.app/Contents/MacOS/draw.io" ]]; then
|
||||
DRAWIO_PATH="/Applications/draw.io.app/Contents/MacOS/draw.io"
|
||||
return 0 # For macOS check at default path
|
||||
else
|
||||
return 1 # not found
|
||||
fi
|
||||
}
|
||||
|
||||
if ! check_drawio_installed; then
|
||||
echo "Error: 'drawio' was not found. Make sure, that the draw.io cli is installed."
|
||||
echo "https://www.diagrams.net/"
|
||||
exit 1
|
||||
else
|
||||
echo "Draw.io installation found at: $DRAWIO_PATH"
|
||||
fi
|
||||
|
||||
# Compare source (draw.io document) and exported file svg on mtime
|
||||
needs_export() {
|
||||
local drawio_file="$1"
|
||||
local svg_file="$2"
|
||||
|
||||
# If no file found, export
|
||||
if [[ ! -f "$svg_file" ]]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
if [[ "$drawio_file" -nt "$svg_file" ]]; then
|
||||
return 0
|
||||
else
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
# If (re-)export is necessary export with drawio cli
|
||||
export_file() {
|
||||
local drawio_file="$1"
|
||||
local svg_file="${drawio_file%.drawio}.svg"
|
||||
|
||||
if needs_export "$drawio_file" "$svg_file"; then
|
||||
echo "↻ Exporting: $drawio_file"
|
||||
echo "$svg_file"
|
||||
echo "$drawio_file"
|
||||
|
||||
"$DRAWIO_PATH" --export --format svg --transparent --output "$svg_file" "$drawio_file"
|
||||
else
|
||||
echo "✓ Up-to-date: $drawio_file"
|
||||
fi
|
||||
}
|
||||
|
||||
# Iterate over all .drawio files
|
||||
main() {
|
||||
# Source - https://stackoverflow.com/a/9612232
|
||||
# Posted by Kevin, modified by community. See post 'Timeline' for change history
|
||||
# Retrieved 2026-03-09, License - CC BY-SA 4.0
|
||||
find . -name '*.drawio' -print0 |
|
||||
while IFS= read -r -d '' line; do
|
||||
export_file "$line"
|
||||
done
|
||||
|
||||
echo "✓ Exported all files"
|
||||
}
|
||||
|
||||
# Start script at entry point
|
||||
main
|
||||
Executable
+66
@@ -0,0 +1,66 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Check for plantuml installation
|
||||
PLANTUML_PATH=""
|
||||
check_plantuml_installed() {
|
||||
if command -v plantuml &>/dev/null; then
|
||||
PLANTUML_PATH=$(command -v plantuml)
|
||||
return 0 # plantuml via PATH
|
||||
else
|
||||
return 1 # not found
|
||||
fi
|
||||
}
|
||||
|
||||
if ! check_plantuml_installed; then
|
||||
echo "Error: 'plantuml' was not found. Make sure, that plantuml is installed."
|
||||
echo "https://plantuml.com/starting"
|
||||
exit 1
|
||||
else
|
||||
echo "PlantUML installation found at: $PLANTUML_PATH"
|
||||
fi
|
||||
|
||||
# Compare source (.puml document) and exported file svg on mtime
|
||||
needs_export() {
|
||||
local puml_file="$1"
|
||||
local svg_file="$2"
|
||||
|
||||
# If no file found, export
|
||||
if [[ ! -f "$svg_file" ]]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
if [[ "$puml_file" -nt "$svg_file" ]]; then
|
||||
return 0
|
||||
else
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
# If (re-)export is necessary export with plantuml cli
|
||||
export_file() {
|
||||
local puml_file="$1"
|
||||
local svg_file="${puml_file%.puml}.svg"
|
||||
|
||||
if needs_export "$puml_file" "$svg_file"; then
|
||||
echo "↻ Exporting: $puml_file"
|
||||
"$PLANTUML_PATH" -tsvg "$puml_file"
|
||||
else
|
||||
echo "✓ Up-to-date: $puml_file"
|
||||
fi
|
||||
}
|
||||
|
||||
# Iterate over all .puml files
|
||||
main() {
|
||||
# Source - https://stackoverflow.com/a/9612232
|
||||
# Posted by Kevin, modified by community. See post 'Timeline' for change history
|
||||
# Retrieved 2026-03-09, License - CC BY-SA 4.0
|
||||
find . -name '*.puml' -print0 |
|
||||
while IFS= read -r -d '' line; do
|
||||
export_file "$line"
|
||||
done
|
||||
|
||||
echo "✓ Exported all files"
|
||||
}
|
||||
|
||||
# Start script at entry point
|
||||
main
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 4.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.0 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 194 KiB |
Reference in New Issue
Block a user