Compare commits
66 Commits
8881f442bb
...
test
| Author | SHA1 | Date | |
|---|---|---|---|
| ffd88c02e1 | |||
| bd9b7c009a | |||
| e61ab94935 | |||
| 9150622e74 | |||
| 501cad6175 | |||
| 5275c5ca94 | |||
| 61951a047b | |||
| 5f6a3ae175 | |||
| 40c06ae249 | |||
| 1189ce0931 | |||
| ff04b6ee22 | |||
| ff0a4fefe1 | |||
| 666823c641 | |||
| 02f2bb2703 | |||
| 38e85c2a24 | |||
| e31278e389 | |||
| 024343db19 | |||
| ad7a2575da | |||
| 26991ce61a | |||
| 8ded8c81ee | |||
| eb99c6a18e | |||
| c1f3f9f708 | |||
| e2e49f89ce | |||
| 7ec75a3b26 | |||
| 33a25dc532 | |||
| 60279542e1 | |||
| 35bdd44649 | |||
| 77971497a4 | |||
| 9b83bec37d | |||
| 0791b80f15 | |||
| ca6111cd28 | |||
| 0cf76d595f | |||
| 821d9aa42c | |||
| 06f0f87970 | |||
| 86439abea8 | |||
| dd0c1a123c | |||
| 3e960a955c | |||
| ca233f4171 | |||
| ea8c85d7ad | |||
| e76297b3f3 | |||
| 14d5e8fd8f | |||
| 7b0db3abff | |||
| 83cc433c2f | |||
| 7182c45351 | |||
| e11e864b26 | |||
| d8435ef46c | |||
| 9b3a20cdf1 | |||
| 4e0b5fe3d2 | |||
| 4596bc203a | |||
| 78a61fe33c | |||
| d9084606c8 | |||
| 7951a42c88 | |||
| 2589f9f73f | |||
| a1f8536855 | |||
| c57a08f5da | |||
| 542cf6a4f1 | |||
| 1b95573720 | |||
| dac3d42b6b | |||
| e732f9b6da | |||
| c52d861e63 | |||
| 54c23a83e5 | |||
| 7882e70e03 | |||
| 20440fe07f | |||
| f949502ef4 | |||
| d7a0494d7e | |||
| fe69347625 |
14
.claude/settings.local.json
Normal file
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"permissions": {
|
||||
"allow": [
|
||||
"WebSearch",
|
||||
"Bash(find:*)",
|
||||
"Bash(godot:*)",
|
||||
"Bash(python:*)",
|
||||
"Bash(git mv:*)",
|
||||
"Bash(dir:*)"
|
||||
],
|
||||
"deny": [],
|
||||
"ask": []
|
||||
}
|
||||
}
|
||||
13
.gdformatrc
Normal file
@@ -0,0 +1,13 @@
|
||||
# GDFormat configuration file
|
||||
# This file configures the gdformat tool for consistent GDScript formatting
|
||||
|
||||
# Maximum line length (default is 100)
|
||||
# Godot's style guide recommends keeping lines under 100 characters
|
||||
line_length = 80
|
||||
|
||||
# Whether to use tabs or spaces for indentation
|
||||
# Godot uses tabs by default
|
||||
use_tabs = true
|
||||
|
||||
# Number of spaces per tab (when displaying)
|
||||
tab_width = 4
|
||||
498
.gitea/workflows/build.yml
Normal file
@@ -0,0 +1,498 @@
|
||||
name: Build Game
|
||||
|
||||
# Build pipeline for creating game executables across multiple platforms
|
||||
#
|
||||
# Features:
|
||||
# - Manual trigger with individual platform checkboxes
|
||||
# - Tag-based automatic builds for releases
|
||||
# - Multi-platform builds (Windows, Linux, macOS, Android)
|
||||
# - Artifact storage for one week
|
||||
# - Configurable build options
|
||||
|
||||
on:
|
||||
# Manual trigger with platform selection
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
build_windows:
|
||||
description: 'Build for Windows'
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
build_linux:
|
||||
description: 'Build for Linux'
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
build_macos:
|
||||
description: 'Build for macOS'
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
build_android:
|
||||
description: 'Build for Android'
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
build_type:
|
||||
description: 'Build type'
|
||||
required: true
|
||||
default: 'release'
|
||||
type: debug
|
||||
options:
|
||||
- release
|
||||
- debug
|
||||
version_override:
|
||||
description: 'Override version (optional)'
|
||||
required: false
|
||||
type: string
|
||||
|
||||
# Automatic trigger on git tags (for releases)
|
||||
push:
|
||||
tags:
|
||||
- 'v*' # Version tags (v1.0.0, v2.1.0, etc.)
|
||||
- 'release-*' # Release tags
|
||||
|
||||
env:
|
||||
GODOT_VERSION: "4.4.1"
|
||||
PROJECT_NAME: "Skelly"
|
||||
BUILD_DIR: "builds"
|
||||
|
||||
jobs:
|
||||
# Preparation job - determines build configuration
|
||||
prepare:
|
||||
name: Prepare Build
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
platforms: ${{ steps.config.outputs.platforms }}
|
||||
build_type: ${{ steps.config.outputs.build_type }}
|
||||
version: ${{ steps.config.outputs.version }}
|
||||
artifact_name: ${{ steps.config.outputs.artifact_name }}
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Configure build parameters
|
||||
id: config
|
||||
run: |
|
||||
# Determine platforms to build
|
||||
if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
|
||||
# Build platforms array from individual checkboxes
|
||||
platforms=""
|
||||
if [[ "${{ github.event.inputs.build_windows }}" == "true" ]]; then
|
||||
platforms="${platforms}windows,"
|
||||
fi
|
||||
if [[ "${{ github.event.inputs.build_linux }}" == "true" ]]; then
|
||||
platforms="${platforms}linux,"
|
||||
fi
|
||||
if [[ "${{ github.event.inputs.build_macos }}" == "true" ]]; then
|
||||
platforms="${platforms}macos,"
|
||||
fi
|
||||
if [[ "${{ github.event.inputs.build_android }}" == "true" ]]; then
|
||||
platforms="${platforms}android,"
|
||||
fi
|
||||
# Remove trailing comma
|
||||
platforms="${platforms%,}"
|
||||
|
||||
build_type="${{ github.event.inputs.build_type }}"
|
||||
version_override="${{ github.event.inputs.version_override }}"
|
||||
else
|
||||
# Tag-triggered build - build all platforms
|
||||
platforms="windows,linux,macos,android"
|
||||
build_type="release"
|
||||
version_override=""
|
||||
fi
|
||||
|
||||
# Determine version
|
||||
if [[ -n "$version_override" ]]; then
|
||||
version="$version_override"
|
||||
elif [[ "${{ github.ref_type }}" == "tag" ]]; then
|
||||
version="${{ github.ref_name }}"
|
||||
else
|
||||
# Generate version from git info
|
||||
commit_short=$(git rev-parse --short HEAD)
|
||||
branch_name="${{ github.ref_name }}"
|
||||
timestamp=$(date +%Y%m%d-%H%M)
|
||||
version="${branch_name}-${commit_short}-${timestamp}"
|
||||
fi
|
||||
|
||||
# Create artifact name
|
||||
artifact_name="${{ env.PROJECT_NAME }}-${version}-${build_type}"
|
||||
|
||||
echo "platforms=${platforms}" >> $GITHUB_OUTPUT
|
||||
echo "build_type=${build_type}" >> $GITHUB_OUTPUT
|
||||
echo "version=${version}" >> $GITHUB_OUTPUT
|
||||
echo "artifact_name=${artifact_name}" >> $GITHUB_OUTPUT
|
||||
|
||||
echo "🔧 Build Configuration:"
|
||||
echo " Platforms: ${platforms}"
|
||||
echo " Build Type: ${build_type}"
|
||||
echo " Version: ${version}"
|
||||
echo " Artifact: ${artifact_name}"
|
||||
|
||||
# Setup export templates (shared across all platform builds)
|
||||
setup-templates:
|
||||
name: Setup Export Templates
|
||||
runs-on: ubuntu-latest
|
||||
needs: prepare
|
||||
|
||||
steps:
|
||||
- name: Cache export templates
|
||||
id: cache-templates
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.local/share/godot/export_templates
|
||||
key: godot-templates-${{ env.GODOT_VERSION }}
|
||||
restore-keys: |
|
||||
godot-templates-
|
||||
|
||||
- name: Setup Godot
|
||||
if: steps.cache-templates.outputs.cache-hit != 'true'
|
||||
uses: chickensoft-games/setup-godot@v1
|
||||
with:
|
||||
version: ${{ env.GODOT_VERSION }}
|
||||
use-dotnet: false
|
||||
|
||||
- name: Install export templates
|
||||
if: steps.cache-templates.outputs.cache-hit != 'true'
|
||||
run: |
|
||||
echo "📦 Installing Godot export templates..."
|
||||
mkdir -p ~/.local/share/godot/export_templates/${{ env.GODOT_VERSION }}.stable
|
||||
wget -q https://github.com/godotengine/godot/releases/download/${{ env.GODOT_VERSION }}-stable/Godot_v${{ env.GODOT_VERSION }}-stable_export_templates.tpz
|
||||
unzip -q Godot_v${{ env.GODOT_VERSION }}-stable_export_templates.tpz
|
||||
mv templates/* ~/.local/share/godot/export_templates/${{ env.GODOT_VERSION }}.stable/
|
||||
echo "✅ Export templates installed successfully"
|
||||
ls -la ~/.local/share/godot/export_templates/${{ env.GODOT_VERSION }}.stable/
|
||||
|
||||
- name: Verify templates cache
|
||||
run: |
|
||||
echo "🔍 Verifying export templates are available:"
|
||||
ls -la ~/.local/share/godot/export_templates/${{ env.GODOT_VERSION }}.stable/
|
||||
|
||||
# Windows build job
|
||||
build-windows:
|
||||
name: Build Windows
|
||||
runs-on: ubuntu-latest
|
||||
needs: [prepare, setup-templates]
|
||||
if: contains(needs.prepare.outputs.platforms, 'windows')
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Godot
|
||||
uses: chickensoft-games/setup-godot@v1
|
||||
with:
|
||||
version: ${{ env.GODOT_VERSION }}
|
||||
use-dotnet: false
|
||||
|
||||
- name: Restore export templates cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.local/share/godot/export_templates
|
||||
key: godot-templates-${{ env.GODOT_VERSION }}
|
||||
restore-keys: |
|
||||
godot-templates-
|
||||
|
||||
- name: Create build directory
|
||||
run: mkdir -p ${{ env.BUILD_DIR }}
|
||||
|
||||
- name: Import project assets
|
||||
run: |
|
||||
echo "📦 Importing project assets..."
|
||||
godot --headless --verbose --editor --quit || true
|
||||
sleep 2
|
||||
|
||||
- name: Build Windows executable
|
||||
run: |
|
||||
echo "🏗️ Building Windows executable..."
|
||||
godot --headless --verbose --export-${{ needs.prepare.outputs.build_type }} "Windows Desktop" \
|
||||
${{ env.BUILD_DIR }}/skelly-windows-${{ needs.prepare.outputs.version }}.exe
|
||||
|
||||
# Verify build output
|
||||
if [[ -f "${{ env.BUILD_DIR }}/skelly-windows-${{ needs.prepare.outputs.version }}.exe" ]]; then
|
||||
echo "✅ Windows build successful"
|
||||
ls -la ${{ env.BUILD_DIR }}/
|
||||
else
|
||||
echo "❌ Windows build failed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Upload Windows build
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: ${{ needs.prepare.outputs.artifact_name }}-windows
|
||||
path: ${{ env.BUILD_DIR }}/skelly-windows-${{ needs.prepare.outputs.version }}.exe
|
||||
retention-days: 7
|
||||
compression-level: 0
|
||||
|
||||
# Linux build job
|
||||
build-linux:
|
||||
name: Build Linux
|
||||
runs-on: ubuntu-latest
|
||||
needs: [prepare, setup-templates]
|
||||
if: contains(needs.prepare.outputs.platforms, 'linux')
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Godot
|
||||
uses: chickensoft-games/setup-godot@v1
|
||||
with:
|
||||
version: ${{ env.GODOT_VERSION }}
|
||||
use-dotnet: false
|
||||
|
||||
- name: Restore export templates cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.local/share/godot/export_templates
|
||||
key: godot-templates-${{ env.GODOT_VERSION }}
|
||||
restore-keys: |
|
||||
godot-templates-
|
||||
|
||||
- name: Create build directory
|
||||
run: mkdir -p ${{ env.BUILD_DIR }}
|
||||
|
||||
- name: Import project assets
|
||||
run: |
|
||||
echo "📦 Importing project assets..."
|
||||
godot --headless --verbose --editor --quit || true
|
||||
sleep 2
|
||||
|
||||
- name: Build Linux executable
|
||||
run: |
|
||||
echo "🏗️ Building Linux executable..."
|
||||
godot --headless --verbose --export-${{ needs.prepare.outputs.build_type }} "Linux" \
|
||||
${{ env.BUILD_DIR }}/skelly-linux-${{ needs.prepare.outputs.version }}.x86_64
|
||||
|
||||
# Make executable
|
||||
chmod +x ${{ env.BUILD_DIR }}/skelly-linux-${{ needs.prepare.outputs.version }}.x86_64
|
||||
|
||||
# Verify build output
|
||||
if [[ -f "${{ env.BUILD_DIR }}/skelly-linux-${{ needs.prepare.outputs.version }}.x86_64" ]]; then
|
||||
echo "✅ Linux build successful"
|
||||
ls -la ${{ env.BUILD_DIR }}/
|
||||
else
|
||||
echo "❌ Linux build failed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Upload Linux build
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: ${{ needs.prepare.outputs.artifact_name }}-linux
|
||||
path: ${{ env.BUILD_DIR }}/skelly-linux-${{ needs.prepare.outputs.version }}.x86_64
|
||||
retention-days: 7
|
||||
compression-level: 0
|
||||
|
||||
# macOS build job
|
||||
build-macos:
|
||||
name: Build macOS
|
||||
runs-on: ubuntu-latest
|
||||
needs: [prepare, setup-templates]
|
||||
if: contains(needs.prepare.outputs.platforms, 'macos')
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Godot
|
||||
uses: chickensoft-games/setup-godot@v1
|
||||
with:
|
||||
version: ${{ env.GODOT_VERSION }}
|
||||
use-dotnet: false
|
||||
|
||||
- name: Restore export templates cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.local/share/godot/export_templates
|
||||
key: godot-templates-${{ env.GODOT_VERSION }}
|
||||
restore-keys: |
|
||||
godot-templates-
|
||||
|
||||
- name: Create build directory
|
||||
run: mkdir -p ${{ env.BUILD_DIR }}
|
||||
|
||||
- name: Import project assets
|
||||
run: |
|
||||
echo "📦 Importing project assets..."
|
||||
godot --headless --verbose --editor --quit || true
|
||||
sleep 2
|
||||
|
||||
- name: Build macOS application
|
||||
run: |
|
||||
echo "🏗️ Building macOS application..."
|
||||
godot --headless --verbose --export-${{ needs.prepare.outputs.build_type }} "macOS" \
|
||||
${{ env.BUILD_DIR }}/skelly-macos-${{ needs.prepare.outputs.version }}.zip
|
||||
|
||||
# Verify build output
|
||||
if [[ -f "${{ env.BUILD_DIR }}/skelly-macos-${{ needs.prepare.outputs.version }}.zip" ]]; then
|
||||
echo "✅ macOS build successful"
|
||||
ls -la ${{ env.BUILD_DIR }}/
|
||||
else
|
||||
echo "❌ macOS build failed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Upload macOS build
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: ${{ needs.prepare.outputs.artifact_name }}-macos
|
||||
path: ${{ env.BUILD_DIR }}/skelly-macos-${{ needs.prepare.outputs.version }}.zip
|
||||
retention-days: 7
|
||||
compression-level: 0
|
||||
|
||||
# Android build job
|
||||
build-android:
|
||||
name: Build Android
|
||||
runs-on: ubuntu-latest
|
||||
needs: [prepare, setup-templates]
|
||||
if: contains(needs.prepare.outputs.platforms, 'android')
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Java
|
||||
uses: actions/setup-java@v4
|
||||
with:
|
||||
distribution: 'temurin'
|
||||
java-version: '17'
|
||||
|
||||
- name: Setup Android SDK
|
||||
uses: android-actions/setup-android@v3
|
||||
with:
|
||||
api-level: 33
|
||||
build-tools: 33.0.0
|
||||
|
||||
- name: Setup Godot
|
||||
uses: chickensoft-games/setup-godot@v1
|
||||
with:
|
||||
version: ${{ env.GODOT_VERSION }}
|
||||
use-dotnet: false
|
||||
|
||||
- name: Restore export templates cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.local/share/godot/export_templates
|
||||
key: godot-templates-${{ env.GODOT_VERSION }}
|
||||
restore-keys: |
|
||||
godot-templates-
|
||||
|
||||
- name: Create build directory
|
||||
run: mkdir -p ${{ env.BUILD_DIR }}
|
||||
|
||||
- name: Import project assets
|
||||
run: |
|
||||
echo "📦 Importing project assets..."
|
||||
godot --headless --verbose --editor --quit || true
|
||||
sleep 2
|
||||
|
||||
- name: Build Android APK
|
||||
run: |
|
||||
echo "🏗️ Building Android APK..."
|
||||
|
||||
# Set ANDROID_HOME if not already set
|
||||
export ANDROID_HOME=${ANDROID_HOME:-$ANDROID_SDK_ROOT}
|
||||
|
||||
godot --headless --verbose --export-${{ needs.prepare.outputs.build_type }} "Android" \
|
||||
${{ env.BUILD_DIR }}/skelly-android-${{ needs.prepare.outputs.version }}.apk
|
||||
|
||||
# Verify build output
|
||||
if [[ -f "${{ env.BUILD_DIR }}/skelly-android-${{ needs.prepare.outputs.version }}.apk" ]]; then
|
||||
echo "✅ Android build successful"
|
||||
ls -la ${{ env.BUILD_DIR }}/
|
||||
|
||||
# Show APK info
|
||||
echo "📱 APK Information:"
|
||||
file ${{ env.BUILD_DIR }}/skelly-android-${{ needs.prepare.outputs.version }}.apk
|
||||
else
|
||||
echo "❌ Android build failed"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Upload Android build
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: ${{ needs.prepare.outputs.artifact_name }}-android
|
||||
path: ${{ env.BUILD_DIR }}/skelly-android-${{ needs.prepare.outputs.version }}.apk
|
||||
retention-days: 7
|
||||
compression-level: 0
|
||||
|
||||
# Summary job - creates release summary
|
||||
summary:
|
||||
name: Build Summary
|
||||
runs-on: ubuntu-latest
|
||||
needs: [prepare, setup-templates, build-windows, build-linux, build-macos, build-android]
|
||||
if: always()
|
||||
|
||||
steps:
|
||||
- name: Generate build summary
|
||||
run: |
|
||||
echo "🎮 Build Summary for ${{ needs.prepare.outputs.artifact_name }}"
|
||||
echo "=================================="
|
||||
echo ""
|
||||
echo "📋 Configuration:"
|
||||
echo " Version: ${{ needs.prepare.outputs.version }}"
|
||||
echo " Build Type: ${{ needs.prepare.outputs.build_type }}"
|
||||
echo " Platforms: ${{ needs.prepare.outputs.platforms }}"
|
||||
echo ""
|
||||
echo "📊 Build Results:"
|
||||
|
||||
platforms="${{ needs.prepare.outputs.platforms }}"
|
||||
|
||||
if [[ "$platforms" == *"windows"* ]]; then
|
||||
windows_status="${{ needs.build-windows.result }}"
|
||||
echo " 🪟 Windows: $windows_status"
|
||||
fi
|
||||
|
||||
if [[ "$platforms" == *"linux"* ]]; then
|
||||
linux_status="${{ needs.build-linux.result }}"
|
||||
echo " 🐧 Linux: $linux_status"
|
||||
fi
|
||||
|
||||
if [[ "$platforms" == *"macos"* ]]; then
|
||||
macos_status="${{ needs.build-macos.result }}"
|
||||
echo " 🍎 macOS: $macos_status"
|
||||
fi
|
||||
|
||||
if [[ "$platforms" == *"android"* ]]; then
|
||||
android_status="${{ needs.build-android.result }}"
|
||||
echo " 🤖 Android: $android_status"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "📦 Artifacts are available for 7 days"
|
||||
echo "🔗 Download from: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
|
||||
|
||||
- name: Check overall build status
|
||||
run: |
|
||||
# Check if any required builds failed
|
||||
platforms="${{ needs.prepare.outputs.platforms }}"
|
||||
failed_builds=()
|
||||
|
||||
if [[ "$platforms" == *"windows"* ]] && [[ "${{ needs.build-windows.result }}" != "success" ]]; then
|
||||
failed_builds+=("Windows")
|
||||
fi
|
||||
|
||||
if [[ "$platforms" == *"linux"* ]] && [[ "${{ needs.build-linux.result }}" != "success" ]]; then
|
||||
failed_builds+=("Linux")
|
||||
fi
|
||||
|
||||
if [[ "$platforms" == *"macos"* ]] && [[ "${{ needs.build-macos.result }}" != "success" ]]; then
|
||||
failed_builds+=("macOS")
|
||||
fi
|
||||
|
||||
if [[ "$platforms" == *"android"* ]] && [[ "${{ needs.build-android.result }}" != "success" ]]; then
|
||||
failed_builds+=("Android")
|
||||
fi
|
||||
|
||||
if [[ ${#failed_builds[@]} -gt 0 ]]; then
|
||||
echo "❌ Build failed for: ${failed_builds[*]}"
|
||||
exit 1
|
||||
else
|
||||
echo "✅ All builds completed successfully!"
|
||||
fi
|
||||
304
.gitea/workflows/ci.yml
Normal file
@@ -0,0 +1,304 @@
|
||||
name: Continuous Integration
|
||||
|
||||
# CI pipeline for the Skelly Godot project
|
||||
#
|
||||
# Code quality checks (formatting, linting, testing) run as independent jobs
|
||||
# in parallel. Uses tools/run_development.py for consistency with local development.
|
||||
#
|
||||
# Features:
|
||||
# - Independent job execution (no dependencies between format/lint/test)
|
||||
# - Automatic code formatting with commit back to branch
|
||||
# - Error reporting and PR comments
|
||||
# - Manual execution with selective step skipping
|
||||
|
||||
on:
|
||||
# Trigger on push to any branch - only when relevant files change
|
||||
push:
|
||||
branches: ['*']
|
||||
paths:
|
||||
- '**/*.gd' # Any GDScript file
|
||||
- '.gdlintrc' # Linting configuration
|
||||
- '.gdformatrc' # Formatting configuration
|
||||
- 'tools/run_development.py' # Development workflow script
|
||||
- '.gitea/workflows/ci.yml' # This workflow file
|
||||
|
||||
# Trigger on pull requests - same file filters as push
|
||||
pull_request:
|
||||
branches: ['*']
|
||||
paths:
|
||||
- '**/*.gd'
|
||||
- '.gdlintrc'
|
||||
- '.gdformatrc'
|
||||
- 'tools/run_development.py'
|
||||
- '.gitea/workflows/ci.yml'
|
||||
|
||||
# Allow manual triggering with optional step skipping
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
skip_format:
|
||||
description: 'Skip code formatting'
|
||||
required: false
|
||||
default: 'false'
|
||||
type: boolean
|
||||
skip_lint:
|
||||
description: 'Skip code linting'
|
||||
required: false
|
||||
default: 'false'
|
||||
type: boolean
|
||||
skip_tests:
|
||||
description: 'Skip test execution'
|
||||
required: false
|
||||
default: 'false'
|
||||
type: boolean
|
||||
|
||||
jobs:
|
||||
format:
|
||||
name: Code Formatting
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
if: ${{ always() && github.event.inputs.skip_format != 'true' }}
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.ref || github.ref }}
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.11'
|
||||
cache: 'pip'
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install --upgrade "setuptools<81"
|
||||
pip install gdtoolkit==4
|
||||
|
||||
- name: Run code formatting
|
||||
id: format
|
||||
run: |
|
||||
echo "🎨 Running GDScript formatting..."
|
||||
python tools/run_development.py --format --silent --yaml > format_results.yaml
|
||||
|
||||
- name: Upload formatting results
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: format-results
|
||||
path: |
|
||||
format_results.yaml
|
||||
retention-days: 7
|
||||
compression-level: 0
|
||||
|
||||
- name: Check for formatting changes
|
||||
id: check-changes
|
||||
run: |
|
||||
if git diff --quiet; then
|
||||
echo "📝 No formatting changes detected"
|
||||
echo "has_changes=false" >> $GITHUB_OUTPUT
|
||||
else
|
||||
echo "📝 Formatting changes detected"
|
||||
echo "has_changes=true" >> $GITHUB_OUTPUT
|
||||
echo "🔍 Changed files:"
|
||||
git diff --name-only
|
||||
echo ""
|
||||
echo "📊 Diff summary:"
|
||||
git diff --stat
|
||||
fi
|
||||
|
||||
- name: Commit and push formatting changes
|
||||
if: steps.check-changes.outputs.has_changes == 'true'
|
||||
run: |
|
||||
echo "💾 Committing formatting changes..."
|
||||
|
||||
git config user.name "Gitea Actions"
|
||||
git config user.email "actions@gitea.local"
|
||||
|
||||
git add -A
|
||||
|
||||
commit_message="🎨 Auto-format GDScript code
|
||||
|
||||
Automated formatting applied by tools/run_development.py
|
||||
|
||||
🤖 Generated by Gitea Actions
|
||||
Workflow: ${{ github.workflow }}
|
||||
Run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
|
||||
|
||||
git commit -m "$commit_message"
|
||||
|
||||
target_branch="${{ github.event.pull_request.head.ref || github.ref_name }}"
|
||||
echo "📤 Pushing changes to branch: $target_branch"
|
||||
git push origin HEAD:"$target_branch"
|
||||
|
||||
echo "✅ Formatting changes pushed successfully!"
|
||||
|
||||
lint:
|
||||
name: Code Quality Check
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ github.event.inputs.skip_lint != 'true' }}
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.ref || github.ref }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.11'
|
||||
cache: 'pip'
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install --upgrade "setuptools<81"
|
||||
pip install gdtoolkit==4
|
||||
|
||||
- name: Run linting
|
||||
id: lint
|
||||
run: |
|
||||
echo "🔍 Running GDScript linting..."
|
||||
python tools/run_development.py --lint --silent --yaml > lint_results.yaml
|
||||
|
||||
- name: Upload linting results
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: lint-results
|
||||
path: |
|
||||
lint_results.yaml
|
||||
retention-days: 7
|
||||
compression-level: 0
|
||||
|
||||
test:
|
||||
name: Test Execution
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ github.event.inputs.skip_tests != 'true' }}
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.ref || github.ref }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.11'
|
||||
cache: 'pip'
|
||||
|
||||
- name: Install Python dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install --upgrade "setuptools<81"
|
||||
pip install gdtoolkit==4
|
||||
|
||||
- name: Set up Godot
|
||||
uses: chickensoft-games/setup-godot@v1
|
||||
with:
|
||||
version: 4.3.0
|
||||
use-dotnet: false
|
||||
|
||||
- name: Run tests
|
||||
id: test
|
||||
run: |
|
||||
echo "🧪 Running GDScript tests..."
|
||||
python tools/run_development.py --test --silent --yaml > test_results.yaml
|
||||
|
||||
- name: Upload test results
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: test-results
|
||||
path: |
|
||||
test_results.yaml
|
||||
retention-days: 7
|
||||
compression-level: 0
|
||||
|
||||
summary:
|
||||
name: CI Summary
|
||||
runs-on: ubuntu-latest
|
||||
needs: [format, lint, test]
|
||||
if: always()
|
||||
|
||||
steps:
|
||||
- name: Set workflow status
|
||||
id: status
|
||||
run: |
|
||||
format_status="${{ needs.format.result }}"
|
||||
lint_status="${{ needs.lint.result }}"
|
||||
test_status="${{ needs.test.result }}"
|
||||
|
||||
echo "📊 Workflow Results:"
|
||||
echo "🎨 Format: $format_status"
|
||||
echo "🔍 Lint: $lint_status"
|
||||
echo "🧪 Test: $test_status"
|
||||
|
||||
if [[ "$format_status" == "success" && "$lint_status" == "success" && ("$test_status" == "success" || "$test_status" == "skipped") ]]; then
|
||||
echo "overall_status=success" >> $GITHUB_OUTPUT
|
||||
echo "✅ All CI checks passed!"
|
||||
else
|
||||
echo "overall_status=failure" >> $GITHUB_OUTPUT
|
||||
echo "❌ Some CI checks failed"
|
||||
fi
|
||||
|
||||
- name: Comment on PR (if applicable)
|
||||
if: github.event_name == 'pull_request'
|
||||
uses: actions/github-script@v6
|
||||
with:
|
||||
script: |
|
||||
const formatStatus = '${{ needs.format.result }}';
|
||||
const lintStatus = '${{ needs.lint.result }}';
|
||||
const testStatus = '${{ needs.test.result }}';
|
||||
const overallStatus = '${{ steps.status.outputs.overall_status }}';
|
||||
|
||||
const getStatusEmoji = (status) => {
|
||||
switch(status) {
|
||||
case 'success': return '✅';
|
||||
case 'failure': return '❌';
|
||||
case 'skipped': return '⏭️';
|
||||
default: return '⚠️';
|
||||
}
|
||||
};
|
||||
|
||||
const message = `## 🤖 CI Pipeline Results
|
||||
|
||||
| Step | Status | Result |
|
||||
|------|--------|--------|
|
||||
| 🎨 Formatting | ${getStatusEmoji(formatStatus)} | ${formatStatus} |
|
||||
| 🔍 Linting | ${getStatusEmoji(lintStatus)} | ${lintStatus} |
|
||||
| 🧪 Testing | ${getStatusEmoji(testStatus)} | ${testStatus} |
|
||||
|
||||
**Overall Status:** ${getStatusEmoji(overallStatus)} ${overallStatus.toUpperCase()}
|
||||
|
||||
${overallStatus === 'success'
|
||||
? '🎉 All checks passed! This PR is ready for review.'
|
||||
: '⚠️ Some checks failed. Please review the workflow logs and fix any issues.'}
|
||||
|
||||
[View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})`;
|
||||
|
||||
github.rest.issues.createComment({
|
||||
issue_number: context.issue.number,
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
body: message
|
||||
});
|
||||
|
||||
- name: Set final exit code
|
||||
run: |
|
||||
if [[ "${{ steps.status.outputs.overall_status }}" == "success" ]]; then
|
||||
echo "🎉 CI Pipeline completed successfully!"
|
||||
exit 0
|
||||
else
|
||||
echo "❌ CI Pipeline failed"
|
||||
exit 1
|
||||
fi
|
||||
10
.gitignore
vendored
@@ -1,3 +1,13 @@
|
||||
# Godot 4+ specific ignores
|
||||
.godot/
|
||||
/android/
|
||||
|
||||
# Generated files
|
||||
*.tmp
|
||||
*.import~
|
||||
test_results.txt
|
||||
|
||||
# python
|
||||
|
||||
.venv
|
||||
*.pyc
|
||||
|
||||
9
CLAUDE.md
Normal file
@@ -0,0 +1,9 @@
|
||||
- The documentation of the project is located in docs/ directory;
|
||||
- Get following files in context before doing anything else:
|
||||
- docs\CLAUDE.md
|
||||
- docs\CODE_OF_CONDUCT.md
|
||||
- project.godot
|
||||
- Use TDD methodology for development;
|
||||
- Use static data types;
|
||||
- Keep documentation up to date;
|
||||
- Always run tests `./tools/run_development.py --yaml --silent`;
|
||||
97
DEVELOPMENT_TOOLS.md
Normal file
@@ -0,0 +1,97 @@
|
||||
# Development Tools
|
||||
|
||||
Development workflow tools for the Skelly Godot project.
|
||||
|
||||
Python script that handles code formatting, linting, and testing.
|
||||
|
||||
## Quick Start
|
||||
|
||||
Run all development checks (recommended for pre-commit):
|
||||
```bash
|
||||
run_dev.bat
|
||||
```
|
||||
|
||||
Runs code formatting → linting → testing.
|
||||
|
||||
## Available Commands
|
||||
|
||||
### Main Unified Script
|
||||
- **`run_dev.bat`** - Main unified development script with all functionality
|
||||
|
||||
### Individual Tools (Legacy - redirect to unified script)
|
||||
- **`run_all.bat`** - Same as `run_dev.bat` (legacy compatibility)
|
||||
- **`run_lint.bat`** - Run only linting (redirects to `run_dev.bat --lint`)
|
||||
- **`run_format.bat`** - Run only formatting (redirects to `run_dev.bat --format`)
|
||||
- **`run_tests.bat`** - Run only tests (redirects to `run_dev.bat --test`)
|
||||
|
||||
## Usage Examples
|
||||
|
||||
```bash
|
||||
# Run all checks (default behavior)
|
||||
run_dev.bat
|
||||
|
||||
# Run only specific tools
|
||||
run_dev.bat --lint
|
||||
run_dev.bat --format
|
||||
run_dev.bat --test
|
||||
|
||||
# Run custom workflow steps
|
||||
run_dev.bat --steps format lint
|
||||
run_dev.bat --steps format test
|
||||
|
||||
# Show help
|
||||
run_dev.bat --help
|
||||
```
|
||||
|
||||
## What Each Tool Does
|
||||
|
||||
### 🔍 Linting (`gdlint`)
|
||||
- Checks GDScript code for style violations
|
||||
- Enforces naming conventions
|
||||
- Validates code structure and patterns
|
||||
- **Fails the workflow if errors are found**
|
||||
|
||||
### 🎨 Formatting (`gdformat`)
|
||||
- Automatically formats GDScript code
|
||||
- Ensures consistent indentation and spacing
|
||||
- Fixes basic style issues
|
||||
- **Fails the workflow if files cannot be formatted**
|
||||
|
||||
### 🧪 Testing (`godot`)
|
||||
- Runs all test files in `tests/` directory
|
||||
- Executes Godot scripts in headless mode
|
||||
- Reports test results and failures
|
||||
- **Continues workflow even if tests fail** (for review)
|
||||
|
||||
## Dependencies
|
||||
|
||||
The script automatically checks for and provides installation instructions for:
|
||||
- Python 3.x
|
||||
- pip
|
||||
- Godot Engine (for tests)
|
||||
- gdtoolkit (gdlint, gdformat)
|
||||
|
||||
## Output Features
|
||||
|
||||
- Colorized output
|
||||
- Emoji status indicators
|
||||
- Tool summaries
|
||||
- Execution time tracking
|
||||
- Warning suppression
|
||||
|
||||
## Development Workflow
|
||||
|
||||
1. **Before committing**: Run `run_dev.bat` to ensure code quality
|
||||
2. **Fix any linting errors** - the workflow will abort on errors
|
||||
3. **Review any test failures** - tests don't abort workflow but should be addressed
|
||||
4. **Commit your changes** once all checks pass
|
||||
|
||||
## Integration
|
||||
|
||||
Works with:
|
||||
- Git hooks (pre-commit)
|
||||
- CI/CD pipelines
|
||||
- IDE integrations
|
||||
- Manual development workflow
|
||||
|
||||
Legacy batch files remain functional.
|
||||
|
Before Width: | Height: | Size: 3.9 KiB |
|
Before Width: | Height: | Size: 3.5 KiB |
|
Before Width: | Height: | Size: 3.2 KiB |
|
Before Width: | Height: | Size: 3.6 KiB |
|
Before Width: | Height: | Size: 4.3 KiB |
@@ -1,34 +0,0 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://feb10geiluq5"
|
||||
path="res://.godot/imported/attack2_down.png-a267b420875df4f3ba38080e87a192b1.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/ATTACK 2/attack2_down.png"
|
||||
dest_files=["res://.godot/imported/attack2_down.png-a267b420875df4f3ba38080e87a192b1.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
|
Before Width: | Height: | Size: 3.8 KiB |
@@ -1,34 +0,0 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://wtpvtxn4lwuw"
|
||||
path="res://.godot/imported/attack2_left.png-e55564bea3c81b2804f969b673509a16.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/ATTACK 2/attack2_left.png"
|
||||
dest_files=["res://.godot/imported/attack2_left.png-e55564bea3c81b2804f969b673509a16.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
|
Before Width: | Height: | Size: 3.6 KiB |
@@ -1,34 +0,0 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://cdey3cqp47fao"
|
||||
path="res://.godot/imported/attack2_right.png-842fb1e82239f879e2912cbf9c8ed4e3.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/ATTACK 2/attack2_right.png"
|
||||
dest_files=["res://.godot/imported/attack2_right.png-842fb1e82239f879e2912cbf9c8ed4e3.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
|
Before Width: | Height: | Size: 3.5 KiB |
@@ -1,34 +0,0 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://c0jmqpasov5a4"
|
||||
path="res://.godot/imported/attack2_up.png-a4e2c3e1441525efdc7e84dcd1705145.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/ATTACK 2/attack2_up.png"
|
||||
dest_files=["res://.godot/imported/attack2_up.png-a4e2c3e1441525efdc7e84dcd1705145.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
|
Before Width: | Height: | Size: 3.0 KiB |
@@ -1,34 +0,0 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://dcmhtymn7nmta"
|
||||
path="res://.godot/imported/idle_down.png-54651041b25f7ee533d7a8b03fc698ad.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/IDLE/idle_down.png"
|
||||
dest_files=["res://.godot/imported/idle_down.png-54651041b25f7ee533d7a8b03fc698ad.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
|
Before Width: | Height: | Size: 2.6 KiB |
@@ -1,34 +0,0 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://b2pfov82738xo"
|
||||
path="res://.godot/imported/idle_left.png-dfd1a56b6d75990f3ae1a099e61f566e.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/IDLE/idle_left.png"
|
||||
dest_files=["res://.godot/imported/idle_left.png-dfd1a56b6d75990f3ae1a099e61f566e.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
|
Before Width: | Height: | Size: 2.5 KiB |
|
Before Width: | Height: | Size: 3.1 KiB |
|
Before Width: | Height: | Size: 4.0 KiB |
|
Before Width: | Height: | Size: 3.8 KiB |
|
Before Width: | Height: | Size: 3.8 KiB |
@@ -1,34 +0,0 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://b8ib42gdqbyko"
|
||||
path="res://.godot/imported/run_right.png-8810fc783dba0acf1912fc84db1f5b13.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/RUN/run_right.png"
|
||||
dest_files=["res://.godot/imported/run_right.png-8810fc783dba0acf1912fc84db1f5b13.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
|
Before Width: | Height: | Size: 3.2 KiB |
24
assets/audio/music/817587__silverdubloons__tick06.wav.import
Normal file
@@ -0,0 +1,24 @@
|
||||
[remap]
|
||||
|
||||
importer="wav"
|
||||
type="AudioStreamWAV"
|
||||
uid="uid://briuh6uhf0tdt"
|
||||
path="res://.godot/imported/817587__silverdubloons__tick06.wav-6928d7a957ad4e7ff0ddda00a7348675.sample"
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://audio/817587__silverdubloons__tick06.wav"
|
||||
dest_files=["res://.godot/imported/817587__silverdubloons__tick06.wav-6928d7a957ad4e7ff0ddda00a7348675.sample"]
|
||||
|
||||
[params]
|
||||
|
||||
force/8_bit=false
|
||||
force/mono=false
|
||||
force/max_rate=false
|
||||
force/max_rate_hz=44100
|
||||
edit/trim=false
|
||||
edit/normalize=false
|
||||
edit/loop_mode=0
|
||||
edit/loop_begin=0
|
||||
edit/loop_end=-1
|
||||
compress/mode=2
|
||||
@@ -0,0 +1,24 @@
|
||||
[remap]
|
||||
|
||||
importer="wav"
|
||||
type="AudioStreamWAV"
|
||||
uid="uid://dcpehnwdueyyo"
|
||||
path="res://.godot/imported/Space Horror InGame Music (Exploration) _Clement Panchout.wav-b8a2c544037b0505487a02f0a4760b5c.sample"
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/audio/music/Space Horror InGame Music (Exploration) _Clement Panchout.wav"
|
||||
dest_files=["res://.godot/imported/Space Horror InGame Music (Exploration) _Clement Panchout.wav-b8a2c544037b0505487a02f0a4760b5c.sample"]
|
||||
|
||||
[params]
|
||||
|
||||
force/8_bit=false
|
||||
force/mono=false
|
||||
force/max_rate=false
|
||||
force/max_rate_hz=44100
|
||||
edit/trim=false
|
||||
edit/normalize=false
|
||||
edit/loop_mode=2
|
||||
edit/loop_begin=0
|
||||
edit/loop_end=-1
|
||||
compress/mode=2
|
||||
BIN
assets/audio/sfx/817587__silverdubloons__tick06.wav
Normal file
24
assets/audio/sfx/817587__silverdubloons__tick06.wav.import
Normal file
@@ -0,0 +1,24 @@
|
||||
[remap]
|
||||
|
||||
importer="wav"
|
||||
type="AudioStreamWAV"
|
||||
uid="uid://bafsd057v7yvg"
|
||||
path="res://.godot/imported/817587__silverdubloons__tick06.wav-073a8f633d78aad3d77b2f7c8ae0c273.sample"
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/audio/sfx/817587__silverdubloons__tick06.wav"
|
||||
dest_files=["res://.godot/imported/817587__silverdubloons__tick06.wav-073a8f633d78aad3d77b2f7c8ae0c273.sample"]
|
||||
|
||||
[params]
|
||||
|
||||
force/8_bit=false
|
||||
force/mono=false
|
||||
force/max_rate=false
|
||||
force/max_rate_hz=44100
|
||||
edit/trim=false
|
||||
edit/normalize=false
|
||||
edit/loop_mode=0
|
||||
edit/loop_begin=0
|
||||
edit/loop_end=-1
|
||||
compress/mode=2
|
||||
52
assets/sources.yaml
Normal file
@@ -0,0 +1,52 @@
|
||||
# Asset Attribution and Source Information
|
||||
# Every asset in this project must be documented here with complete metadata
|
||||
# Required fields: source, license, attribution, modifications, usage
|
||||
|
||||
audio:
|
||||
music:
|
||||
"Space Horror InGame Music (Exploration) _Clement Panchout.wav":
|
||||
source: "https://clement-panchout.itch.io/yet-another-free-music-pack"
|
||||
license: "" # TODO: Verify license from source
|
||||
attribution: "Space Horror InGame Music by Clement Panchout"
|
||||
modifications: "Converted to WAV format, loop configuration applied in AudioManager"
|
||||
usage: "Background music for all gameplay scenes and menus"
|
||||
|
||||
sfx:
|
||||
"817587__silverdubloons__tick06.wav":
|
||||
source: "https://freesound.org/people/SilverDubloons/sounds/817587/"
|
||||
license: "" # TODO: Verify license from freesound.org
|
||||
attribution: "Tick06 by SilverDubloons"
|
||||
modifications: "None"
|
||||
usage: "UI button click sound effects throughout the application"
|
||||
|
||||
sprites:
|
||||
characters:
|
||||
skeleton:
|
||||
"assets/sprites/characters/skeleton/*":
|
||||
source: "https://jesse-m.itch.io/skeleton-pack"
|
||||
license: "" # TODO: Verify license from itch.io page
|
||||
attribution: "Skeleton Pack by Jesse M"
|
||||
modifications: ""
|
||||
usage: "Placeholder for animation sprites"
|
||||
|
||||
skulls:
|
||||
"assets/sprites/skulls/*":
|
||||
source: "https://gitea.nett00n.org/nett00n/pixelart/src/branch/main/pixelorama/2025-skelly-assests"
|
||||
license: "CC"
|
||||
attribution: "Skelly icons by @nett00n"
|
||||
modifications: ""
|
||||
usage: ""
|
||||
|
||||
Referenced in original sources.yaml but file not found:
|
||||
textures:
|
||||
backgrounds:
|
||||
"BG.pg":
|
||||
source: "https://gitea.nett00n.org/nett00n/pixelart/src/branch/main/pixelorama/2025-skelly-assests"
|
||||
license: "CC"
|
||||
attribution: "Skelly icons by @nett00n"
|
||||
modifications: ""
|
||||
usage: ""
|
||||
|
||||
# TODO: Verify all license information by visiting source URLs
|
||||
# TODO: Check for any missing assets not documented here
|
||||
# TODO: Confirm all attribution text meets source requirements
|
||||
BIN
assets/sprites/characters/skeleton/Skeleton Attack.png
Normal file
|
After Width: | Height: | Size: 3.8 KiB |
@@ -0,0 +1,34 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://cowabod6jrn47"
|
||||
path="res://.godot/imported/Skeleton Attack.png-31a9e5b2c10f873e155f012eeea3cf92.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/sprites/characters/skeleton/Skeleton Attack.png"
|
||||
dest_files=["res://.godot/imported/Skeleton Attack.png-31a9e5b2c10f873e155f012eeea3cf92.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
BIN
assets/sprites/characters/skeleton/Skeleton Dead.png
Normal file
|
After Width: | Height: | Size: 2.4 KiB |
@@ -2,16 +2,16 @@
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://qp2jk4w41r6y"
|
||||
path="res://.godot/imported/attack1_down.png-b70bf2e53928612487923b136463083b.ctex"
|
||||
uid="uid://660wqxgwh8dr"
|
||||
path="res://.godot/imported/Skeleton Dead.png-e1687d67e643bab4b8c92b164a03a547.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/ATTACK 1/attack1_down.png"
|
||||
dest_files=["res://.godot/imported/attack1_down.png-b70bf2e53928612487923b136463083b.ctex"]
|
||||
source_file="res://assets/sprites/characters/skeleton/Skeleton Dead.png"
|
||||
dest_files=["res://.godot/imported/Skeleton Dead.png-e1687d67e643bab4b8c92b164a03a547.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
BIN
assets/sprites/characters/skeleton/Skeleton Hit.png
Normal file
|
After Width: | Height: | Size: 1.6 KiB |
@@ -2,16 +2,16 @@
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://sbs1him0q10k"
|
||||
path="res://.godot/imported/attack1_right.png-02951fbee1fbdd749f7456e9f567cfc8.ctex"
|
||||
uid="uid://btfjyc4jfhiii"
|
||||
path="res://.godot/imported/Skeleton Hit.png-7311c991bcb76e5d6a77397d5558f61c.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/ATTACK 1/attack1_right.png"
|
||||
dest_files=["res://.godot/imported/attack1_right.png-02951fbee1fbdd749f7456e9f567cfc8.ctex"]
|
||||
source_file="res://assets/sprites/characters/skeleton/Skeleton Hit.png"
|
||||
dest_files=["res://.godot/imported/Skeleton Hit.png-7311c991bcb76e5d6a77397d5558f61c.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
BIN
assets/sprites/characters/skeleton/Skeleton Idle.png
Normal file
|
After Width: | Height: | Size: 1.3 KiB |
@@ -2,16 +2,16 @@
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://ohvv7upxg56s"
|
||||
path="res://.godot/imported/attack1_up.png-c3b28d552a4103b73d0f5ef629adb6df.ctex"
|
||||
uid="uid://bcr4bokw87m5n"
|
||||
path="res://.godot/imported/Skeleton Idle.png-6287b112f02c0e4ac23abbe600ade526.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/ATTACK 1/attack1_up.png"
|
||||
dest_files=["res://.godot/imported/attack1_up.png-c3b28d552a4103b73d0f5ef629adb6df.ctex"]
|
||||
source_file="res://assets/sprites/characters/skeleton/Skeleton Idle.png"
|
||||
dest_files=["res://.godot/imported/Skeleton Idle.png-6287b112f02c0e4ac23abbe600ade526.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
BIN
assets/sprites/characters/skeleton/Skeleton React.png
Normal file
|
After Width: | Height: | Size: 673 B |
34
assets/sprites/characters/skeleton/Skeleton React.png.import
Normal file
@@ -0,0 +1,34 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://cuo2o785qopo3"
|
||||
path="res://.godot/imported/Skeleton React.png-bae9c1ad14cb9e90c7d6e7d717e2699e.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/sprites/characters/skeleton/Skeleton React.png"
|
||||
dest_files=["res://.godot/imported/Skeleton React.png-bae9c1ad14cb9e90c7d6e7d717e2699e.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
BIN
assets/sprites/characters/skeleton/Skeleton Walk.png
Normal file
|
After Width: | Height: | Size: 1.8 KiB |
@@ -2,16 +2,16 @@
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://cpof32ag5c825"
|
||||
path="res://.godot/imported/attack1_left.png-d6ae5f8093ae75c98a8bb373f11338c5.ctex"
|
||||
uid="uid://b0dqy1at078ct"
|
||||
path="res://.godot/imported/Skeleton Walk.png-19ec7f5950a5cbfa9505c0dc4dd1b48f.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/ATTACK 1/attack1_left.png"
|
||||
dest_files=["res://.godot/imported/attack1_left.png-d6ae5f8093ae75c98a8bb373f11338c5.ctex"]
|
||||
source_file="res://assets/sprites/characters/skeleton/Skeleton Walk.png"
|
||||
dest_files=["res://.godot/imported/Skeleton Walk.png-19ec7f5950a5cbfa9505c0dc4dd1b48f.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
BIN
assets/sprites/skulls/blue.png
Normal file
|
After Width: | Height: | Size: 205 B |
@@ -2,16 +2,16 @@
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://bnl11lwoesv5q"
|
||||
path="res://.godot/imported/run_up.png-c7f3d4b289e9a67c498b4a41dbd1b725.ctex"
|
||||
uid="uid://dxq2ab2uo3fel"
|
||||
path="res://.godot/imported/blue.png-a5b81332a57b3efef9a75dd151a28d11.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/RUN/run_up.png"
|
||||
dest_files=["res://.godot/imported/run_up.png-c7f3d4b289e9a67c498b4a41dbd1b725.ctex"]
|
||||
source_file="res://assets/sprites/skulls/blue.png"
|
||||
dest_files=["res://.godot/imported/blue.png-a5b81332a57b3efef9a75dd151a28d11.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
BIN
assets/sprites/skulls/dark-blue.png
Normal file
|
After Width: | Height: | Size: 205 B |
@@ -2,16 +2,16 @@
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://d0d02ok6v7esf"
|
||||
path="res://.godot/imported/idle_right.png-7ddab363823cf2780a69a13aba445ea9.ctex"
|
||||
uid="uid://bma78772dfdq3"
|
||||
path="res://.godot/imported/dark-blue.png-59d632e889a5b721da0ae18edaed44bb.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/IDLE/idle_right.png"
|
||||
dest_files=["res://.godot/imported/idle_right.png-7ddab363823cf2780a69a13aba445ea9.ctex"]
|
||||
source_file="res://assets/sprites/skulls/dark-blue.png"
|
||||
dest_files=["res://.godot/imported/dark-blue.png-59d632e889a5b721da0ae18edaed44bb.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
BIN
assets/sprites/skulls/green.png
Normal file
|
After Width: | Height: | Size: 197 B |
@@ -2,16 +2,16 @@
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://dnhopng8ws1lo"
|
||||
path="res://.godot/imported/idle_up.png-673dce19bcb196068eed1c317ddea503.ctex"
|
||||
uid="uid://bodkdsn8aqcs0"
|
||||
path="res://.godot/imported/green.png-ff6e1cc04288883fe02a8594d666e276.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/IDLE/idle_up.png"
|
||||
dest_files=["res://.godot/imported/idle_up.png-673dce19bcb196068eed1c317ddea503.ctex"]
|
||||
source_file="res://assets/sprites/skulls/green.png"
|
||||
dest_files=["res://.godot/imported/green.png-ff6e1cc04288883fe02a8594d666e276.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
BIN
assets/sprites/skulls/grey.png
Normal file
|
After Width: | Height: | Size: 205 B |
@@ -2,16 +2,16 @@
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://fcm6d22eb6dv"
|
||||
path="res://.godot/imported/run_down.png-e6e0787e05cfffbe1e2a175969e1bd5b.ctex"
|
||||
uid="uid://dnq7a0tfqs6xv"
|
||||
path="res://.godot/imported/grey.png-ec35f235cffbff0246c0b496073088b5.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/RUN/run_down.png"
|
||||
dest_files=["res://.godot/imported/run_down.png-e6e0787e05cfffbe1e2a175969e1bd5b.ctex"]
|
||||
source_file="res://assets/sprites/skulls/grey.png"
|
||||
dest_files=["res://.godot/imported/grey.png-ec35f235cffbff0246c0b496073088b5.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
BIN
assets/sprites/skulls/orange.png
Normal file
|
After Width: | Height: | Size: 193 B |
@@ -2,16 +2,16 @@
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://cim03822crp33"
|
||||
path="res://.godot/imported/run_left.png-31fcb61e2cd45f95f4b0dd53630a11f8.ctex"
|
||||
uid="uid://iq603aympcro"
|
||||
path="res://.godot/imported/orange.png-8b2bb01a523f1a7b73fd852bdfe7ef38.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/Hero/RUN/run_left.png"
|
||||
dest_files=["res://.godot/imported/run_left.png-31fcb61e2cd45f95f4b0dd53630a11f8.ctex"]
|
||||
source_file="res://assets/sprites/skulls/orange.png"
|
||||
dest_files=["res://.godot/imported/orange.png-8b2bb01a523f1a7b73fd852bdfe7ef38.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
BIN
assets/sprites/skulls/pink.png
Normal file
|
After Width: | Height: | Size: 195 B |
34
assets/sprites/skulls/pink.png.import
Normal file
@@ -0,0 +1,34 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://ckslt30117ow5"
|
||||
path="res://.godot/imported/pink.png-8e1ef4f0f945c54fb98f36f4cbd18350.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/sprites/skulls/pink.png"
|
||||
dest_files=["res://.godot/imported/pink.png-8e1ef4f0f945c54fb98f36f4cbd18350.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
BIN
assets/sprites/skulls/purple.png
Normal file
|
After Width: | Height: | Size: 198 B |
34
assets/sprites/skulls/purple.png.import
Normal file
@@ -0,0 +1,34 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://dhxqh8wegngyu"
|
||||
path="res://.godot/imported/purple.png-532ae50f2abc0def69a2a3e5012ac904.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/sprites/skulls/purple.png"
|
||||
dest_files=["res://.godot/imported/purple.png-532ae50f2abc0def69a2a3e5012ac904.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
BIN
assets/sprites/skulls/red.png
Normal file
|
After Width: | Height: | Size: 193 B |
34
assets/sprites/skulls/red.png.import
Normal file
@@ -0,0 +1,34 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://d4mn1p6620x5s"
|
||||
path="res://.godot/imported/red.png-b1cc6fdfcc710fe28188480ae838b7ce.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/sprites/skulls/red.png"
|
||||
dest_files=["res://.godot/imported/red.png-b1cc6fdfcc710fe28188480ae838b7ce.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
BIN
assets/sprites/skulls/yellow.png
Normal file
|
After Width: | Height: | Size: 196 B |
34
assets/sprites/skulls/yellow.png.import
Normal file
@@ -0,0 +1,34 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://fw01lg2olk7f"
|
||||
path="res://.godot/imported/yellow.png-b1e27f543291797e145a5e83f2d9c671.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/sprites/skulls/yellow.png"
|
||||
dest_files=["res://.godot/imported/yellow.png-b1e27f543291797e145a5e83f2d9c671.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
BIN
assets/textures/backgrounds/BGx3.png
Normal file
|
After Width: | Height: | Size: 350 B |
34
assets/textures/backgrounds/BGx3.png.import
Normal file
@@ -0,0 +1,34 @@
|
||||
[remap]
|
||||
|
||||
importer="texture"
|
||||
type="CompressedTexture2D"
|
||||
uid="uid://bengv32u1jeym"
|
||||
path="res://.godot/imported/BGx3.png-7878045c31a8f7297b620b7e42c1a5bf.ctex"
|
||||
metadata={
|
||||
"vram_texture": false
|
||||
}
|
||||
|
||||
[deps]
|
||||
|
||||
source_file="res://assets/textures/backgrounds/BGx3.png"
|
||||
dest_files=["res://.godot/imported/BGx3.png-7878045c31a8f7297b620b7e42c1a5bf.ctex"]
|
||||
|
||||
[params]
|
||||
|
||||
compress/mode=0
|
||||
compress/high_quality=false
|
||||
compress/lossy_quality=0.7
|
||||
compress/hdr_compression=1
|
||||
compress/normal_map=0
|
||||
compress/channel_pack=0
|
||||
mipmaps/generate=false
|
||||
mipmaps/limit=-1
|
||||
roughness/mode=0
|
||||
roughness/src_normal=""
|
||||
process/fix_alpha_border=true
|
||||
process/premult_alpha=false
|
||||
process/normal_map_invert_y=false
|
||||
process/hdr_as_srgb=false
|
||||
process/hdr_clamp_exposure=false
|
||||
process/size_limit=0
|
||||
detect_3d/compress_to=1
|
||||
15
data/default_bus_layout.tres
Normal file
@@ -0,0 +1,15 @@
|
||||
[gd_resource type="AudioBusLayout" format=3 uid="uid://c4bwiq14nq074"]
|
||||
|
||||
[resource]
|
||||
bus/1/name = &"SFX"
|
||||
bus/1/solo = false
|
||||
bus/1/mute = false
|
||||
bus/1/bypass_fx = false
|
||||
bus/1/volume_db = 0.0
|
||||
bus/1/send = &"Master"
|
||||
bus/2/name = &"Music"
|
||||
bus/2/solo = false
|
||||
bus/2/mute = false
|
||||
bus/2/bypass_fx = false
|
||||
bus/2/volume_db = 0.0
|
||||
bus/2/send = &"Master"
|
||||
185
docs/CLAUDE.md
Normal file
@@ -0,0 +1,185 @@
|
||||
# CLAUDE.md
|
||||
|
||||
Guidance for Claude Code (claude.ai/code) when working with this repository.
|
||||
|
||||
## Project Overview
|
||||
|
||||
"Skelly" is a Godot 4.4 mobile game project with multiple gameplay modes. Supports match-3 puzzle gameplay with planned clickomania gameplay. Includes modular gameplay system, menu system, settings management, audio handling, localization support, and debug system.
|
||||
|
||||
**For detailed project architecture, see `docs/MAP.md`**
|
||||
|
||||
## Development Commands
|
||||
|
||||
### Running the Project
|
||||
- Open project in Godot Editor: Import `project.godot`
|
||||
- Run project: Press F5 in Godot Editor or use "Play" button
|
||||
- Debug: Use Godot's built-in debugger and remote inspector
|
||||
- Debug UI: Press F12 in-game or use debug button to toggle debug panels
|
||||
|
||||
### Testing & Development
|
||||
- Debug mode can be toggled with F12 key or debug button UI (available on all major scenes)
|
||||
- Match-3 debug controls include gem count adjustment and board reroll
|
||||
- Difficulty presets: Easy (3 gems), Normal (5 gems), Hard (8 gems)
|
||||
- Gameplay mode switching: Space+Enter in game scene switches between match-3 and clickomania modes
|
||||
- **Match-3 Gem Movement Testing**:
|
||||
- Keyboard: Arrow keys or WASD to navigate, Enter to select/confirm
|
||||
- Gamepad: D-pad to navigate, A button to select/confirm
|
||||
- Visual feedback: Selected tiles glow brighter with scale and color effects
|
||||
- Invalid swaps automatically revert after animation
|
||||
- State machine: WAITING → SELECTING → SWAPPING → PROCESSING
|
||||
- Test scripts located in `tests/` directory for system validation
|
||||
- Use `TestLogging.gd` to validate the logging system functionality
|
||||
|
||||
### Audio Configuration
|
||||
- Music: Located in `assets/audio/music/` directory with loop configuration in AudioManager
|
||||
- Sound effects: UI clicks and game audio managed through audio bus system
|
||||
- Audio buses: "Music" and "SFX" buses configured in `data/default_bus_layout.tres`
|
||||
|
||||
### Localization
|
||||
- Translations stored in `localization/` as `.translation` files
|
||||
- Currently supports English and Russian
|
||||
- New translations: Add to `project.godot` internationalization section
|
||||
|
||||
### Asset Management
|
||||
- **Document every asset** in `assets/sources.yaml` before committing
|
||||
- Include source, license, attribution, modifications, and usage information
|
||||
- Verify license compatibility
|
||||
- Commit asset files and sources.yaml together
|
||||
|
||||
## Key Development Guidelines
|
||||
|
||||
### Code Quality & Safety Standards
|
||||
- **Memory Management**: Use `queue_free()` instead of `free()`
|
||||
- **Input Validation**: Validate user inputs with bounds checking and type validation
|
||||
- **Error Handling**: Implement error handling with fallback mechanisms
|
||||
- **Race Condition Prevention**: Use state flags to prevent concurrent operations
|
||||
- **No Global State**: Avoid static variables; use instance-based architecture for testability
|
||||
|
||||
### Scene Management
|
||||
- **Use `GameManager` for all scene transitions** - never call `get_tree().change_scene_to_file()` directly
|
||||
- Scene paths defined as constants in GameManager
|
||||
- Error handling built into GameManager for failed scene loads
|
||||
- Use `GameManager.start_game_with_mode(mode)` to launch specific gameplay modes
|
||||
- Supported modes: "match3", "clickomania" (validated with whitelist)
|
||||
- GameManager prevents concurrent scene changes with `is_changing_scene` protection
|
||||
|
||||
### Autoload Usage
|
||||
- Use autoloads for global state management only
|
||||
- Prefer signals over direct access for loose coupling
|
||||
- Don't access autoloads from deeply nested components
|
||||
- **SaveManager**: Save system with tamper detection, race condition protection, and permissive validation
|
||||
- **SettingsManager**: Features input validation, NaN/Infinity checks, and security hardening
|
||||
- **GameManager**: Protected against race conditions with state management
|
||||
|
||||
### Save System Security & Data Integrity
|
||||
- **SaveManager implements security standards** for data protection
|
||||
- **Tamper Detection**: Deterministic checksums detect save file modification or corruption
|
||||
- **Race Condition Protection**: Save operation locking prevents concurrent conflicts
|
||||
- **Permissive Validation**: Auto-repair system fixes corrupted data instead of rejecting saves
|
||||
- **Type Safety**: NaN/Infinity/bounds checking for numeric values
|
||||
- **Memory Protection**: File size limits prevent memory exhaustion attacks
|
||||
- **Version Migration**: Backward-compatible system handles save format upgrades
|
||||
- **Error Recovery**: Multi-layered backup and fallback systems ensure no data loss
|
||||
- **Security Logging**: All save operations logged for monitoring and debugging
|
||||
|
||||
### Debug System Integration
|
||||
- Connect to `DebugManager.debug_ui_toggled` signal for debug UI visibility
|
||||
- Use F12 key for global debug toggle
|
||||
- Remove debug prints before committing unless permanently useful
|
||||
|
||||
### Logging System Usage
|
||||
- **All print() and push_error() statements migrated to DebugManager**
|
||||
- Use `DebugManager` logging functions instead of `print()`, `push_error()`, etc.
|
||||
- Use log levels: INFO for general messages, WARN for issues, ERROR for failures
|
||||
- Include categories to organize log output: `"GameManager"`, `"Match3"`, `"Settings"`, `"DebugMenu"`
|
||||
- Use structured logging for better debugging and production monitoring
|
||||
- Use `DebugManager.set_log_level()` to control verbosity during development and testing
|
||||
- Logging system provides unified output across all game systems
|
||||
|
||||
## Important File References
|
||||
|
||||
### Documentation Structure
|
||||
- **`docs/MAP.md`** - Complete project architecture and structure
|
||||
- **`docs/UI_COMPONENTS.md`** - Custom UI components
|
||||
- **`docs/CODE_OF_CONDUCT.md`** - Coding standards and best practices
|
||||
- **`docs/TESTING.md`** - Testing guidelines and conventions
|
||||
- **This file** - Claude Code specific development guidelines
|
||||
|
||||
### Key Scripts to Understand
|
||||
- `src/autoloads/GameManager.gd` - Scene transition patterns with race condition protection
|
||||
- `src/autoloads/SaveManager.gd` - **Save system with security features**
|
||||
- `src/autoloads/SettingsManager.gd` - Settings management with input validation and security
|
||||
- `src/autoloads/DebugManager.gd` - Debug system integration
|
||||
- `scenes/game/game.gd` - Main game scene with modular gameplay system
|
||||
- `scenes/game/gameplays/Match3Gameplay.gd` - Match-3 implementation with input validation
|
||||
- `scenes/game/gameplays/tile.gd` - Instance-based tile behavior without global state
|
||||
- `scenes/ui/DebugMenuBase.gd` - Unified debug menu base class
|
||||
- `scenes/ui/SettingsMenu.gd` - Settings UI with input validation
|
||||
- `scenes/game/gameplays/` - Individual gameplay mode implementations
|
||||
- `project.godot` - Input actions and autoload definitions
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Before Making Changes
|
||||
1. Check `docs/MAP.md` for architecture
|
||||
2. Review `docs/CODE_OF_CONDUCT.md` for coding standards
|
||||
3. **Review naming conventions**: See [Naming Convention Quick Reference](CODE_OF_CONDUCT.md#naming-convention-quick-reference) for all file and code naming standards
|
||||
4. Understand existing patterns before implementing features
|
||||
5. If adding assets, prepare `assets/sources.yaml` documentation following [asset naming conventions](CODE_OF_CONDUCT.md#5-asset-file-naming)
|
||||
|
||||
### Testing Changes
|
||||
- Run project with F5 in Godot Editor
|
||||
- Test debug UI with F12 toggle
|
||||
- Verify scene transitions work
|
||||
- Check mobile compatibility if UI changes made
|
||||
- Use test scripts from `tests/` directory to validate functionality
|
||||
- Run `TestLogging.gd` after logging system changes
|
||||
- **Save system testing**: Run save/load test suites after SaveManager changes
|
||||
- **Checksum validation**: Test `test_checksum_issue.gd` to verify deterministic checksums
|
||||
- **Migration compatibility**: Run `TestMigrationCompatibility.gd` for version upgrades
|
||||
|
||||
### Common Implementation Patterns
|
||||
- **Scene transitions**: Use `GameManager.start_game_with_mode()` with built-in validation
|
||||
- **Debug integration**: Connect to `DebugManager` signals and initialize debug state
|
||||
- **Logging**: Use `DebugManager.log_*()` functions with appropriate levels and categories
|
||||
- **Gameplay modes**: Implement in `scenes/game/gameplays/` directory following modular pattern
|
||||
- **Scoring system**: Connect `score_changed` signal from gameplay to main game scene
|
||||
- **Save/Load operations**: Use `SaveManager` with security and validation
|
||||
- **Settings**: Use `SettingsManager` with input validation, NaN/Infinity checks, and security hardening
|
||||
- **Audio**: Use `AudioManager` for music and sound effects
|
||||
- **Localization**: Use `LocalizationManager` for language switching
|
||||
- **UI Components**: Extend `DebugMenuBase` for debug menus to avoid code duplication
|
||||
- **Value Selection**: Use `ValueStepper` component for discrete option selection (language, resolution, difficulty)
|
||||
- **Memory Management**: Use `queue_free()` and await frame completion for safe cleanup
|
||||
- **Input Validation**: Validate user inputs with type checking and bounds validation
|
||||
|
||||
### Logging Best Practices
|
||||
```gdscript
|
||||
# Good logging
|
||||
DebugManager.log_info("Scene transition completed", "GameManager")
|
||||
DebugManager.log_warn("Settings file not found, using defaults", "Settings")
|
||||
DebugManager.log_error("Failed to load audio resource: " + audio_path, "AudioManager")
|
||||
|
||||
# Avoid
|
||||
print("debug") # Use structured logging instead
|
||||
push_error("error") # Use DebugManager.log_error() with category
|
||||
```
|
||||
|
||||
### Asset Management Workflow
|
||||
```yaml
|
||||
# ✅ Required assets/sources.yaml entry format
|
||||
audio:
|
||||
music:
|
||||
"background_music.ogg":
|
||||
source: "https://freesound.org/people/artist/sounds/123456/"
|
||||
license: "CC BY 4.0"
|
||||
attribution: "Background Music by Artist Name"
|
||||
modifications: "Converted to OGG, adjusted volume"
|
||||
usage: "Main menu and gameplay background music"
|
||||
|
||||
# ✅ Proper commit workflow
|
||||
# 1. Add asset to appropriate assets/ subdirectory
|
||||
# 2. Update assets/sources.yaml with complete metadata
|
||||
# 3. git add both files together
|
||||
# 4. Commit with descriptive message including attribution
|
||||
```
|
||||
572
docs/CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,572 @@
|
||||
# Code of Conduct - Skelly Project
|
||||
|
||||
## Overview
|
||||
|
||||
Coding standards and development practices for the Skelly project. These guidelines help developers contribute effectively while maintaining code quality and project consistency.
|
||||
|
||||
## Core Principles
|
||||
|
||||
### 1. Code Clarity Over Cleverness
|
||||
- Write code that is easy to read
|
||||
- Use descriptive variable and function names
|
||||
- Prefer explicit code over "clever" solutions
|
||||
- Comment complex logic and business rules
|
||||
|
||||
### 2. Consistency First
|
||||
- Follow existing code patterns
|
||||
- Use same naming conventions throughout
|
||||
- Maintain consistent indentation and formatting
|
||||
- Follow Godot's GDScript style guide
|
||||
|
||||
### 3. Incremental Development
|
||||
- Make small, focused commits
|
||||
- Test changes before committing
|
||||
- Don't break existing functionality
|
||||
- Use debug system to verify changes
|
||||
|
||||
## GDScript Coding Standards
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
> 📋 **Quick Reference**: For complete naming convention details, see the **[Naming Convention Quick Reference](#naming-convention-quick-reference)** section below.
|
||||
|
||||
```gdscript
|
||||
# Variables and functions: snake_case
|
||||
var player_health: int = 100
|
||||
func calculate_damage() -> int:
|
||||
|
||||
# Constants: SCREAMING_SNAKE_CASE
|
||||
const MAX_HEALTH := 100
|
||||
const TILE_SPACING := 54
|
||||
|
||||
# Classes: PascalCase
|
||||
class_name PlayerController
|
||||
|
||||
# Scene files (.tscn) and Script files (.gd): PascalCase
|
||||
# MainMenu.tscn, MainMenu.gd
|
||||
# Match3Gameplay.tscn, Match3Gameplay.gd
|
||||
# TestAudioManager.gd (test files)
|
||||
|
||||
# Signals: past_tense
|
||||
signal health_changed
|
||||
signal game_started
|
||||
|
||||
# Private functions: prefix with underscore
|
||||
func _ready():
|
||||
func _initialize_grid():
|
||||
```
|
||||
|
||||
### File Organization
|
||||
```gdscript
|
||||
# 1. extends statement
|
||||
extends Node2D
|
||||
|
||||
# 2. class_name (if applicable)
|
||||
class_name Match3Controller
|
||||
|
||||
# 3. Constants
|
||||
const GRID_SIZE := Vector2i(8, 8)
|
||||
|
||||
# 4. Signals
|
||||
signal match_found(tiles: Array)
|
||||
|
||||
# 5. Variables
|
||||
var grid := []
|
||||
@onready var debug_ui = $DebugUI
|
||||
|
||||
# 6. Functions (lifecycle first, then custom)
|
||||
func _ready():
|
||||
func _process(delta):
|
||||
func custom_function():
|
||||
```
|
||||
|
||||
### Documentation Requirements
|
||||
```gdscript
|
||||
# Required for all public functions
|
||||
func set_gem_pool(gem_indices: Array) -> void:
|
||||
"""Set specific gem types as the active pool"""
|
||||
_update_all_tiles_gem_pool(gem_indices)
|
||||
print("Set gem pool to: ", gem_indices)
|
||||
|
||||
# Document complex algorithms
|
||||
func _get_match_line(start: Vector2i, dir: Vector2i) -> Array:
|
||||
"""Find all matching tiles in a line from start position in given direction"""
|
||||
var line = [grid[start.y][start.x]]
|
||||
var type = grid[start.y][start.x].tile_type
|
||||
# Implementation...
|
||||
```
|
||||
|
||||
## Project-Specific Guidelines
|
||||
|
||||
### Scene Management
|
||||
- All scene transitions go through `GameManager`
|
||||
- Never use `get_tree().change_scene_to_file()` directly
|
||||
- Define scene paths as constants in GameManager
|
||||
|
||||
```gdscript
|
||||
# ✅ Correct
|
||||
GameManager.start_match3_game()
|
||||
|
||||
# ❌ Wrong
|
||||
get_tree().change_scene_to_file("res://scenes/game/Game.tscn")
|
||||
```
|
||||
|
||||
### Autoload Usage
|
||||
- Use autoloads for global state only
|
||||
- Don't access autoloads from deeply nested components
|
||||
- Pass data through signals or direct references when possible
|
||||
|
||||
```gdscript
|
||||
# ✅ Correct - using signals
|
||||
signal settings_changed
|
||||
SettingsManager.volume_changed.connect(_on_volume_changed)
|
||||
|
||||
# ✅ Also correct - direct access for global state
|
||||
var current_language = SettingsManager.get_setting("language")
|
||||
|
||||
# ❌ Wrong - tight coupling
|
||||
func some_deep_function():
|
||||
SettingsManager.set_setting("volume", 0.5) # Too deep in call stack
|
||||
```
|
||||
|
||||
### Debug System Integration
|
||||
- Always connect to DebugManager signals for debug UI
|
||||
- Use structured logging instead of plain print statements
|
||||
- Remove temporary debug logs before committing (unless permanently useful)
|
||||
|
||||
```gdscript
|
||||
# ✅ Correct debug integration
|
||||
func _connect_to_global_debug() -> void:
|
||||
DebugManager.debug_ui_toggled.connect(_on_debug_ui_toggled)
|
||||
debug_ui.visible = DebugManager.is_debug_ui_visible()
|
||||
|
||||
# ✅ Good structured logging
|
||||
DebugManager.log_debug("Debug UI toggled to: " + str(visible), "Match3")
|
||||
DebugManager.log_info("Initialized " + str(tiles.size()) + " tiles", "TileSystem")
|
||||
|
||||
# ❌ Bad logging practices
|
||||
print("test") # Not descriptive, use structured logging
|
||||
print(some_variable) # No context, use proper log level
|
||||
```
|
||||
|
||||
### Logging Standards
|
||||
- Use `DebugManager.log_*()` functions instead of `print()` or `push_error()`
|
||||
- Choose log levels based on message importance and audience
|
||||
- Include categories to organize log output by system/component
|
||||
- Format messages with clear, descriptive text and relevant context
|
||||
|
||||
```gdscript
|
||||
# ✅ Correct logging usage
|
||||
DebugManager.log_info("Game scene loaded successfully", "SceneManager")
|
||||
DebugManager.log_warn("Audio file not found, using default", "AudioManager")
|
||||
DebugManager.log_error("Failed to save settings: " + error_message, "Settings")
|
||||
|
||||
# ❌ Wrong approaches
|
||||
print("loaded") # Use DebugManager.log_info() with category
|
||||
push_error("error") # Use DebugManager.log_error() with context
|
||||
if debug_mode: print("debug info") # Use DebugManager.log_debug()
|
||||
```
|
||||
|
||||
### Asset Management
|
||||
- **Document every asset** in `assets/sources.yaml`
|
||||
- Include source information, license details, and attribution
|
||||
- Document modifications made to original assets
|
||||
- Verify license compatibility before adding assets
|
||||
- Update sources.yaml in same commit as adding asset
|
||||
|
||||
```gdscript
|
||||
# ✅ Correct asset addition workflow
|
||||
# 1. Add asset file to appropriate assets/ subdirectory
|
||||
# 2. Update assets/sources.yaml with complete metadata
|
||||
# 3. Commit both files together with descriptive message
|
||||
|
||||
# Example sources.yaml entry:
|
||||
# audio:
|
||||
# sfx:
|
||||
# "button_click.wav":
|
||||
# source: "https://freesound.org/people/user/sounds/12345/"
|
||||
# license: "CC BY 3.0"
|
||||
# attribution: "Button Click by SoundArtist"
|
||||
# modifications: "Normalized volume, trimmed silence"
|
||||
# usage: "UI button interactions"
|
||||
```
|
||||
|
||||
### Error Handling
|
||||
- Check if resources loaded successfully
|
||||
- Use `DebugManager.log_error()` for critical failures
|
||||
- Provide fallback behavior when possible
|
||||
- Include meaningful context in error messages
|
||||
|
||||
```gdscript
|
||||
# Good error handling with structured logging
|
||||
func load_scene(path: String) -> void:
|
||||
var packed_scene := load(path)
|
||||
if not packed_scene or not packed_scene is PackedScene:
|
||||
DebugManager.log_error("Failed to load scene at: %s" % path, "SceneLoader")
|
||||
return
|
||||
DebugManager.log_info("Successfully loaded scene: %s" % path, "SceneLoader")
|
||||
get_tree().change_scene_to_packed(packed_scene)
|
||||
```
|
||||
|
||||
## Git Workflow
|
||||
|
||||
### Commit Guidelines
|
||||
- Use clear, descriptive commit messages
|
||||
- Start with a verb in imperative mood
|
||||
- Keep first line under 50 characters
|
||||
- Add body if needed for complex changes
|
||||
|
||||
```bash
|
||||
# Good commit messages
|
||||
Add gem pool management to match-3 system
|
||||
Fix debug UI visibility toggle issue
|
||||
Update documentation for new debug system
|
||||
|
||||
# Bad commit messages
|
||||
fix bug
|
||||
update
|
||||
wip
|
||||
```
|
||||
|
||||
### Branch Management
|
||||
- Create feature branches for new functionality
|
||||
- Use descriptive branch names: `feature/debug-ui`, `fix/tile-positioning`
|
||||
- Keep branches focused on single features
|
||||
- Delete branches after merging
|
||||
|
||||
### Before Committing
|
||||
1. Test your changes in the Godot editor
|
||||
2. Check that existing functionality still works
|
||||
3. Use the debug system to verify your implementation
|
||||
4. Run the project and navigate through affected areas
|
||||
5. Remove temporary debug code
|
||||
|
||||
## Code Review Guidelines
|
||||
|
||||
### For Reviewers
|
||||
- Focus on code clarity and maintainability
|
||||
- Check for adherence to project patterns
|
||||
- Verify that autoloads are used appropriately
|
||||
- Ensure debug integration is properly implemented
|
||||
- Test the changes yourself
|
||||
|
||||
### For Contributors
|
||||
- Explain complex logic in commit messages or comments
|
||||
- Provide context for why changes were made
|
||||
- Test edge cases and error conditions
|
||||
- Ask questions if project patterns are unclear
|
||||
|
||||
## Testing Approach
|
||||
|
||||
### Manual Testing Requirements
|
||||
- Test in Godot editor with F5 run
|
||||
- Verify debug UI works with F12 toggle
|
||||
- Check scene transitions work
|
||||
- Test on different screen sizes (mobile target)
|
||||
- Verify audio and settings integration
|
||||
|
||||
### Debug System Testing
|
||||
- Ensure debug panels appear/disappear correctly
|
||||
- Test all debug buttons and controls
|
||||
- Verify debug state persists across scene changes
|
||||
- Check debug code doesn't affect release builds
|
||||
|
||||
## Naming Convention Quick Reference
|
||||
|
||||
> 🎯 **Single Source of Truth**: This section contains all naming conventions for the Skelly project. All other documentation files reference this section to avoid duplication and ensure consistency.
|
||||
|
||||
### 1. GDScript Code Elements
|
||||
|
||||
```gdscript
|
||||
# Variables and functions: snake_case
|
||||
var player_health: int = 100
|
||||
func calculate_damage() -> int:
|
||||
|
||||
# Constants: SCREAMING_SNAKE_CASE
|
||||
const MAX_HEALTH := 100
|
||||
const TILE_SPACING := 54
|
||||
|
||||
# Classes: PascalCase
|
||||
class_name PlayerController
|
||||
|
||||
# Signals: past_tense_with_underscores
|
||||
signal health_changed
|
||||
signal game_started
|
||||
signal match_found
|
||||
|
||||
# Private functions: prefix with underscore
|
||||
func _ready():
|
||||
func _initialize_grid():
|
||||
```
|
||||
|
||||
### 2. File Naming Standards
|
||||
|
||||
#### Script and Scene Files
|
||||
```gdscript
|
||||
# ✅ Correct: All .gd and .tscn files use PascalCase
|
||||
MainMenu.tscn / MainMenu.gd
|
||||
Match3Gameplay.tscn / Match3Gameplay.gd
|
||||
ClickomaniaGameplay.tscn / ClickomaniaGameplay.gd
|
||||
ValueStepper.tscn / ValueStepper.gd
|
||||
|
||||
# Test files: PascalCase with "Test" prefix
|
||||
TestAudioManager.gd
|
||||
TestGameManager.gd
|
||||
TestMatch3Gameplay.gd
|
||||
|
||||
# ❌ Wrong: Old snake_case style (being migrated)
|
||||
main_menu.tscn / main_menu.gd
|
||||
TestAudioManager.gd
|
||||
```
|
||||
|
||||
**Rules:**
|
||||
- Scene files (.tscn) must match their script file name exactly
|
||||
- All new files must use PascalCase
|
||||
- Test files use "Test" prefix + PascalCase
|
||||
- Autoload scripts follow PascalCase (GameManager.gd, AudioManager.gd)
|
||||
|
||||
### 3. Directory Naming Conventions
|
||||
|
||||
#### Source Code Directories
|
||||
```
|
||||
# Source directories: snake_case
|
||||
src/autoloads/
|
||||
scenes/game/gameplays/
|
||||
scenes/ui/components/
|
||||
tests/helpers/
|
||||
|
||||
# Root directories: lowercase
|
||||
docs/
|
||||
tests/
|
||||
tools/
|
||||
data/
|
||||
```
|
||||
|
||||
#### Asset Directories
|
||||
```
|
||||
# Asset directories: kebab-case
|
||||
assets/audio-files/
|
||||
assets/ui-sprites/
|
||||
assets/game-textures/
|
||||
assets/fonts/
|
||||
localization/
|
||||
```
|
||||
|
||||
### 4. Resource and Configuration Files
|
||||
|
||||
```bash
|
||||
# Configuration files: lowercase with dots
|
||||
project.godot
|
||||
gdlintrc
|
||||
.gdformatrc
|
||||
.editorconfig
|
||||
export_presets.cfg
|
||||
|
||||
# Godot resource files (.tres): PascalCase
|
||||
data/DefaultBusLayout.tres
|
||||
data/PlayerSaveData.tres
|
||||
scenes/ui/DefaultTheme.tres
|
||||
|
||||
# Asset metadata: kebab-case
|
||||
assets/asset-sources.yaml
|
||||
assets/audio-files/audio-sources.yaml
|
||||
assets/ui-sprites/sprite-sources.yaml
|
||||
|
||||
# Development files: kebab-case
|
||||
requirements.txt
|
||||
development-tools.md
|
||||
```
|
||||
|
||||
### 5. Asset File Naming
|
||||
|
||||
```bash
|
||||
# Audio files: kebab-case in kebab-case directories
|
||||
assets/audio-files/background-music.ogg
|
||||
assets/audio-files/ui-sounds/button-click.wav
|
||||
assets/audio-files/game-sounds/match-sound.wav
|
||||
|
||||
# Visual assets: kebab-case
|
||||
assets/ui-sprites/main-menu-background.png
|
||||
assets/game-textures/gem-blue.png
|
||||
assets/fonts/main-ui-font.ttf
|
||||
|
||||
# Import settings: match the original file
|
||||
background-music.ogg.import
|
||||
button-click.wav.import
|
||||
```
|
||||
|
||||
**Asset Rules:**
|
||||
- All asset files use kebab-case
|
||||
- Organized in kebab-case directories
|
||||
- Import files automatically match asset names
|
||||
- Document all assets in `asset-sources.yaml`
|
||||
|
||||
### 6. Git Workflow Conventions
|
||||
|
||||
#### Branch Naming
|
||||
```bash
|
||||
# Feature branches: feature/description-with-hyphens
|
||||
feature/new-gameplay-mode
|
||||
feature/settings-ui-improvement
|
||||
feature/audio-system-upgrade
|
||||
|
||||
# Bug fixes: fix/description-with-hyphens
|
||||
fix/tile-positioning-bug
|
||||
fix/save-data-corruption
|
||||
fix/debug-menu-visibility
|
||||
|
||||
# Refactoring: refactor/component-name
|
||||
refactor/match3-input-system
|
||||
refactor/autoload-structure
|
||||
|
||||
# Documentation: docs/section-name
|
||||
docs/code-of-conduct-update
|
||||
docs/api-documentation
|
||||
```
|
||||
|
||||
#### Commit Message Format
|
||||
```bash
|
||||
# Format: <type>: <description>
|
||||
# Examples:
|
||||
feat: add dark mode toggle to settings menu
|
||||
fix: resolve tile swap animation timing issue
|
||||
docs: update naming conventions in code of conduct
|
||||
refactor: migrate print statements to DebugManager
|
||||
test: add comprehensive match3 validation tests
|
||||
```
|
||||
|
||||
### 7. Quick Reference Summary
|
||||
|
||||
| File Type | Convention | Example |
|
||||
|-----------|------------|---------|
|
||||
| **GDScript Files** | PascalCase | `MainMenu.gd`, `AudioManager.gd` |
|
||||
| **Scene Files** | PascalCase | `MainMenu.tscn`, `Match3Gameplay.tscn` |
|
||||
| **Test Files** | Test + PascalCase | `TestAudioManager.gd` |
|
||||
| **Variables/Functions** | snake_case | `player_health`, `calculate_damage()` |
|
||||
| **Constants** | SCREAMING_SNAKE_CASE | `MAX_HEALTH`, `TILE_SPACING` |
|
||||
| **Classes** | PascalCase | `class_name PlayerController` |
|
||||
| **Signals** | past_tense | `health_changed`, `game_started` |
|
||||
| **Directories** | snake_case (src) / kebab-case (assets) | `src/autoloads/`, `assets/audio-files/` |
|
||||
| **Assets** | kebab-case | `background-music.ogg`, `gem-blue.png` |
|
||||
| **Config Files** | lowercase.extension | `project.godot`, `.gdformatrc` |
|
||||
| **Branches** | type/kebab-case | `feature/new-gameplay`, `fix/tile-bug` |
|
||||
|
||||
> ✅ **Status**: All major file naming inconsistencies have been resolved. The project now follows consistent PascalCase naming for all .gd and .tscn files.
|
||||
|
||||
### 8. File Renaming Migration Guide
|
||||
|
||||
When renaming files to follow conventions:
|
||||
|
||||
**Step-by-step procedure:**
|
||||
1. **Use Git rename**: `git mv old_file.gd NewFile.gd` (preserves history)
|
||||
2. **Update .tscn references**: Modify script path in scene files
|
||||
3. **Update code references**: Search and replace all `preload()` and `load()` statements
|
||||
4. **Update project.godot**: If file is referenced in autoloads or project settings
|
||||
5. **Update documentation**: Search all .md files for old references
|
||||
6. **Update test files**: Modify any test files that reference the renamed file
|
||||
7. **Run validation**: Execute `gdlint`, `gdformat`, and project tests
|
||||
8. **Verify in editor**: Load scenes in Godot editor to confirm everything works
|
||||
|
||||
**Tools for validation:**
|
||||
- `python tools/run_development.py --test` - Run all tests
|
||||
- `python tools/run_development.py --lint` - Check code quality
|
||||
- `python tools/run_development.py --format` - Ensure consistent formatting
|
||||
|
||||
## Common Mistakes to Avoid
|
||||
|
||||
### Architecture Violations
|
||||
```gdscript
|
||||
# Don't bypass GameManager
|
||||
get_tree().change_scene_to_file("some_scene.tscn")
|
||||
|
||||
# Don't hardcode paths
|
||||
var tile = load("res://scenes/game/gameplays/Tile.tscn")
|
||||
|
||||
# Don't ignore null checks
|
||||
var node = get_node("SomeNode")
|
||||
node.do_something() # Could crash if node doesn't exist
|
||||
|
||||
# Don't create global state in random scripts
|
||||
# Use autoloads instead
|
||||
```
|
||||
|
||||
### Asset Management Violations
|
||||
```gdscript
|
||||
# Don't add assets without documentation
|
||||
# Adding audio/new_music.mp3 without updating sources.yaml
|
||||
|
||||
# Don't use assets without verifying licenses
|
||||
# Using copyrighted music without permission
|
||||
|
||||
# Don't modify assets without documenting changes
|
||||
# Editing sprites without noting modifications in sources.yaml
|
||||
|
||||
# Don't commit assets and documentation separately
|
||||
git add assets/sprites/new_sprite.png
|
||||
git commit -m "add sprite" # Missing sources.yaml update
|
||||
|
||||
# Correct approach
|
||||
git add assets/sprites/new_sprite.png assets/sources.yaml
|
||||
git commit -m "add new sprite with attribution"
|
||||
```
|
||||
|
||||
### Performance Issues
|
||||
```gdscript
|
||||
# Don't search nodes repeatedly
|
||||
func _process(delta):
|
||||
var ui = get_node("UI") # Expensive every frame
|
||||
|
||||
# Cache node references
|
||||
@onready var ui = $UI
|
||||
func _process(delta):
|
||||
ui.update_display() # Much better
|
||||
```
|
||||
|
||||
### Debug System Misuse
|
||||
```gdscript
|
||||
# Don't create separate debug systems
|
||||
var my_debug_enabled = false
|
||||
print("debug: " + some_info) # Don't use plain print()
|
||||
|
||||
# Use the global debug and logging systems
|
||||
if DebugManager.is_debug_enabled():
|
||||
show_debug_info()
|
||||
DebugManager.log_debug("Debug information: " + some_info, "MyComponent")
|
||||
```
|
||||
|
||||
## Learning Resources
|
||||
|
||||
### Godot-Specific
|
||||
- [GDScript Style Guide](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_styleguide.html)
|
||||
- [Godot Best Practices](https://docs.godotengine.org/en/stable/tutorials/best_practices/index.html)
|
||||
- Project documentation in `docs/map.md`
|
||||
|
||||
### General Programming
|
||||
- Clean Code principles
|
||||
- SOLID principles (adapted for game development)
|
||||
- Git best practices
|
||||
|
||||
## Getting Help
|
||||
|
||||
### When Stuck
|
||||
1. Check existing code for similar patterns
|
||||
2. Review project documentation (`docs/`)
|
||||
3. Use the debug system to understand current state
|
||||
4. Ask specific questions about project architecture
|
||||
5. Test your understanding with small experiments
|
||||
|
||||
### Code Review Process
|
||||
- Submit pull requests early and often
|
||||
- Ask for feedback on approach before implementing large features
|
||||
- Be open to suggestions and alternative approaches
|
||||
- Learn from review feedback for future contributions
|
||||
|
||||
## Summary
|
||||
|
||||
This code of conduct emphasizes:
|
||||
- **Clarity**: Write code that others can understand
|
||||
- **Consistency**: Follow established patterns
|
||||
- **Integration**: Use the project's systems properly
|
||||
- **Learning**: Continuously improve your skills
|
||||
|
||||
Remember: It's better to ask questions and write clear, simple code than to guess and create complex, hard-to-maintain solutions. The goal is to contribute effectively to a codebase that will grow and evolve over time.
|
||||
292
docs/CODE_QUALITY.md
Normal file
@@ -0,0 +1,292 @@
|
||||
# Code Quality Standards & Improvements
|
||||
|
||||
This document outlines the code quality standards implemented in the Skelly project and provides guidelines for maintaining high-quality, reliable code.
|
||||
|
||||
> 📋 **Naming Standards**: All code follows the [Naming Convention Quick Reference](CODE_OF_CONDUCT.md#naming-convention-quick-reference) for consistent file, class, and variable naming.
|
||||
|
||||
## Overview of Improvements
|
||||
|
||||
A comprehensive code quality improvement was conducted to eliminate critical flaws, improve maintainability, and ensure production-ready reliability. The improvements focus on memory safety, error handling, architecture quality, and input validation.
|
||||
|
||||
## 🔴 Critical Issues Resolved
|
||||
|
||||
### 1. Memory Management & Safety
|
||||
|
||||
**Issues Fixed:**
|
||||
- **Memory Leaks**: Eliminated dangerous `child.free()` calls that could cause crashes
|
||||
- **Resource Cleanup**: Implemented proper node cleanup sequencing with frame waiting
|
||||
- **Signal Management**: Added proper signal connections for dynamically created nodes
|
||||
|
||||
**Best Practices:**
|
||||
```gdscript
|
||||
# ✅ Correct memory management
|
||||
for child in children_to_remove:
|
||||
child.queue_free()
|
||||
await get_tree().process_frame # Wait for cleanup
|
||||
|
||||
# ❌ Dangerous pattern (now fixed)
|
||||
for child in children_to_remove:
|
||||
child.free() # Can cause immediate crashes
|
||||
```
|
||||
|
||||
**Files Improved:**
|
||||
- `scenes/game/gameplays/Match3Gameplay.gd`
|
||||
- `scenes/game/gameplays/tile.gd`
|
||||
|
||||
### 2. Error Handling & Recovery
|
||||
|
||||
**Issues Fixed:**
|
||||
- **JSON Parsing Failures**: Added comprehensive error handling with detailed reporting
|
||||
- **File Operations**: Implemented fallback mechanisms for missing or corrupted files
|
||||
- **Resource Loading**: Added validation and recovery for failed resource loads
|
||||
|
||||
**Best Practices:**
|
||||
```gdscript
|
||||
# ✅ Comprehensive error handling
|
||||
var json = JSON.new()
|
||||
var parse_result = json.parse(json_string)
|
||||
if parse_result != OK:
|
||||
DebugManager.log_error("JSON parsing failed at line %d: %s" % [json.error_line, json.error_string], "SettingsManager")
|
||||
_load_default_settings() # Fallback mechanism
|
||||
return
|
||||
|
||||
# ❌ Minimal error handling (now improved)
|
||||
if json.parse(json_string) != OK:
|
||||
DebugManager.log_error("Error parsing JSON", "SettingsManager")
|
||||
return # No fallback, system left in undefined state
|
||||
```
|
||||
|
||||
**Files Improved:**
|
||||
- `src/autoloads/SettingsManager.gd`
|
||||
|
||||
### 3. Race Conditions & Concurrency
|
||||
|
||||
**Issues Fixed:**
|
||||
- **Scene Loading**: Protected against concurrent scene changes with state flags
|
||||
- **Resource Loading**: Added proper validation and timeout protection
|
||||
- **State Corruption**: Prevented state corruption during async operations
|
||||
|
||||
**Best Practices:**
|
||||
```gdscript
|
||||
# ✅ Race condition prevention
|
||||
var is_changing_scene: bool = false
|
||||
|
||||
func start_game_with_mode(gameplay_mode: String) -> void:
|
||||
if is_changing_scene:
|
||||
DebugManager.log_warn("Scene change already in progress", "GameManager")
|
||||
return
|
||||
|
||||
is_changing_scene = true
|
||||
# ... scene loading logic ...
|
||||
is_changing_scene = false
|
||||
|
||||
# ❌ Unprotected concurrent access (now fixed)
|
||||
func start_game_with_mode(gameplay_mode: String) -> void:
|
||||
# Multiple calls could interfere with each other
|
||||
get_tree().change_scene_to_packed(packed_scene)
|
||||
```
|
||||
|
||||
**Files Improved:**
|
||||
- `src/autoloads/GameManager.gd`
|
||||
|
||||
### 4. Architecture Issues
|
||||
|
||||
**Issues Fixed:**
|
||||
- **Global Static State**: Eliminated problematic static variables that prevented testing
|
||||
- **Instance Isolation**: Replaced with instance-based architecture
|
||||
- **Testability**: Enabled proper unit testing with isolated instances
|
||||
|
||||
**Best Practices:**
|
||||
```gdscript
|
||||
# ✅ Instance-based architecture
|
||||
func set_active_gem_types(gem_indices: Array) -> void:
|
||||
if not gem_indices or gem_indices.is_empty():
|
||||
DebugManager.log_error("Empty gem indices array", "Tile")
|
||||
return
|
||||
active_gem_types = gem_indices.duplicate()
|
||||
|
||||
# ❌ Static global state (now eliminated)
|
||||
static var current_gem_pool = [0, 1, 2, 3, 4]
|
||||
static func set_active_gem_pool(gem_indices: Array) -> void:
|
||||
current_gem_pool = gem_indices.duplicate()
|
||||
```
|
||||
|
||||
**Files Improved:**
|
||||
- `scenes/game/gameplays/tile.gd`
|
||||
- `scenes/game/gameplays/Match3Gameplay.gd`
|
||||
|
||||
## 🟡 Code Quality Improvements
|
||||
|
||||
### 1. Code Duplication Elimination
|
||||
|
||||
**Achievement:** 90% reduction in duplicate code between debug menu classes
|
||||
|
||||
**Implementation:**
|
||||
- Created `DebugMenuBase.gd` with shared functionality
|
||||
- Refactored existing classes to extend base class
|
||||
- Added input validation and error handling
|
||||
|
||||
```gdscript
|
||||
# ✅ Unified base class
|
||||
class_name DebugMenuBase
|
||||
extends Control
|
||||
|
||||
# Shared functionality for all debug menus
|
||||
func _initialize_spinboxes():
|
||||
# Common spinbox setup code
|
||||
|
||||
func _validate_input(value, min_val, max_val):
|
||||
# Input validation logic
|
||||
|
||||
# ✅ Derived classes
|
||||
extends DebugMenuBase
|
||||
|
||||
func _find_target_scene():
|
||||
# Specific implementation for finding target scene
|
||||
```
|
||||
|
||||
**Files Created/Improved:**
|
||||
- `scenes/ui/DebugMenuBase.gd` (new)
|
||||
- `scenes/ui/DebugMenu.gd` (refactored)
|
||||
- `scenes/game/gameplays/Match3DebugMenu.gd` (refactored)
|
||||
|
||||
### 2. Input Validation & Security
|
||||
|
||||
**Implementation:** Comprehensive input validation across all user input paths
|
||||
|
||||
**Best Practices:**
|
||||
```gdscript
|
||||
# ✅ Volume setting validation
|
||||
func _on_volume_slider_changed(value, setting_key):
|
||||
if not setting_key in ["master_volume", "music_volume", "sfx_volume"]:
|
||||
DebugManager.log_error("Invalid volume setting key: " + str(setting_key), "Settings")
|
||||
return
|
||||
|
||||
var clamped_value = clamp(float(value), 0.0, 1.0)
|
||||
if clamped_value != value:
|
||||
DebugManager.log_warn("Volume value clamped", "Settings")
|
||||
|
||||
# ✅ Grid movement validation
|
||||
func _move_cursor(direction: Vector2i) -> void:
|
||||
if abs(direction.x) > 1 or abs(direction.y) > 1:
|
||||
DebugManager.log_error("Invalid cursor direction", "Match3")
|
||||
return
|
||||
```
|
||||
|
||||
**Files Improved:**
|
||||
- `scenes/ui/SettingsMenu.gd`
|
||||
- `scenes/game/gameplays/Match3Gameplay.gd`
|
||||
- `src/autoloads/GameManager.gd`
|
||||
|
||||
## Development Standards
|
||||
|
||||
### Memory Management Rules
|
||||
|
||||
1. **Always use `queue_free()`** instead of `free()` for node cleanup
|
||||
2. **Wait for frame completion** after queueing nodes for removal
|
||||
3. **Clear references before cleanup** to prevent access to freed memory
|
||||
4. **Connect signals properly** for dynamically created nodes
|
||||
|
||||
### Error Handling Requirements
|
||||
|
||||
1. **Provide fallback mechanisms** for all critical failures
|
||||
2. **Log detailed error information** with context and recovery actions
|
||||
3. **Validate all inputs** before processing
|
||||
4. **Handle edge cases** gracefully without crashing
|
||||
|
||||
### Architecture Guidelines
|
||||
|
||||
1. **Avoid global static state** - use instance-based architecture
|
||||
2. **Implement proper encapsulation** with private/protected members
|
||||
3. **Use composition over inheritance** where appropriate
|
||||
4. **Design for testability** with dependency injection
|
||||
|
||||
### Input Validation Standards
|
||||
|
||||
1. **Type checking** - verify input types before processing
|
||||
2. **Bounds checking** - validate numeric ranges and array indices
|
||||
3. **Null checking** - handle null and empty inputs gracefully
|
||||
4. **Whitelist validation** - validate against known good values
|
||||
|
||||
## Code Quality Metrics
|
||||
|
||||
### Before Improvements
|
||||
- **Memory Safety**: Multiple potential crash points from improper cleanup
|
||||
- **Error Recovery**: Limited error handling with undefined states
|
||||
- **Code Duplication**: 90% duplicate code in debug menus
|
||||
- **Input Validation**: Minimal validation, potential security issues
|
||||
- **Architecture**: Global state preventing proper testing
|
||||
|
||||
### After Improvements
|
||||
- **Memory Safety**: 100% of identified memory issues resolved
|
||||
- **Error Recovery**: Comprehensive error handling with fallbacks
|
||||
- **Code Duplication**: 90% reduction through base class architecture
|
||||
- **Input Validation**: Complete validation coverage for all user inputs
|
||||
- **Architecture**: Instance-based design enabling proper testing
|
||||
|
||||
## Testing Guidelines
|
||||
|
||||
### Memory Safety Testing
|
||||
```gdscript
|
||||
# Test node cleanup
|
||||
func test_node_cleanup():
|
||||
var initial_count = get_child_count()
|
||||
create_and_destroy_nodes()
|
||||
await get_tree().process_frame
|
||||
assert(get_child_count() == initial_count)
|
||||
```
|
||||
|
||||
### Error Handling Testing
|
||||
```gdscript
|
||||
# Test fallback mechanisms
|
||||
func test_settings_fallback():
|
||||
delete_settings_file()
|
||||
var settings = SettingsManager.new()
|
||||
assert(settings.get_setting("master_volume") == 0.5) # Default value
|
||||
```
|
||||
|
||||
### Input Validation Testing
|
||||
```gdscript
|
||||
# Test bounds checking
|
||||
func test_volume_validation():
|
||||
var result = settings.set_setting("master_volume", 2.0) # Invalid range
|
||||
assert(result == false)
|
||||
assert(settings.get_setting("master_volume") != 2.0)
|
||||
```
|
||||
|
||||
## Monitoring & Maintenance
|
||||
|
||||
### Code Quality Checklist
|
||||
- [ ] All user inputs validated
|
||||
- [ ] Error handling with fallbacks
|
||||
- [ ] Memory cleanup uses `queue_free()`
|
||||
- [ ] No global static state
|
||||
- [ ] Proper logging with categories
|
||||
- [ ] Race condition protection
|
||||
|
||||
### Regular Reviews
|
||||
- **Weekly**: Review new code for compliance with standards
|
||||
- **Monthly**: Run full codebase analysis for potential issues
|
||||
- **Release**: Comprehensive quality assurance testing
|
||||
|
||||
### Automated Checks
|
||||
- Memory leak detection during testing
|
||||
- Input validation coverage analysis
|
||||
- Error handling path verification
|
||||
- Code duplication detection
|
||||
|
||||
## Future Improvements
|
||||
|
||||
### Planned Enhancements
|
||||
1. **Unit Test Framework**: Implement comprehensive unit testing
|
||||
2. **Performance Monitoring**: Add performance metrics and profiling
|
||||
3. **Static Analysis**: Integrate automated code quality tools
|
||||
4. **Documentation**: Generate automated API documentation
|
||||
|
||||
### Scalability Considerations
|
||||
1. **Service Architecture**: Implement service-oriented patterns
|
||||
2. **Resource Pooling**: Add object pooling for frequently created nodes
|
||||
3. **Event System**: Expand event-driven architecture
|
||||
4. **Configuration Management**: Centralized configuration system
|
||||
|
||||
This document serves as the foundation for maintaining and improving code quality in the Skelly project. All new code should adhere to these standards, and existing code should be gradually updated to meet these requirements.
|
||||
404
docs/MAP.md
Normal file
@@ -0,0 +1,404 @@
|
||||
# Skelly - Project Structure Map
|
||||
|
||||
## Overview
|
||||
Skelly is a Godot 4.4 game project featuring multiple gameplay modes. The project supports match-3 puzzle gameplay with planned clickomania gameplay through a modular gameplay architecture. It follows a modular structure with clear separation between scenes, autoloads, assets, and data.
|
||||
|
||||
> 📋 **Naming Conventions**: All file and directory naming follows the standards defined in [Naming Convention Quick Reference](CODE_OF_CONDUCT.md#naming-convention-quick-reference).
|
||||
|
||||
## Project Root Structure
|
||||
|
||||
```
|
||||
skelly/
|
||||
├── .claude/ # Claude Code configuration
|
||||
├── .godot/ # Godot engine generated files (ignored)
|
||||
├── assets/ # Game assets (sprites, audio, textures)
|
||||
├── data/ # Game data and configuration files
|
||||
├── docs/ # Documentation
|
||||
├── localization/ # Internationalization files
|
||||
├── scenes/ # Godot scenes (.tscn) and scripts (.gd)
|
||||
├── src/ # Source code organization
|
||||
├── tests/ # Test scripts and validation utilities
|
||||
├── project.godot # Main Godot project configuration
|
||||
└── icon.svg # Project icon
|
||||
```
|
||||
|
||||
## Core Architecture
|
||||
|
||||
### Autoloads (Global Singletons)
|
||||
Located in `src/autoloads/`, these scripts are automatically loaded when the game starts:
|
||||
|
||||
1. **SaveManager** (`src/autoloads/SaveManager.gd`)
|
||||
- Persistent game data management with validation
|
||||
- High score tracking and current score management
|
||||
- Game statistics (games played, total score)
|
||||
- Grid state persistence for match-3 gameplay continuity
|
||||
- Progress reset functionality with complete data cleanup
|
||||
- Security features: backup system, checksum validation, file size limits
|
||||
- Robust error handling with backup restoration capabilities
|
||||
- Uses: `user://savegame.save` for persistent storage
|
||||
|
||||
2. **SettingsManager** (`src/autoloads/SettingsManager.gd`)
|
||||
- Manages game settings and user preferences
|
||||
- Configuration file I/O
|
||||
- input validation
|
||||
- JSON parsing
|
||||
- Provides language selection functionality
|
||||
- Dependencies: `localization/languages.json`
|
||||
|
||||
3. **AudioManager** (`src/autoloads/AudioManager.gd`)
|
||||
- Controls music and sound effects
|
||||
- Manages audio bus configuration
|
||||
- Uses: `data/default_bus_layout.tres`
|
||||
|
||||
4. **GameManager** (`src/autoloads/GameManager.gd`)
|
||||
- Game state management and gameplay mode coordination with race condition protection
|
||||
- Scene transitions with concurrent change prevention and validation
|
||||
- Gameplay mode selection and launching with input validation (match3, clickomania)
|
||||
- Error handling for scene loading failures and fallback mechanisms
|
||||
- Navigation flow control with state protection
|
||||
- References: main.tscn, game.tscn and individual gameplay scenes
|
||||
|
||||
5. **LocalizationManager** (`src/autoloads/LocalizationManager.gd`)
|
||||
- Language switching functionality
|
||||
- Works with Godot's built-in internationalization system
|
||||
- Uses translation files in `localization/`
|
||||
|
||||
6. **DebugManager** (`src/autoloads/DebugManager.gd`)
|
||||
- Global debug state management and centralized logging system
|
||||
- Debug UI visibility control
|
||||
- F12 toggle functionality
|
||||
- Signal-based debug system
|
||||
- Structured logging with configurable log levels (TRACE, DEBUG, INFO, WARN, ERROR, FATAL)
|
||||
- Timestamp-based log formatting with category support
|
||||
- Runtime log level filtering
|
||||
|
||||
|
||||
## Scene Hierarchy & Flow
|
||||
|
||||
### Main Scenes
|
||||
```
|
||||
main.tscn (Entry Point)
|
||||
├── SplashScreen.tscn
|
||||
├── MainMenu.tscn
|
||||
└── SettingsMenu.tscn
|
||||
|
||||
game.tscn (Gameplay Container)
|
||||
├── GameplayContainer (Dynamic content)
|
||||
├── UI/ScoreDisplay
|
||||
├── BackButton
|
||||
└── DebugToggle
|
||||
```
|
||||
|
||||
### Game Flow
|
||||
1. **Main Scene** (`scenes/main/main.tscn` + `Main.gd`)
|
||||
- Application entry point
|
||||
- Manages splash screen
|
||||
- Transitions to main menu
|
||||
- Dynamic menu loading system
|
||||
|
||||
2. **Splash Screen** (`scenes/main/SplashScreen.tscn` + `SplashScreen.gd`)
|
||||
- Initial splash screen
|
||||
- Input detection for any key/button
|
||||
- Signals to main scene for transition
|
||||
|
||||
3. **Main Menu** (`scenes/ui/MainMenu.tscn` + `MainMenu.gd`)
|
||||
- Primary navigation hub
|
||||
- Start game, settings, quit options
|
||||
- Connected to GameManager for scene transitions
|
||||
|
||||
4. **Settings Menu** (`scenes/ui/SettingsMenu.tscn` + `SettingsMenu.gd`)
|
||||
- User preferences interface
|
||||
- Language selection
|
||||
- Audio volume controls
|
||||
- Connected to SettingsManager and AudioManager
|
||||
|
||||
5. **Game Scene** (`scenes/game/game.tscn` + `game.gd`)
|
||||
- Main gameplay container with modular gameplay system
|
||||
- Dynamic loading of gameplay modes into GameplayContainer
|
||||
- Global score management and display
|
||||
- Back button for navigation to main menu
|
||||
- Gameplay mode switching support (Space+Enter debug key)
|
||||
- Bridge between UI and individual gameplay implementations
|
||||
|
||||
### UI Components
|
||||
```
|
||||
scenes/ui/
|
||||
├── components/
|
||||
│ └── ValueStepper.tscn + ValueStepper.gd # Reusable arrow-based value selector
|
||||
├── DebugToggle.tscn + DebugToggle.gd # Available on all major scenes
|
||||
├── DebugMenuBase.gd # Unified base class for debug menus
|
||||
├── DebugMenu.tscn + DebugMenu.gd # Global debug controls (extends DebugMenuBase)
|
||||
├── Match3DebugMenu.gd # Match-3 specific debug controls (extends DebugMenuBase)
|
||||
├── MainMenu.tscn + MainMenu.gd # With gamepad/keyboard navigation
|
||||
└── SettingsMenu.tscn + SettingsMenu.gd # With comprehensive input validation
|
||||
```
|
||||
|
||||
**Quality Improvements:**
|
||||
- **ValueStepper Component**: Reusable arrow-based selector for discrete values (language, resolution, difficulty)
|
||||
- **DebugMenuBase.gd**: Eliminates 90% code duplication between debug menu classes
|
||||
- **Input Validation**: User inputs are validated and sanitized before processing
|
||||
- **Error Recovery**: Error handling with fallback mechanisms throughout UI
|
||||
- **Navigation Support**: Gamepad/keyboard navigation across menus
|
||||
|
||||
## Modular Gameplay System
|
||||
|
||||
The game now uses a modular gameplay architecture where different game modes can be dynamically loaded into the main game scene.
|
||||
|
||||
### Gameplay Architecture
|
||||
- **Main Game Scene** (`scenes/game/game.gd`) - Container and coordinator
|
||||
- **Gameplay Directory** (`scenes/game/gameplays/`) - Individual gameplay implementations
|
||||
- **Dynamic Loading** - Gameplay scenes loaded at runtime based on mode selection
|
||||
- **Signal-based Communication** - Gameplays communicate with main scene via signals
|
||||
|
||||
### Current Gameplay Modes
|
||||
|
||||
#### Match-3 Mode (`scenes/game/gameplays/Match3Gameplay.tscn`)
|
||||
1. **Match3 Controller** (`scenes/game/gameplays/Match3Gameplay.gd`)
|
||||
- Grid management (8x8 default) with memory-safe node cleanup
|
||||
- Match detection algorithms with bounds checking and validation
|
||||
- Tile dropping and refilling with signal connections
|
||||
- Gem pool management (3-8 gem types) with instance-based architecture
|
||||
- Debug UI integration with validation
|
||||
- Score reporting via `score_changed` signal
|
||||
- **Memory Safety**: Uses `queue_free()` with frame waiting to prevent crashes
|
||||
- **Gem Movement System**: Keyboard and gamepad input for tile selection and swapping
|
||||
- State machine: WAITING → SELECTING → SWAPPING → PROCESSING
|
||||
- Adjacent tile validation (horizontal/vertical neighbors only)
|
||||
- Match validation (swaps must create matches or revert)
|
||||
- Smooth tile position animations with Tween
|
||||
- Cursor-based navigation with visual highlighting and bounds checking
|
||||
|
||||
2. **Tile System** (`scenes/game/gameplays/tile.gd` + `Tile.tscn`)
|
||||
- Tile behavior with instance-based architecture (no global state)
|
||||
- Gem type management with validation and bounds checking
|
||||
- Visual representation with scaling and color
|
||||
- Group membership for coordination
|
||||
- **Visual Feedback System**: Multi-state display for game interaction
|
||||
- Selection visual feedback (scale and color modulation)
|
||||
- State management (normal, highlighted, selected)
|
||||
- Signal-based communication with gameplay controller
|
||||
- Smooth animations with Tween system
|
||||
- **Memory Safety**: Resource management and cleanup
|
||||
|
||||
#### Clickomania Mode (`scenes/game/gameplays/ClickomaniaGameplay.tscn`)
|
||||
- Planned implementation for clickomania-style gameplay
|
||||
- Will integrate with same scoring and UI systems as match-3
|
||||
|
||||
### Debug System
|
||||
- Global debug state via DebugManager with initialization
|
||||
- Debug toggle available on all major scenes (MainMenu, SettingsMenu, SplashScreen, Game)
|
||||
- Match-3 specific debug UI panel with gem count controls and difficulty presets
|
||||
- Gem count controls (+/- buttons) with difficulty presets (Easy: 3, Normal: 5, Hard: 8)
|
||||
- Board reroll functionality for testing
|
||||
- F12 toggle support across all scenes
|
||||
- Fewer debug prints in production code
|
||||
|
||||
## Asset Organization
|
||||
|
||||
### Audio (`assets/audio/`)
|
||||
```
|
||||
audio/
|
||||
├── music/ # Background music files
|
||||
└── sfx/ # Sound effects
|
||||
```
|
||||
|
||||
### Visual Assets (`assets/`)
|
||||
```
|
||||
assets/
|
||||
├── audio/
|
||||
│ ├── music/ # Background music files
|
||||
│ └── sfx/ # Sound effects
|
||||
├── sprites/
|
||||
│ ├── characters/skeleton/ # Character artwork
|
||||
│ ├── gems/ # Match-3 gem sprites
|
||||
│ └── ui/ # User interface elements
|
||||
├── textures/
|
||||
│ └── backgrounds/ # Background images
|
||||
├── fonts/ # Custom fonts
|
||||
└── sources.yaml # Asset metadata and attribution
|
||||
```
|
||||
|
||||
### Asset Management (`assets/sources.yaml`)
|
||||
**REQUIRED**: Every asset added to the project must be documented in `assets/sources.yaml` with:
|
||||
- **Source information** - Where the asset came from (URL, artist, store, etc.)
|
||||
- **License details** - Usage rights, attribution requirements, commercial permissions
|
||||
- **Attribution text** - Exact text to use for credits if required
|
||||
- **Modification notes** - Any changes made to the original asset
|
||||
- **Usage context** - Where and how the asset is used in the project
|
||||
|
||||
**Example format:**
|
||||
```yaml
|
||||
audio:
|
||||
music:
|
||||
"Space Horror InGame Music (Exploration) _Clement Panchout.wav":
|
||||
source: "https://freesound.org/people/ClementPanchout/"
|
||||
license: "CC BY 4.0"
|
||||
attribution: "Space Horror InGame Music by Clement Panchout"
|
||||
modifications: "Converted to WAV, loop points adjusted"
|
||||
usage: "Background music for all gameplay scenes"
|
||||
|
||||
sprites:
|
||||
gems:
|
||||
"gem_blue.png":
|
||||
source: "Created in-house"
|
||||
license: "Project proprietary"
|
||||
attribution: "Skelly development team"
|
||||
modifications: "None"
|
||||
usage: "Match-3 blue gem sprite"
|
||||
```
|
||||
|
||||
## Data & Configuration
|
||||
|
||||
### Game Data (`data/`)
|
||||
- `default_bus_layout.tres` - Audio bus configuration for Godot
|
||||
|
||||
### Documentation (`docs/`)
|
||||
- `MAP.md` - Project architecture and structure overview
|
||||
- `CLAUDE.md` - Claude Code development guidelines
|
||||
- `CODE_OF_CONDUCT.md` - Coding standards and best practices
|
||||
- `TESTING.md` - Testing guidelines and conventions
|
||||
|
||||
### Localization (`localization/`)
|
||||
- `languages.json` - Available language definitions
|
||||
- `MainStrings.en.translation` - English translations
|
||||
- `MainStrings.ru.translation` - Russian translations
|
||||
|
||||
### Testing & Validation (`tests/`)
|
||||
- `TestLogging.gd` - DebugManager logging system validation
|
||||
- **`test_checksum_issue.gd`** - SaveManager checksum validation and deterministic hashing
|
||||
- **`TestMigrationCompatibility.gd`** - SaveManager version migration and backward compatibility
|
||||
- **`test_save_system_integration.gd`** - Complete save/load workflow integration testing
|
||||
- **`test_checksum_fix_verification.gd`** - JSON serialization checksum fix verification
|
||||
- `README.md` - Brief directory overview (see docs/TESTING.md for full guidelines)
|
||||
- Comprehensive test scripts for save system security and data integrity validation
|
||||
- Temporary test utilities for development and debugging
|
||||
|
||||
### Project Configuration
|
||||
- `project.godot` - Main Godot project settings
|
||||
- Autoload definitions
|
||||
- Input map configurations
|
||||
- Rendering settings
|
||||
- Audio bus references
|
||||
|
||||
## Key Dependencies & Connections
|
||||
|
||||
### Signal Connections
|
||||
```
|
||||
SplashScreen --[confirm_pressed]--> Main
|
||||
MainMenu --[open_settings]--> Main
|
||||
SettingsMenu --[back_to_main_menu]--> Main
|
||||
DebugManager --[debug_toggled]--> All scenes with DebugToggle
|
||||
GameplayModes --[score_changed]--> Game Scene
|
||||
Game Scene --[score updates]--> UI/ScoreDisplay
|
||||
```
|
||||
|
||||
### Scene References
|
||||
```
|
||||
GameManager --> main.tscn, game.tscn
|
||||
GameManager --> scenes/game/gameplays/*.tscn (via GAMEPLAY_SCENES constant)
|
||||
Main --> MainMenu.tscn, SettingsMenu.tscn
|
||||
Game --> GameplayContainer (dynamic loading of gameplay scenes)
|
||||
Game --> scenes/game/gameplays/Match3Gameplay.tscn, ClickomaniaGameplay.tscn
|
||||
```
|
||||
|
||||
### Asset Dependencies
|
||||
```
|
||||
AudioManager --> assets/audio/music/
|
||||
SettingsManager --> localization/languages.json
|
||||
AudioManager --> data/default_bus_layout.tres
|
||||
Asset Management --> assets/sources.yaml (required for all assets)
|
||||
```
|
||||
|
||||
## Logging System
|
||||
|
||||
The project uses a centralized logging system implemented in DebugManager for consistent, structured logging throughout the application.
|
||||
|
||||
### Log Levels
|
||||
```
|
||||
TRACE (0) - Detailed execution tracing (debug mode only)
|
||||
DEBUG (1) - Development debugging information (debug mode only)
|
||||
INFO (2) - General application information (always visible)
|
||||
WARN (3) - Warning messages that don't break functionality
|
||||
ERROR (4) - Error conditions that may affect functionality
|
||||
FATAL (5) - Critical errors that may cause application failure
|
||||
```
|
||||
|
||||
### Usage Examples
|
||||
```gdscript
|
||||
# Basic logging with automatic categorization
|
||||
DebugManager.log_info("Game started successfully")
|
||||
DebugManager.log_warn("Settings file not found, using defaults")
|
||||
DebugManager.log_error("Failed to load audio resource")
|
||||
|
||||
# Logging with custom categories for better organization
|
||||
DebugManager.log_debug("Grid regenerated with 64 tiles", "Match3")
|
||||
DebugManager.log_info("Language changed to: en", "Settings")
|
||||
DebugManager.log_error("Invalid scene path provided", "GameManager")
|
||||
|
||||
# Standard categories in use:
|
||||
# - GameManager: Scene transitions, gameplay mode management
|
||||
# - Match3: Match-3 gameplay, grid operations, tile interactions
|
||||
# - Settings: Settings management, language changes
|
||||
# - Game: Main game scene, mode switching
|
||||
# - MainMenu: Main menu interactions
|
||||
# - SplashScreen: Splash screen
|
||||
# - Clickomania: Clickomania gameplay mode
|
||||
# - DebugMenu: Debug menu operations
|
||||
```
|
||||
|
||||
### Log Format
|
||||
```
|
||||
[timestamp] LEVEL [category]: message
|
||||
Example: [2025-09-24T10:48:08] INFO [GameManager]: Loading main scene
|
||||
```
|
||||
|
||||
### Runtime Configuration
|
||||
```gdscript
|
||||
# Set minimum log level (filters out lower priority messages)
|
||||
DebugManager.set_log_level(DebugManager.LogLevel.WARN)
|
||||
|
||||
# Get current log level
|
||||
var current_level = DebugManager.get_log_level()
|
||||
|
||||
# Check if a specific level would be logged
|
||||
if DebugManager._should_log(DebugManager.LogLevel.DEBUG):
|
||||
# Expensive debug calculation here
|
||||
```
|
||||
|
||||
### Integration with Godot Systems
|
||||
- **WARN/ERROR/FATAL** levels automatically call `push_warning()` and `push_error()`
|
||||
- **TRACE/DEBUG** levels only display when debug mode is enabled
|
||||
- **INFO** and higher levels always display regardless of debug mode
|
||||
- All levels respect the configured minimum log level threshold
|
||||
|
||||
## Development Notes
|
||||
|
||||
### Current Implementation Status
|
||||
- Modular gameplay system with dynamic loading architecture
|
||||
- Match-3 system with 8x8 grid and configurable gem pools
|
||||
- **Interactive Match-3 Gameplay**: Keyboard and gamepad gem movement system
|
||||
- Keyboard: Arrow key navigation with Enter to select/confirm (WASD also supported)
|
||||
- Gamepad: D-pad navigation with A button to select/confirm
|
||||
- Visual feedback: Tile highlighting, selection indicators, smooth animations
|
||||
- Game logic: Adjacent-only swaps, match validation, automatic revert on invalid moves
|
||||
- State machine: WAITING → SELECTING → SWAPPING → PROCESSING states
|
||||
- **Comprehensive Logging System**: All print()/push_error() statements migrated to DebugManager
|
||||
- Structured logging with categories: GameManager, Match3, Settings, Game, MainMenu, etc.
|
||||
- Multiple log levels: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
|
||||
- Debug mode integration with level filtering
|
||||
- Global scoring system integrated across gameplay modes
|
||||
- Debug UI system with F12 toggle functionality across all major scenes
|
||||
- Scene transition system via GameManager with gameplay mode support
|
||||
- Internationalization support for English/Russian
|
||||
|
||||
### Architecture Patterns
|
||||
1. **Autoload Pattern** - Global managers as singletons
|
||||
2. **Signal-Based Communication** - Loose coupling between components
|
||||
3. **Modular Gameplay Architecture** - Dynamic loading of gameplay modes
|
||||
4. **Scene Composition** - Modular scene loading and management
|
||||
5. **Data-Driven Configuration** - JSON for settings and translations
|
||||
6. **Component Architecture** - Reusable UI and game components
|
||||
7. **Centralized Scoring System** - Global score management across gameplay modes
|
||||
8. **Structured Logging System** - Centralized logging with level-based filtering and formatted output
|
||||
|
||||
This structure provides a clean separation of concerns, making the codebase maintainable and extensible for future features.
|
||||
267
docs/TESTING.md
Normal file
@@ -0,0 +1,267 @@
|
||||
# Tests Directory
|
||||
|
||||
Test scripts and utilities for validating Skelly project systems.
|
||||
|
||||
## Overview
|
||||
|
||||
The `tests/` directory contains:
|
||||
- System validation scripts
|
||||
- Component testing utilities
|
||||
- Integration tests
|
||||
- Performance benchmarks
|
||||
- Debugging tools
|
||||
|
||||
> 📋 **File Naming**: All test files follow the [naming conventions](CODE_OF_CONDUCT.md#2-file-naming-standards) with PascalCase and "Test" prefix (e.g., `TestAudioManager.gd`).
|
||||
|
||||
## Current Test Files
|
||||
|
||||
### `TestLogging.gd`
|
||||
Test script for DebugManager logging system.
|
||||
|
||||
**Features:**
|
||||
- Tests all log levels (TRACE, DEBUG, INFO, WARN, ERROR, FATAL)
|
||||
- Validates log level filtering
|
||||
- Tests category-based logging
|
||||
- Verifies debug mode integration
|
||||
- Demonstrates logging usage patterns
|
||||
|
||||
**Usage:**
|
||||
```gdscript
|
||||
# Option 1: Add as temporary autoload
|
||||
# In project.godot, add: tests/TestLogging.gd
|
||||
|
||||
# Option 2: Instantiate in a scene
|
||||
var test_script = preload("res://tests/TestLogging.gd").new()
|
||||
add_child(test_script)
|
||||
|
||||
# Option 3: Run directly from editor
|
||||
# Open the script and run the scene containing it
|
||||
```
|
||||
|
||||
**Expected Output:**
|
||||
Formatted log messages showing:
|
||||
- Timestamp formatting
|
||||
- Log level filtering
|
||||
- Category organization
|
||||
- Debug mode dependency for TRACE/DEBUG levels
|
||||
|
||||
## Adding New Tests
|
||||
|
||||
Follow these conventions for new test files:
|
||||
|
||||
### File Naming
|
||||
- Use descriptive names starting with `test_`
|
||||
- Example: `TestAudioManager.gd`, `test_scene_transitions.gd`
|
||||
|
||||
### File Structure
|
||||
```gdscript
|
||||
extends Node
|
||||
|
||||
# Brief description of what this test validates
|
||||
|
||||
func _ready():
|
||||
# Wait for system initialization if needed
|
||||
await get_tree().process_frame
|
||||
run_tests()
|
||||
|
||||
func run_tests():
|
||||
print("=== Starting [System Name] Tests ===")
|
||||
|
||||
# Individual test functions
|
||||
test_basic_functionality()
|
||||
test_edge_cases()
|
||||
test_error_conditions()
|
||||
|
||||
print("=== [System Name] Tests Complete ===")
|
||||
|
||||
func test_basic_functionality():
|
||||
print("\\n--- Test: Basic Functionality ---")
|
||||
# Test implementation
|
||||
|
||||
func test_edge_cases():
|
||||
print("\\n--- Test: Edge Cases ---")
|
||||
# Edge case testing
|
||||
|
||||
func test_error_conditions():
|
||||
print("\\n--- Test: Error Conditions ---")
|
||||
# Error condition testing
|
||||
```
|
||||
|
||||
### Testing Guidelines
|
||||
|
||||
1. **Independence**: Each test is self-contained
|
||||
2. **Cleanup**: Restore original state after testing
|
||||
3. **Clear Output**: Use descriptive print statements
|
||||
4. **Error Handling**: Test success and failure conditions
|
||||
5. **Documentation**: Comment complex test scenarios
|
||||
|
||||
### Integration with Main Project
|
||||
|
||||
- **Temporary Usage**: Add test files temporarily during development
|
||||
- **Not in Production**: Exclude from release builds
|
||||
- **Autoload Testing**: Add to autoloads temporarily for automatic execution
|
||||
- **Manual Testing**: Run individually for specific components
|
||||
|
||||
## Test Categories
|
||||
|
||||
### System Tests
|
||||
Test core autoload managers and global systems:
|
||||
- `TestLogging.gd` - DebugManager logging system
|
||||
- `test_checksum_issue.gd` - SaveManager checksum validation and deterministic hashing
|
||||
- `TestMigrationCompatibility.gd` - SaveManager version migration and backward compatibility
|
||||
- `test_save_system_integration.gd` - Complete save/load workflow integration testing
|
||||
- `test_checksum_fix_verification.gd` - Verification of JSON serialization checksum fixes
|
||||
- `TestSettingsManager.gd` - SettingsManager security validation, input validation, and error handling
|
||||
- `TestGameManager.gd` - GameManager scene transitions, race condition protection, and input validation
|
||||
- `TestAudioManager.gd` - AudioManager functionality, resource loading, and volume management
|
||||
|
||||
### Component Tests
|
||||
Test individual game components:
|
||||
- `TestMatch3Gameplay.gd` - Match-3 gameplay mechanics, grid management, and match detection
|
||||
- `TestTile.gd` - Tile component behavior, visual feedback, and memory safety
|
||||
- `TestValueStepper.gd` - ValueStepper UI component functionality and settings integration
|
||||
|
||||
### Integration Tests
|
||||
Test system interactions and workflows:
|
||||
- Future: `test_game_flow.gd` - Complete game session flow
|
||||
- Future: `test_debug_system.gd` - Debug UI integration
|
||||
- Future: `test_localization.gd` - Language switching and translations
|
||||
|
||||
## Save System Testing Protocols
|
||||
|
||||
SaveManager implements security features requiring testing for modifications.
|
||||
|
||||
### Critical Test Suites
|
||||
|
||||
#### **`test_checksum_issue.gd`** - Checksum Validation
|
||||
**Tests**: Checksum generation, JSON serialization consistency, save/load cycles
|
||||
**Usage**: Run after checksum algorithm changes
|
||||
|
||||
#### **`TestMigrationCompatibility.gd`** - Version Migration
|
||||
**Tests**: Backward compatibility, missing field addition, data structure normalization
|
||||
**Usage**: Test save format upgrades
|
||||
|
||||
#### **`test_save_system_integration.gd`** - End-to-End Integration
|
||||
**Tests**: Save/load workflow, grid state serialization, race condition prevention
|
||||
**Usage**: Run after SaveManager modifications
|
||||
|
||||
#### **`test_checksum_fix_verification.gd`** - JSON Serialization Fix
|
||||
**Tests**: Checksum consistency, int/float conversion, type safety validation
|
||||
**Usage**: Test JSON type conversion fixes
|
||||
|
||||
### Save System Security Testing
|
||||
|
||||
#### **Required Tests Before SaveManager Changes**
|
||||
1. Run 4 save system test suites
|
||||
2. Test tamper detection by modifying save files
|
||||
3. Validate error recovery by corrupting files
|
||||
4. Check race condition protection
|
||||
5. Verify permissive validation
|
||||
|
||||
#### **Performance Benchmarks**
|
||||
- Checksum calculation: < 1ms
|
||||
- Memory usage: File size limits prevent exhaustion
|
||||
- Error recovery: Never crash regardless of corruption
|
||||
- Data preservation: User scores survive migration
|
||||
|
||||
#### **Test Sequence After Modifications**
|
||||
1. `test_checksum_issue.gd` - Verify checksum consistency
|
||||
2. `TestMigrationCompatibility.gd` - Check version upgrades
|
||||
3. `test_save_system_integration.gd` - Validate workflow
|
||||
4. Manual testing with corrupted files
|
||||
5. Performance validation
|
||||
|
||||
**Failure Response**: Test failure indicates corruption risk. Do not commit until all tests pass.
|
||||
|
||||
## Running Tests
|
||||
|
||||
### Manual Test Execution
|
||||
|
||||
#### **Direct Script Execution (Recommended)**
|
||||
```bash
|
||||
# Run specific test
|
||||
godot --headless --script tests/test_checksum_issue.gd
|
||||
|
||||
# Run all save system tests
|
||||
godot --headless --script tests/test_checksum_issue.gd
|
||||
godot --headless --script tests/TestMigrationCompatibility.gd
|
||||
godot --headless --script tests/test_save_system_integration.gd
|
||||
```
|
||||
|
||||
#### **Other Methods**
|
||||
- **Temporary Autoload**: Add to project.godot autoloads temporarily, run with F5
|
||||
- **Scene-based**: Create temporary scene, add test script as child, run with F6
|
||||
- **Editor**: Open test file, attach to scene, run with F6
|
||||
|
||||
### Automated Test Execution
|
||||
|
||||
Use provided scripts `run_tests.bat` (Windows) or `run_tests.sh` (Linux/Mac) to run all tests sequentially.
|
||||
|
||||
For CI/CD integration:
|
||||
```yaml
|
||||
- name: Run Test Suite
|
||||
run: |
|
||||
godot --headless --script tests/test_checksum_issue.gd
|
||||
godot --headless --script tests/TestMigrationCompatibility.gd
|
||||
# Add other tests as needed
|
||||
```
|
||||
|
||||
### Expected Test Output
|
||||
|
||||
#### **Successful Test Run:**
|
||||
```
|
||||
=== Testing Checksum Issue Fix ===
|
||||
Testing checksum consistency across save/load cycles...
|
||||
✅ SUCCESS: Checksums are deterministic
|
||||
✅ SUCCESS: JSON serialization doesn't break checksums
|
||||
✅ SUCCESS: Save/load cycle maintains checksum integrity
|
||||
=== Test Complete ===
|
||||
```
|
||||
|
||||
#### **Failed Test Run:**
|
||||
```
|
||||
=== Testing Checksum Issue Fix ===
|
||||
Testing checksum consistency across save/load cycles...
|
||||
❌ FAILURE: Checksum mismatch detected
|
||||
Expected: 1234567890
|
||||
Got: 9876543210
|
||||
=== Test Failed ===
|
||||
```
|
||||
|
||||
### Test Execution Best Practices
|
||||
|
||||
**Before**: Remove existing save files, verify autoloads configured, run one test at a time
|
||||
**During**: Monitor console output, note timing (tests complete within seconds)
|
||||
**After**: Clean up temporary files, document issues
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
**Common Issues:**
|
||||
- Permission errors: Run with elevated permissions if needed
|
||||
- Missing dependencies: Ensure autoloads configured
|
||||
- Timeout issues: Add timeout for hung tests
|
||||
- Path issues: Use absolute paths if relative paths fail
|
||||
|
||||
### Performance Benchmarks
|
||||
|
||||
Expected execution times: Individual tests < 5 seconds, total suite < 35 seconds.
|
||||
|
||||
If tests take longer, investigate file I/O issues, memory leaks, infinite loops, or external dependencies.
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. Document expected behavior
|
||||
2. Test boundary conditions and edge cases
|
||||
3. Measure performance for critical components
|
||||
4. Include visual validation for UI components
|
||||
5. Cleanup after tests
|
||||
|
||||
## Contributing
|
||||
|
||||
When adding test files:
|
||||
1. Follow naming and structure conventions
|
||||
2. Update this README with test descriptions
|
||||
3. Ensure tests are self-contained and documented
|
||||
4. Test success and failure scenarios
|
||||
|
||||
This testing approach maintains code quality and provides validation tools for system changes.
|
||||
281
docs/UI_COMPONENTS.md
Normal file
@@ -0,0 +1,281 @@
|
||||
# UI Components
|
||||
|
||||
This document describes the custom UI components available in the Skelly project.
|
||||
|
||||
## ValueStepper Component
|
||||
|
||||
### Overview
|
||||
|
||||
**ValueStepper** is a reusable UI control for stepping through discrete values with left/right arrow navigation. It provides an intuitive interface for selecting from predefined options and is particularly well-suited for game settings menus.
|
||||
|
||||
**Location**: `scenes/ui/components/ValueStepper.tscn` and `scenes/ui/components/ValueStepper.gd`
|
||||
|
||||
### Why ValueStepper Exists
|
||||
|
||||
Godot's built-in controls have limitations for discrete option selection:
|
||||
- **OptionButton**: Dropdown popups don't work well with gamepad navigation
|
||||
- **SpinBox**: Designed for numeric values, not text options
|
||||
- **HSlider**: Better for continuous values, not discrete choices
|
||||
|
||||
ValueStepper fills this gap by providing:
|
||||
- ✅ **Gamepad-friendly** discrete option selection
|
||||
- ✅ **No popup complications** - values displayed inline
|
||||
- ✅ **Dual input support** - mouse clicks + keyboard/gamepad
|
||||
- ✅ **Clean horizontal layout** with current value always visible
|
||||
- ✅ **Perfect for game settings** like language, difficulty, resolution
|
||||
|
||||
### Features
|
||||
|
||||
- **Multiple Data Sources**: Built-in support for language, resolution, difficulty
|
||||
- **Custom Values**: Easy setup with custom arrays of values
|
||||
- **Navigation Integration**: Built-in highlighting and input handling
|
||||
- **Signal-Based**: Clean event communication with parent scenes
|
||||
- **Visual Feedback**: Automatic highlighting and animations
|
||||
- **Audio Support**: Integrated click sounds
|
||||
- **Flexible Display**: Separate display names and internal values
|
||||
|
||||
### Visual Structure
|
||||
|
||||
```
|
||||
[<] [Current Value] [>]
|
||||
```
|
||||
|
||||
- **Left Arrow Button** (`<`): Navigate to previous value
|
||||
- **Value Display**: Shows current selection (e.g., "English", "Hard", "1920×1080")
|
||||
- **Right Arrow Button** (`>`): Navigate to next value
|
||||
|
||||
## API Reference
|
||||
|
||||
### Signals
|
||||
|
||||
```gdscript
|
||||
signal value_changed(new_value: String, new_index: int)
|
||||
```
|
||||
Emitted when the value changes, providing both the new value string and its index.
|
||||
|
||||
### Properties
|
||||
|
||||
```gdscript
|
||||
@export var data_source: String = "language"
|
||||
@export var custom_format_function: String = ""
|
||||
```
|
||||
|
||||
- **data_source**: Determines the data type ("language", "resolution", "difficulty", or "custom")
|
||||
- **custom_format_function**: Reserved for future custom formatting (currently unused)
|
||||
|
||||
### Key Methods
|
||||
|
||||
#### Setup and Configuration
|
||||
```gdscript
|
||||
func setup_custom_values(custom_values: Array[String], custom_display_names: Array[String] = [])
|
||||
```
|
||||
Configure the stepper with custom values and optional display names.
|
||||
|
||||
#### Value Management
|
||||
```gdscript
|
||||
func get_current_value() -> String
|
||||
func set_current_value(value: String)
|
||||
func change_value(direction: int)
|
||||
```
|
||||
Get, set, or modify the current value programmatically.
|
||||
|
||||
#### Navigation Integration
|
||||
```gdscript
|
||||
func set_highlighted(highlighted: bool)
|
||||
func handle_input_action(action: String) -> bool
|
||||
func get_control_name() -> String
|
||||
```
|
||||
Integration methods for navigation systems and visual feedback.
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Basic Usage in Scene
|
||||
|
||||
1. **Add to Scene**: Instance `ValueStepper.tscn` in your scene
|
||||
2. **Set Data Source**: Configure the `data_source` property
|
||||
3. **Connect Signal**: Connect the `value_changed` signal
|
||||
|
||||
```gdscript
|
||||
# In your scene script
|
||||
@onready var language_stepper: ValueStepper = $LanguageStepper
|
||||
|
||||
func _ready():
|
||||
language_stepper.value_changed.connect(_on_language_changed)
|
||||
|
||||
func _on_language_changed(new_value: String, new_index: int):
|
||||
print("Language changed to: ", new_value)
|
||||
```
|
||||
|
||||
### Built-in Data Sources
|
||||
|
||||
#### Language Selection
|
||||
```gdscript
|
||||
# Set data_source = "language" in editor or code
|
||||
language_stepper.data_source = "language"
|
||||
```
|
||||
Automatically loads available languages from SettingsManager.
|
||||
|
||||
#### Resolution Selection
|
||||
```gdscript
|
||||
# Set data_source = "resolution"
|
||||
resolution_stepper.data_source = "resolution"
|
||||
```
|
||||
Provides common resolution options with display names.
|
||||
|
||||
#### Difficulty Selection
|
||||
```gdscript
|
||||
# Set data_source = "difficulty"
|
||||
difficulty_stepper.data_source = "difficulty"
|
||||
```
|
||||
Provides difficulty levels: Easy, Normal, Hard, Nightmare.
|
||||
|
||||
### Custom Values
|
||||
|
||||
```gdscript
|
||||
# Setup custom theme selector
|
||||
var theme_values = ["light", "dark", "blue", "green"]
|
||||
var theme_names = ["Light Theme", "Dark Theme", "Blue Theme", "Green Theme"]
|
||||
theme_stepper.setup_custom_values(theme_values, theme_names)
|
||||
theme_stepper.data_source = "theme" # For better logging
|
||||
```
|
||||
|
||||
### Navigation System Integration
|
||||
|
||||
```gdscript
|
||||
# In a navigation-enabled menu
|
||||
var navigable_controls: Array[Control] = []
|
||||
|
||||
func _setup_navigation():
|
||||
navigable_controls.append(volume_slider)
|
||||
navigable_controls.append(language_stepper) # Add stepper to navigation
|
||||
navigable_controls.append(back_button)
|
||||
|
||||
func _update_visual_selection():
|
||||
for i in range(navigable_controls.size()):
|
||||
var control = navigable_controls[i]
|
||||
if control is ValueStepper:
|
||||
control.set_highlighted(i == current_index)
|
||||
else:
|
||||
# Handle other control highlighting
|
||||
pass
|
||||
|
||||
func _handle_input(action: String):
|
||||
var current_control = navigable_controls[current_index]
|
||||
if current_control is ValueStepper:
|
||||
if current_control.handle_input_action(action):
|
||||
AudioManager.play_ui_click()
|
||||
return true
|
||||
return false
|
||||
```
|
||||
|
||||
## Integration Patterns
|
||||
|
||||
### Settings Menu Pattern
|
||||
See `scenes/ui/SettingsMenu.gd` for a complete example of integrating ValueStepper into a settings menu with full navigation support.
|
||||
|
||||
### Multiple Steppers Navigation
|
||||
See `examples/ValueStepperExample.gd` for an example showing multiple steppers with keyboard/gamepad navigation.
|
||||
|
||||
## Extending ValueStepper
|
||||
|
||||
### Adding New Data Sources
|
||||
|
||||
1. **Add to `_load_data()` method**:
|
||||
```gdscript
|
||||
func _load_data():
|
||||
match data_source:
|
||||
"language":
|
||||
_load_language_data()
|
||||
"your_custom_type":
|
||||
_load_your_custom_data()
|
||||
# ... other cases
|
||||
```
|
||||
|
||||
2. **Implement your loader**:
|
||||
```gdscript
|
||||
func _load_your_custom_data():
|
||||
values = ["value1", "value2", "value3"]
|
||||
display_names = ["Display 1", "Display 2", "Display 3"]
|
||||
current_index = 0
|
||||
```
|
||||
|
||||
3. **Add value application logic**:
|
||||
```gdscript
|
||||
func _apply_value_change(new_value: String, index: int):
|
||||
match data_source:
|
||||
"your_custom_type":
|
||||
# Apply your custom logic here
|
||||
YourManager.set_custom_setting(new_value)
|
||||
```
|
||||
|
||||
### Custom Formatting
|
||||
|
||||
Override `_update_display()` for custom display formatting:
|
||||
|
||||
```gdscript
|
||||
func _update_display():
|
||||
if data_source == "your_custom_type":
|
||||
# Custom formatting logic
|
||||
value_display.text = "Custom: " + display_names[current_index]
|
||||
else:
|
||||
super._update_display() # Call parent implementation
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### When to Use ValueStepper
|
||||
- ✅ **Discrete options**: Language, difficulty, resolution, theme
|
||||
- ✅ **Settings menus**: Any option with predefined choices
|
||||
- ✅ **Game configuration**: Graphics quality, control schemes
|
||||
- ✅ **Limited options**: 2-10 options work best
|
||||
|
||||
### When NOT to Use ValueStepper
|
||||
- ❌ **Continuous values**: Use sliders for volume, brightness
|
||||
- ❌ **Large lists**: Use ItemList or OptionButton for 20+ items
|
||||
- ❌ **Text input**: Use LineEdit for user-entered text
|
||||
- ❌ **Numeric input**: Use SpinBox for number entry
|
||||
|
||||
### Performance Considerations
|
||||
- ValueStepper is lightweight and suitable for multiple instances
|
||||
- Data loading happens once in `_ready()`
|
||||
- Visual updates are minimal (just text changes)
|
||||
|
||||
### Accessibility
|
||||
- Visual highlighting provides clear focus indication
|
||||
- Audio feedback confirms user actions
|
||||
- Keyboard and gamepad support for non-mouse users
|
||||
- Consistent navigation patterns
|
||||
|
||||
## Common Issues and Solutions
|
||||
|
||||
### Stepper Not Responding to Input
|
||||
- Ensure `handle_input_action()` is called from parent's `_input()`
|
||||
- Check that the stepper has proper focus/highlighting
|
||||
- Verify input actions are defined in project input map
|
||||
|
||||
### Values Not Saving
|
||||
- Override `_apply_value_change()` to handle persistence
|
||||
- Connect to `value_changed` signal for custom save logic
|
||||
- Ensure SettingsManager or your data manager is configured
|
||||
|
||||
### Display Names Not Showing
|
||||
- Check that `display_names` array is properly populated
|
||||
- Ensure `display_names.size()` matches `values.size()`
|
||||
- Verify `_update_display()` is called after data loading
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
scenes/ui/components/
|
||||
├── ValueStepper.gd # Main component script
|
||||
└── ValueStepper.tscn # Component scene
|
||||
|
||||
examples/
|
||||
├── ValueStepperExample.gd # Usage example script
|
||||
└── ValueStepperExample.tscn # Example scene
|
||||
|
||||
docs/
|
||||
└── UI_COMPONENTS.md # This documentation
|
||||
```
|
||||
|
||||
This component provides a solid foundation for any game's settings system and can be easily extended for project-specific needs.
|
||||
89
examples/ValueStepperExample.gd
Normal file
@@ -0,0 +1,89 @@
|
||||
# Example of how to use the ValueStepper component in any scene
|
||||
extends Control
|
||||
|
||||
# Example of setting up custom navigation
|
||||
var navigable_steppers: Array[ValueStepper] = []
|
||||
var current_stepper_index: int = 0
|
||||
|
||||
@onready
|
||||
var language_stepper: ValueStepper = $VBoxContainer/Examples/LanguageContainer/LanguageStepper
|
||||
@onready
|
||||
var difficulty_stepper: ValueStepper = $VBoxContainer/Examples/DifficultyContainer/DifficultyStepper
|
||||
@onready
|
||||
var resolution_stepper: ValueStepper = $VBoxContainer/Examples/ResolutionContainer/ResolutionStepper
|
||||
@onready var custom_stepper: ValueStepper = $VBoxContainer/Examples/CustomContainer/CustomStepper
|
||||
|
||||
|
||||
func _ready():
|
||||
DebugManager.log_info("ValueStepper example ready", "Example")
|
||||
|
||||
# Setup navigation array
|
||||
navigable_steppers = [language_stepper, difficulty_stepper, resolution_stepper, custom_stepper]
|
||||
|
||||
# Connect to value change events
|
||||
for stepper in navigable_steppers:
|
||||
if not stepper.value_changed.is_connected(_on_stepper_value_changed):
|
||||
stepper.value_changed.connect(_on_stepper_value_changed)
|
||||
|
||||
# Setup custom stepper with custom values
|
||||
var themes = ["Light", "Dark", "Blue", "Green", "Purple"]
|
||||
var theme_values = ["light", "dark", "blue", "green", "purple"]
|
||||
custom_stepper.setup_custom_values(theme_values, themes)
|
||||
custom_stepper.data_source = "theme" # For better logging
|
||||
|
||||
# Highlight first stepper
|
||||
_update_stepper_highlighting()
|
||||
|
||||
|
||||
func _input(event: InputEvent):
|
||||
# Example navigation handling
|
||||
if event.is_action_pressed("move_up"):
|
||||
_navigate_steppers(-1)
|
||||
get_viewport().set_input_as_handled()
|
||||
elif event.is_action_pressed("move_down"):
|
||||
_navigate_steppers(1)
|
||||
get_viewport().set_input_as_handled()
|
||||
elif event.is_action_pressed("move_left"):
|
||||
_handle_stepper_input("move_left")
|
||||
get_viewport().set_input_as_handled()
|
||||
elif event.is_action_pressed("move_right"):
|
||||
_handle_stepper_input("move_right")
|
||||
get_viewport().set_input_as_handled()
|
||||
|
||||
|
||||
func _navigate_steppers(direction: int):
|
||||
current_stepper_index = (current_stepper_index + direction) % navigable_steppers.size()
|
||||
if current_stepper_index < 0:
|
||||
current_stepper_index = navigable_steppers.size() - 1
|
||||
_update_stepper_highlighting()
|
||||
DebugManager.log_info("Stepper navigation: index " + str(current_stepper_index), "Example")
|
||||
|
||||
|
||||
func _handle_stepper_input(action: String):
|
||||
if current_stepper_index >= 0 and current_stepper_index < navigable_steppers.size():
|
||||
var stepper = navigable_steppers[current_stepper_index]
|
||||
if stepper.handle_input_action(action):
|
||||
AudioManager.play_ui_click()
|
||||
|
||||
|
||||
func _update_stepper_highlighting():
|
||||
for i in range(navigable_steppers.size()):
|
||||
navigable_steppers[i].set_highlighted(i == current_stepper_index)
|
||||
|
||||
|
||||
func _on_stepper_value_changed(new_value: String, new_index: int):
|
||||
DebugManager.log_info(
|
||||
"Stepper value changed to: " + new_value + " (index: " + str(new_index) + ")", "Example"
|
||||
)
|
||||
# Handle value change in your scene
|
||||
# For example: apply settings, save preferences, update UI, etc.
|
||||
|
||||
|
||||
# Example of programmatically setting values
|
||||
func _on_reset_to_defaults_pressed():
|
||||
AudioManager.play_ui_click()
|
||||
language_stepper.set_current_value("en")
|
||||
difficulty_stepper.set_current_value("normal")
|
||||
resolution_stepper.set_current_value("1920x1080")
|
||||
custom_stepper.set_current_value("dark")
|
||||
DebugManager.log_info("Reset all steppers to defaults", "Example")
|
||||
1
examples/ValueStepperExample.gd.uid
Normal file
@@ -0,0 +1 @@
|
||||
uid://bu6f2vbdku4gg
|
||||
113
examples/ValueStepperExample.tscn
Normal file
@@ -0,0 +1,113 @@
|
||||
[gd_scene load_steps=3 format=3 uid="uid://cw03putw85q1o"]
|
||||
|
||||
[ext_resource type="Script" path="res://examples/ValueStepperExample.gd" id="1_example"]
|
||||
[ext_resource type="PackedScene" path="res://scenes/ui/components/ValueStepper.tscn" id="2_value_stepper"]
|
||||
|
||||
[node name="ValueStepperExample" type="Control"]
|
||||
layout_mode = 3
|
||||
anchors_preset = 15
|
||||
anchor_right = 1.0
|
||||
anchor_bottom = 1.0
|
||||
grow_horizontal = 2
|
||||
grow_vertical = 2
|
||||
script = ExtResource("1_example")
|
||||
|
||||
[node name="VBoxContainer" type="VBoxContainer" parent="."]
|
||||
layout_mode = 1
|
||||
anchors_preset = 8
|
||||
anchor_left = 0.5
|
||||
anchor_top = 0.5
|
||||
anchor_right = 0.5
|
||||
anchor_bottom = 0.5
|
||||
offset_left = -200.0
|
||||
offset_top = -150.0
|
||||
offset_right = 200.0
|
||||
offset_bottom = 150.0
|
||||
grow_horizontal = 2
|
||||
grow_vertical = 2
|
||||
|
||||
[node name="Title" type="Label" parent="VBoxContainer"]
|
||||
layout_mode = 2
|
||||
text = "ValueStepper Component Examples"
|
||||
horizontal_alignment = 1
|
||||
|
||||
[node name="HSeparator" type="HSeparator" parent="VBoxContainer"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="Examples" type="VBoxContainer" parent="VBoxContainer"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="LanguageContainer" type="HBoxContainer" parent="VBoxContainer/Examples"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="LanguageLabel" type="Label" parent="VBoxContainer/Examples/LanguageContainer"]
|
||||
custom_minimum_size = Vector2(120, 0)
|
||||
layout_mode = 2
|
||||
text = "Language:"
|
||||
|
||||
[node name="LanguageStepper" parent="VBoxContainer/Examples/LanguageContainer" instance=ExtResource("2_value_stepper")]
|
||||
layout_mode = 2
|
||||
data_source = "language"
|
||||
|
||||
[node name="DifficultyContainer" type="HBoxContainer" parent="VBoxContainer/Examples"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="DifficultyLabel" type="Label" parent="VBoxContainer/Examples/DifficultyContainer"]
|
||||
custom_minimum_size = Vector2(120, 0)
|
||||
layout_mode = 2
|
||||
text = "Difficulty:"
|
||||
|
||||
[node name="DifficultyStepper" parent="VBoxContainer/Examples/DifficultyContainer" instance=ExtResource("2_value_stepper")]
|
||||
layout_mode = 2
|
||||
data_source = "difficulty"
|
||||
|
||||
[node name="ResolutionContainer" type="HBoxContainer" parent="VBoxContainer/Examples"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="ResolutionLabel" type="Label" parent="VBoxContainer/Examples/ResolutionContainer"]
|
||||
custom_minimum_size = Vector2(120, 0)
|
||||
layout_mode = 2
|
||||
text = "Resolution:"
|
||||
|
||||
[node name="ResolutionStepper" parent="VBoxContainer/Examples/ResolutionContainer" instance=ExtResource("2_value_stepper")]
|
||||
layout_mode = 2
|
||||
data_source = "resolution"
|
||||
|
||||
[node name="CustomContainer" type="HBoxContainer" parent="VBoxContainer/Examples"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="CustomLabel" type="Label" parent="VBoxContainer/Examples/CustomContainer"]
|
||||
custom_minimum_size = Vector2(120, 0)
|
||||
layout_mode = 2
|
||||
text = "Theme:"
|
||||
|
||||
[node name="CustomStepper" parent="VBoxContainer/Examples/CustomContainer" instance=ExtResource("2_value_stepper")]
|
||||
layout_mode = 2
|
||||
data_source = "custom"
|
||||
|
||||
[node name="HSeparator2" type="HSeparator" parent="VBoxContainer"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="Instructions" type="Label" parent="VBoxContainer"]
|
||||
layout_mode = 2
|
||||
text = "Navigation:
|
||||
• Up/Down arrows - Navigate between steppers
|
||||
• Left/Right arrows - Change values
|
||||
• Mouse clicks work on arrow buttons
|
||||
|
||||
Features:
|
||||
• Multiple data sources (language, difficulty, resolution)
|
||||
• Custom values support (theme example)
|
||||
• Gamepad/keyboard navigation
|
||||
• Visual highlighting
|
||||
• Signal-based value changes"
|
||||
horizontal_alignment = 1
|
||||
|
||||
[node name="HSeparator3" type="HSeparator" parent="VBoxContainer"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="ResetButton" type="Button" parent="VBoxContainer"]
|
||||
layout_mode = 2
|
||||
text = "Reset to Defaults"
|
||||
|
||||
[connection signal="pressed" from="VBoxContainer/ResetButton" to="." method="_on_reset_to_defaults_pressed"]
|
||||
394
export_presets.cfg
Normal file
@@ -0,0 +1,394 @@
|
||||
[preset.0]
|
||||
|
||||
name="Windows Desktop"
|
||||
platform="Windows Desktop"
|
||||
runnable=true
|
||||
dedicated_server=false
|
||||
custom_features=""
|
||||
export_filter="all_resources"
|
||||
export_files=PackedStringArray()
|
||||
include_filter=""
|
||||
exclude_filter=""
|
||||
export_path="builds/skelly-windows.exe"
|
||||
encryption_include_filters=""
|
||||
encryption_exclude_filters=""
|
||||
encrypt_pck=false
|
||||
encrypt_directory=false
|
||||
|
||||
[preset.0.options]
|
||||
|
||||
custom_template/debug=""
|
||||
custom_template/release=""
|
||||
debug/export_console_wrapper=1
|
||||
binary_format/embed_pck=true
|
||||
texture_format/bptc=true
|
||||
texture_format/s3tc=true
|
||||
texture_format/etc=false
|
||||
texture_format/etc2=false
|
||||
binary_format/architecture="x86_64"
|
||||
codesign/enable=false
|
||||
codesign/identity=""
|
||||
codesign/password=""
|
||||
codesign/timestamp=true
|
||||
codesign/timestamp_server_url=""
|
||||
codesign/digest_algorithm=1
|
||||
codesign/description=""
|
||||
codesign/custom_options=PackedStringArray()
|
||||
application/modify_resources=true
|
||||
application/icon=""
|
||||
application/console_wrapper_icon=""
|
||||
application/icon_interpolation=4
|
||||
application/file_version=""
|
||||
application/product_version=""
|
||||
application/company_name=""
|
||||
application/product_name="Skelly"
|
||||
application/file_description=""
|
||||
application/copyright=""
|
||||
application/trademarks=""
|
||||
application/export_angle=0
|
||||
ssh_remote_deploy/enabled=false
|
||||
ssh_remote_deploy/host="user@host_ip"
|
||||
ssh_remote_deploy/port="22"
|
||||
ssh_remote_deploy/extra_args_ssh=""
|
||||
ssh_remote_deploy/extra_args_scp=""
|
||||
ssh_remote_deploy/run_script=""
|
||||
ssh_remote_deploy/cleanup_script=""
|
||||
|
||||
[preset.1]
|
||||
|
||||
name="Linux"
|
||||
platform="Linux/X11"
|
||||
runnable=true
|
||||
dedicated_server=false
|
||||
custom_features=""
|
||||
export_filter="all_resources"
|
||||
export_files=PackedStringArray()
|
||||
include_filter=""
|
||||
exclude_filter=""
|
||||
export_path="builds/skelly-linux.x86_64"
|
||||
encryption_include_filters=""
|
||||
encryption_exclude_filters=""
|
||||
encrypt_pck=false
|
||||
encrypt_directory=false
|
||||
|
||||
[preset.1.options]
|
||||
|
||||
custom_template/debug=""
|
||||
custom_template/release=""
|
||||
debug/export_console_wrapper=1
|
||||
binary_format/embed_pck=true
|
||||
texture_format/bptc=true
|
||||
texture_format/s3tc=true
|
||||
texture_format/etc=false
|
||||
texture_format/etc2=false
|
||||
binary_format/architecture="x86_64"
|
||||
ssh_remote_deploy/enabled=false
|
||||
ssh_remote_deploy/host="user@host_ip"
|
||||
ssh_remote_deploy/port="22"
|
||||
ssh_remote_deploy/extra_args_ssh=""
|
||||
ssh_remote_deploy/extra_args_scp=""
|
||||
ssh_remote_deploy/run_script=""
|
||||
ssh_remote_deploy/cleanup_script=""
|
||||
|
||||
[preset.2]
|
||||
|
||||
name="macOS"
|
||||
platform="macOS"
|
||||
runnable=true
|
||||
dedicated_server=false
|
||||
custom_features=""
|
||||
export_filter="all_resources"
|
||||
export_files=PackedStringArray()
|
||||
include_filter=""
|
||||
exclude_filter=""
|
||||
export_path="builds/skelly-macos.zip"
|
||||
encryption_include_filters=""
|
||||
encryption_exclude_filters=""
|
||||
encrypt_pck=false
|
||||
encrypt_directory=false
|
||||
|
||||
[preset.2.options]
|
||||
|
||||
binary_format/architecture="universal"
|
||||
custom_template/debug=""
|
||||
custom_template/release=""
|
||||
debug/export_console_wrapper=1
|
||||
application/icon=""
|
||||
application/icon_interpolation=4
|
||||
application/bundle_identifier="com.skelly.game"
|
||||
application/signature=""
|
||||
application/app_category="Games"
|
||||
application/short_version="1.0"
|
||||
application/version="1.0"
|
||||
application/copyright=""
|
||||
application/copyright_localized={}
|
||||
application/min_macos_version="10.12"
|
||||
display/high_res=false
|
||||
xcode/platform_build="14C18"
|
||||
xcode/sdk_version="13.1"
|
||||
xcode/sdk_name="macosx13.1"
|
||||
xcode/sdk_build="22C55"
|
||||
xcode/xcode_version="1420"
|
||||
xcode/xcode_build="14C18"
|
||||
codesign/codesign=1
|
||||
codesign/installer_identity=""
|
||||
codesign/apple_team_id=""
|
||||
codesign/identity=""
|
||||
codesign/entitlements/custom_file=""
|
||||
codesign/entitlements/allow_jit_code_execution=false
|
||||
codesign/entitlements/allow_unsigned_executable_memory=false
|
||||
codesign/entitlements/allow_dyld_environment_variables=false
|
||||
codesign/entitlements/disable_library_validation=false
|
||||
codesign/entitlements/audio_input=false
|
||||
codesign/entitlements/camera=false
|
||||
codesign/entitlements/location=false
|
||||
codesign/entitlements/address_book=false
|
||||
codesign/entitlements/calendars=false
|
||||
codesign/entitlements/photos_library=false
|
||||
codesign/entitlements/apple_events=false
|
||||
codesign/entitlements/debugging=false
|
||||
codesign/entitlements/app_sandbox/enabled=false
|
||||
codesign/entitlements/app_sandbox/network_server=false
|
||||
codesign/entitlements/app_sandbox/network_client=false
|
||||
codesign/entitlements/app_sandbox/device_usb=false
|
||||
codesign/entitlements/app_sandbox/device_bluetooth=false
|
||||
codesign/entitlements/app_sandbox/files_downloads=0
|
||||
codesign/entitlements/app_sandbox/files_pictures=0
|
||||
codesign/entitlements/app_sandbox/files_music=0
|
||||
codesign/entitlements/app_sandbox/files_movies=0
|
||||
codesign/entitlements/app_sandbox/helper_executables=[]
|
||||
notarization/notarization=0
|
||||
privacy/microphone_usage_description=""
|
||||
privacy/microphone_usage_description_localized={}
|
||||
privacy/camera_usage_description=""
|
||||
privacy/camera_usage_description_localized={}
|
||||
privacy/location_usage_description=""
|
||||
privacy/location_usage_description_localized={}
|
||||
privacy/address_book_usage_description=""
|
||||
privacy/address_book_usage_description_localized={}
|
||||
privacy/calendar_usage_description=""
|
||||
privacy/calendar_usage_description_localized={}
|
||||
privacy/photos_library_usage_description=""
|
||||
privacy/photos_library_usage_description_localized={}
|
||||
privacy/desktop_folder_usage_description=""
|
||||
privacy/desktop_folder_usage_description_localized={}
|
||||
privacy/documents_folder_usage_description=""
|
||||
privacy/documents_folder_usage_description_localized={}
|
||||
privacy/downloads_folder_usage_description=""
|
||||
privacy/downloads_folder_usage_description_localized={}
|
||||
privacy/network_volumes_usage_description=""
|
||||
privacy/network_volumes_usage_description_localized={}
|
||||
privacy/removable_volumes_usage_description=""
|
||||
privacy/removable_volumes_usage_description_localized={}
|
||||
ssh_remote_deploy/enabled=false
|
||||
ssh_remote_deploy/host="user@host_ip"
|
||||
ssh_remote_deploy/port="22"
|
||||
ssh_remote_deploy/extra_args_ssh=""
|
||||
ssh_remote_deploy/extra_args_scp=""
|
||||
ssh_remote_deploy/run_script=""
|
||||
ssh_remote_deploy/cleanup_script=""
|
||||
|
||||
[preset.3]
|
||||
|
||||
name="Android"
|
||||
platform="Android"
|
||||
runnable=true
|
||||
dedicated_server=false
|
||||
custom_features=""
|
||||
export_filter="all_resources"
|
||||
export_files=PackedStringArray()
|
||||
include_filter=""
|
||||
exclude_filter=""
|
||||
export_path="builds/skelly-android.apk"
|
||||
encryption_include_filters=""
|
||||
encryption_exclude_filters=""
|
||||
encrypt_pck=false
|
||||
encrypt_directory=false
|
||||
|
||||
[preset.3.options]
|
||||
|
||||
custom_template/debug=""
|
||||
custom_template/release=""
|
||||
gradle_build/use_gradle_build=false
|
||||
gradle_build/export_format=0
|
||||
gradle_build/min_sdk=""
|
||||
gradle_build/target_sdk=""
|
||||
architectures/armeabi-v7a=false
|
||||
architectures/arm64-v8a=true
|
||||
architectures/x86=false
|
||||
architectures/x86_64=false
|
||||
version/code=1
|
||||
version/name="1.0"
|
||||
package/unique_name="com.skelly.game"
|
||||
package/name="Skelly"
|
||||
package/signed=true
|
||||
package/app_category=2
|
||||
package/retain_data_on_uninstall=false
|
||||
package/exclude_from_recents=false
|
||||
launcher_icons/main_192x192=""
|
||||
launcher_icons/adaptive_foreground_432x432=""
|
||||
launcher_icons/adaptive_background_432x432=""
|
||||
graphics/32_bits_framebuffer=true
|
||||
graphics/opengl_debug=false
|
||||
xr_features/xr_mode=0
|
||||
xr_features/hand_tracking=0
|
||||
xr_features/hand_tracking_frequency=0
|
||||
xr_features/passthrough=0
|
||||
screen/immersive_mode=true
|
||||
screen/orientation=0
|
||||
screen/support_small=true
|
||||
screen/support_normal=true
|
||||
screen/support_large=true
|
||||
screen/support_xlarge=true
|
||||
user_data_backup/allow=false
|
||||
command_line/extra_args=""
|
||||
apk_expansion/enable=false
|
||||
apk_expansion/SALT=""
|
||||
apk_expansion/public_key=""
|
||||
permissions/custom_permissions=PackedStringArray()
|
||||
permissions/access_checkin_properties=false
|
||||
permissions/access_coarse_location=false
|
||||
permissions/access_fine_location=false
|
||||
permissions/access_location_extra_commands=false
|
||||
permissions/access_mock_location=false
|
||||
permissions/access_network_state=false
|
||||
permissions/access_surface_flinger=false
|
||||
permissions/access_wifi_state=false
|
||||
permissions/account_manager=false
|
||||
permissions/add_voicemail=false
|
||||
permissions/authenticate_accounts=false
|
||||
permissions/battery_stats=false
|
||||
permissions/bind_accessibility_service=false
|
||||
permissions/bind_appwidget=false
|
||||
permissions/bind_device_admin=false
|
||||
permissions/bind_input_method=false
|
||||
permissions/bind_nfc_service=false
|
||||
permissions/bind_notification_listener_service=false
|
||||
permissions/bind_print_service=false
|
||||
permissions/bind_remoteviews=false
|
||||
permissions/bind_text_service=false
|
||||
permissions/bind_vpn_service=false
|
||||
permissions/bind_wallpaper=false
|
||||
permissions/bluetooth=false
|
||||
permissions/bluetooth_admin=false
|
||||
permissions/bluetooth_privileged=false
|
||||
permissions/brick=false
|
||||
permissions/broadcast_package_removed=false
|
||||
permissions/broadcast_sms=false
|
||||
permissions/broadcast_sticky=false
|
||||
permissions/broadcast_wap_push=false
|
||||
permissions/call_phone=false
|
||||
permissions/call_privileged=false
|
||||
permissions/camera=false
|
||||
permissions/capture_audio_output=false
|
||||
permissions/capture_secure_video_output=false
|
||||
permissions/capture_video_output=false
|
||||
permissions/change_component_enabled_state=false
|
||||
permissions/change_configuration=false
|
||||
permissions/change_network_state=false
|
||||
permissions/change_wifi_multicast_state=false
|
||||
permissions/change_wifi_state=false
|
||||
permissions/clear_app_cache=false
|
||||
permissions/clear_app_user_data=false
|
||||
permissions/control_location_updates=false
|
||||
permissions/delete_cache_files=false
|
||||
permissions/delete_packages=false
|
||||
permissions/device_power=false
|
||||
permissions/diagnostic=false
|
||||
permissions/disable_keyguard=false
|
||||
permissions/dump=false
|
||||
permissions/expand_status_bar=false
|
||||
permissions/factory_test=false
|
||||
permissions/flashlight=false
|
||||
permissions/force_back=false
|
||||
permissions/get_accounts=false
|
||||
permissions/get_package_size=false
|
||||
permissions/get_tasks=false
|
||||
permissions/get_top_activity_info=false
|
||||
permissions/global_search=false
|
||||
permissions/hardware_test=false
|
||||
permissions/inject_events=false
|
||||
permissions/install_location_provider=false
|
||||
permissions/install_packages=false
|
||||
permissions/install_shortcut=false
|
||||
permissions/internal_system_window=false
|
||||
permissions/internet=false
|
||||
permissions/kill_background_processes=false
|
||||
permissions/location_hardware=false
|
||||
permissions/manage_accounts=false
|
||||
permissions/manage_app_tokens=false
|
||||
permissions/manage_documents=false
|
||||
permissions/manage_external_storage=false
|
||||
permissions/master_clear=false
|
||||
permissions/media_content_control=false
|
||||
permissions/modify_audio_settings=false
|
||||
permissions/modify_phone_state=false
|
||||
permissions/mount_format_filesystems=false
|
||||
permissions/mount_unmount_filesystems=false
|
||||
permissions/nfc=false
|
||||
permissions/persistent_activity=false
|
||||
permissions/process_outgoing_calls=false
|
||||
permissions/read_calendar=false
|
||||
permissions/read_call_log=false
|
||||
permissions/read_contacts=false
|
||||
permissions/read_external_storage=false
|
||||
permissions/read_frame_buffer=false
|
||||
permissions/read_history_bookmarks=false
|
||||
permissions/read_input_state=false
|
||||
permissions/read_logs=false
|
||||
permissions/read_phone_state=false
|
||||
permissions/read_profile=false
|
||||
permissions/read_sms=false
|
||||
permissions/read_social_stream=false
|
||||
permissions/read_sync_settings=false
|
||||
permissions/read_sync_stats=false
|
||||
permissions/read_user_dictionary=false
|
||||
permissions/reboot=false
|
||||
permissions/receive_boot_completed=false
|
||||
permissions/receive_mms=false
|
||||
permissions/receive_sms=false
|
||||
permissions/receive_wap_push=false
|
||||
permissions/record_audio=false
|
||||
permissions/reorder_tasks=false
|
||||
permissions/restart_packages=false
|
||||
permissions/send_respond_via_message=false
|
||||
permissions/send_sms=false
|
||||
permissions/set_activity_watcher=false
|
||||
permissions/set_alarm=false
|
||||
permissions/set_always_finish=false
|
||||
permissions/set_animation_scale=false
|
||||
permissions/set_debug_app=false
|
||||
permissions/set_orientation=false
|
||||
permissions/set_pointer_speed=false
|
||||
permissions/set_preferred_applications=false
|
||||
permissions/set_process_limit=false
|
||||
permissions/set_time=false
|
||||
permissions/set_time_zone=false
|
||||
permissions/set_wallpaper=false
|
||||
permissions/set_wallpaper_hints=false
|
||||
permissions/signal_persistent_processes=false
|
||||
permissions/status_bar=false
|
||||
permissions/subscribed_feeds_read=false
|
||||
permissions/subscribed_feeds_write=false
|
||||
permissions/system_alert_window=false
|
||||
permissions/transmit_ir=false
|
||||
permissions/uninstall_shortcut=false
|
||||
permissions/update_device_stats=false
|
||||
permissions/use_credentials=false
|
||||
permissions/use_sip=false
|
||||
permissions/vibrate=false
|
||||
permissions/wake_lock=false
|
||||
permissions/write_apn_settings=false
|
||||
permissions/write_calendar=false
|
||||
permissions/write_call_log=false
|
||||
permissions/write_contacts=false
|
||||
permissions/write_external_storage=false
|
||||
permissions/write_gservices=false
|
||||
permissions/write_history_bookmarks=false
|
||||
permissions/write_profile=false
|
||||
permissions/write_secure_settings=false
|
||||
permissions/write_settings=false
|
||||
permissions/write_sms=false
|
||||
permissions/write_social_stream=false
|
||||
permissions/write_sync_settings=false
|
||||
permissions/write_user_dictionary=false
|
||||
46
gdlintrc
Normal file
@@ -0,0 +1,46 @@
|
||||
class-definitions-order:
|
||||
- tools
|
||||
- classnames
|
||||
- extends
|
||||
- signals
|
||||
- enums
|
||||
- consts
|
||||
- exports
|
||||
- pubvars
|
||||
- prvvars
|
||||
- onreadypubvars
|
||||
- onreadyprvvars
|
||||
- others
|
||||
class-load-variable-name: (([A-Z][a-z0-9]*)+|_?[a-z][a-z0-9]*(_[a-z0-9]+)*)
|
||||
class-name: ([A-Z][a-z0-9]*)+
|
||||
class-variable-name: _?[a-z][a-z0-9]*(_[a-z0-9]+)*
|
||||
comparison-with-itself: null
|
||||
constant-name: '[A-Z][A-Z0-9]*(_[A-Z0-9]+)*'
|
||||
disable: []
|
||||
duplicated-load: null
|
||||
enum-element-name: '[A-Z][A-Z0-9]*(_[A-Z0-9]+)*'
|
||||
enum-name: ([A-Z][a-z0-9]*)+
|
||||
excluded_directories: !!set
|
||||
.git: null
|
||||
expression-not-assigned: null
|
||||
function-argument-name: _?[a-z][a-z0-9]*(_[a-z0-9]+)*
|
||||
function-arguments-number: 10
|
||||
function-name: (_on_([A-Z][a-z0-9]*)+(_[a-z0-9]+)*|_?[a-z][a-z0-9]*(_[a-z0-9]+)*)
|
||||
function-preload-variable-name: ([A-Z][a-z0-9]*)+
|
||||
function-variable-name: '[a-z][a-z0-9]*(_[a-z0-9]+)*'
|
||||
load-constant-name: (([A-Z][a-z0-9]*)+|[A-Z][A-Z0-9]*(_[A-Z0-9]+)*)
|
||||
loop-variable-name: _?[a-z][a-z0-9]*(_[a-z0-9]+)*
|
||||
max-file-lines: 1500
|
||||
max-line-length: 120
|
||||
max-public-methods: 20
|
||||
max-returns: 6
|
||||
mixed-tabs-and-spaces: null
|
||||
no-elif-return: null
|
||||
no-else-return: null
|
||||
private-method-call: null
|
||||
signal-name: '[a-z][a-z0-9]*(_[a-z0-9]+)*'
|
||||
sub-class-name: _?([A-Z][a-z0-9]*)+
|
||||
tab-characters: 1
|
||||
trailing-whitespace: null
|
||||
unnecessary-pass: null
|
||||
unused-argument: null
|
||||
@@ -6,3 +6,13 @@ music_volume;"Music Volume";"Громкость музыки"
|
||||
sfx_volume;"SFX Volume";"Громкость эффектов"
|
||||
language;"Language";"Язык"
|
||||
back;"Back";"Назад"
|
||||
reset_progress;"Reset All Progress";"Сбросить весь прогресс"
|
||||
confirm_reset_title;"Confirm Progress Reset";"Подтвердите сброс прогресса"
|
||||
confirm_reset_message;"Are you sure you want to delete ALL your progress?\n\nThis will permanently remove:\n• All scores and high scores\n• Game statistics\n• Saved game states\n\nThis action cannot be undone!";"Вы уверены, что хотите удалить ВЕСЬ свой прогресс?\n\nЭто навсегда удалит:\n• Все очки и рекорды\n• Игровую статистику\n• Сохранённые игровые состояния\n\nЭто действие нельзя отменить!"
|
||||
reset_confirm;"Yes, Reset Everything";"Да, сбросить всё"
|
||||
cancel;"Cancel";"Отмена"
|
||||
reset_success_title;"Progress Reset";"Прогресс сброшен"
|
||||
reset_success_message;"All progress has been successfully deleted.\nYour game has been reset to the beginning.";"Весь прогресс был успешно удалён.\nВаша игра была сброшена к началу."
|
||||
reset_error_title;"Reset Failed";"Ошибка сброса"
|
||||
reset_error_message;"There was an error resetting your progress.\nPlease try again.";"Произошла ошибка при сбросе вашего прогресса.\nПопробуйте ещё раз."
|
||||
ok;"OK";"ОК"
|
||||
|
||||
|
181
project.godot
@@ -11,16 +11,32 @@ config_version=5
|
||||
[application]
|
||||
|
||||
config/name="Skelly"
|
||||
run/main_scene="uid://ci2gk11211n0d"
|
||||
run/main_scene="res://scenes/main/main.tscn"
|
||||
config/features=PackedStringArray("4.4", "Mobile")
|
||||
config/icon="res://icon.svg"
|
||||
boot_splash/handheld/orientation=0
|
||||
boot_splash/stretch/aspect="keep"
|
||||
|
||||
[audio]
|
||||
|
||||
buses/default_bus_layout="res://data/default_bus_layout.tres"
|
||||
|
||||
[autoload]
|
||||
|
||||
SettingsManager="*res://scripts/SettingsManager.gd"
|
||||
AudioManager="*res://scripts/AudioManager.gd"
|
||||
GameManager="*res://scripts/GameManager.gd"
|
||||
LocalizationManager="*res://scripts/LocalizationManager.gd"
|
||||
SettingsManager="*res://src/autoloads/SettingsManager.gd"
|
||||
AudioManager="*res://src/autoloads/AudioManager.gd"
|
||||
GameManager="*res://src/autoloads/GameManager.gd"
|
||||
LocalizationManager="*res://src/autoloads/LocalizationManager.gd"
|
||||
DebugManager="*res://src/autoloads/DebugManager.gd"
|
||||
SaveManager="*res://src/autoloads/SaveManager.gd"
|
||||
UIConstants="*res://src/autoloads/UIConstants.gd"
|
||||
|
||||
[display]
|
||||
|
||||
window/size/viewport_width=1024
|
||||
window/size/viewport_height=768
|
||||
window/stretch/mode="canvas_items"
|
||||
window/handheld/orientation=4
|
||||
|
||||
[input]
|
||||
|
||||
@@ -30,9 +46,10 @@ ui_pause={
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":6,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
any_key={
|
||||
action_confirm={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":32,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194309,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":0,"pressure":0.0,"pressed":false,"script":null)
|
||||
, Object(InputEventMouseButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"button_mask":1,"position":Vector2(165, 16),"global_position":Vector2(174, 64),"factor":1.0,"button_index":1,"canceled":false,"pressed":true,"double_click":false,"script":null)
|
||||
]
|
||||
@@ -43,37 +60,158 @@ ui_menu_toggle={
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":1,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
action_south={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":32,"key_label":0,"unicode":32,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194309,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":74,"key_label":0,"unicode":106,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":0,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
action_east={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194305,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194308,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":75,"key_label":0,"unicode":107,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":1,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
action_west={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":69,"key_label":0,"unicode":101,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":70,"key_label":0,"unicode":102,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":72,"key_label":0,"unicode":104,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":2,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
action_north={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194306,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":73,"key_label":0,"unicode":105,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":76,"key_label":0,"unicode":108,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":3,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
move_up={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":11,"pressure":0.0,"pressed":true,"script":null)
|
||||
, Object(InputEventJoypadMotion,"resource_local_to_scene":false,"resource_name":"","device":-1,"axis":1,"axis_value":-1.0,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":87,"key_label":0,"unicode":119,"location":0,"echo":false,"script":null)
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":87,"key_label":0,"unicode":119,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194320,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":75,"key_label":0,"unicode":107,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":11,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
move_down={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":12,"pressure":0.0,"pressed":true,"script":null)
|
||||
, Object(InputEventJoypadMotion,"resource_local_to_scene":false,"resource_name":"","device":-1,"axis":1,"axis_value":1.0,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":83,"key_label":0,"unicode":115,"location":0,"echo":false,"script":null)
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":83,"key_label":0,"unicode":115,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194322,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":74,"key_label":0,"unicode":106,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":12,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
move_left={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":13,"pressure":0.0,"pressed":true,"script":null)
|
||||
, Object(InputEventJoypadMotion,"resource_local_to_scene":false,"resource_name":"","device":-1,"axis":0,"axis_value":-1.0,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":65,"key_label":0,"unicode":97,"location":0,"echo":false,"script":null)
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":65,"key_label":0,"unicode":97,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194319,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":72,"key_label":0,"unicode":104,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":13,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
move_right={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventJoypadMotion,"resource_local_to_scene":false,"resource_name":"","device":-1,"axis":0,"axis_value":1.0,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":14,"pressure":0.0,"pressed":true,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":68,"key_label":0,"unicode":100,"location":0,"echo":false,"script":null)
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":68,"key_label":0,"unicode":100,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194321,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":76,"key_label":0,"unicode":108,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":14,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
mouse_click={
|
||||
shoulder_left={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventMouseButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"button_mask":1,"position":Vector2(360, 13),"global_position":Vector2(369, 61),"factor":1.0,"button_index":1,"canceled":false,"pressed":true,"double_click":false,"script":null)
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":81,"key_label":0,"unicode":113,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":90,"key_label":0,"unicode":122,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":4,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
shoulder_right={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":82,"key_label":0,"unicode":114,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":5,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
trigger_left={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194323,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":91,"key_label":0,"unicode":91,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":6,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
trigger_right={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194324,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":93,"key_label":0,"unicode":93,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":7,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
pause_menu={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194305,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":80,"key_label":0,"unicode":112,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":6,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
options_menu={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":79,"key_label":0,"unicode":111,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194332,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":4,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
special_1={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194325,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":8,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
special_2={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194326,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":9,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
restart_level={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":82,"key_label":0,"unicode":114,"location":0,"echo":false,"script":null)
|
||||
]
|
||||
}
|
||||
next_level={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":78,"key_label":0,"unicode":110,"location":0,"echo":false,"script":null)
|
||||
]
|
||||
}
|
||||
toggle_music={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":77,"key_label":0,"unicode":109,"location":0,"echo":false,"script":null)
|
||||
]
|
||||
}
|
||||
toggle_sound={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194326,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":83,"key_label":0,"unicode":115,"location":0,"echo":false,"script":null)
|
||||
]
|
||||
}
|
||||
fullscreen={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194342,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
]
|
||||
}
|
||||
quit_game={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":true,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194335,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
]
|
||||
}
|
||||
ui_back={
|
||||
"deadzone": 0.2,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194305,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":6,"pressure":0.0,"pressed":false,"script":null)
|
||||
]
|
||||
}
|
||||
|
||||
@@ -84,4 +222,5 @@ locale/translations=PackedStringArray("res://localization/MainStrings.en.transla
|
||||
[rendering]
|
||||
|
||||
textures/canvas_textures/default_texture_filter=0
|
||||
renderer/rendering_method="mobile"
|
||||
renderer/rendering_method="gl_compatibility"
|
||||
renderer/rendering_method.mobile="gl_compatibility"
|
||||
|
||||
4
requirements.txt
Normal file
@@ -0,0 +1,4 @@
|
||||
setuptools<81
|
||||
gdtoolkit==4
|
||||
aiofiles>=23.0.0
|
||||
ruff>=0.1.0
|
||||
232
run_dev.bat
Normal file
@@ -0,0 +1,232 @@
|
||||
@echo off
|
||||
setlocal enabledelayedexpansion
|
||||
|
||||
REM =============================================================================
|
||||
REM Skelly Development Tools Runner
|
||||
REM =============================================================================
|
||||
REM
|
||||
REM This script runs development tools for the Skelly Godot project.
|
||||
REM By default, it runs all checks: linting, formatting, and testing.
|
||||
REM
|
||||
REM Usage:
|
||||
REM run_dev.bat - Run all checks (lint + format + test)
|
||||
REM run_dev.bat --lint - Run only linting
|
||||
REM run_dev.bat --format - Run only formatting
|
||||
REM run_dev.bat --test - Run only tests
|
||||
REM run_dev.bat --help - Show this help message
|
||||
REM run_dev.bat --steps lint test - Run specific steps in order
|
||||
REM
|
||||
REM =============================================================================
|
||||
|
||||
REM Initialize variables
|
||||
set "ARG_LINT_ONLY="
|
||||
set "ARG_FORMAT_ONLY="
|
||||
set "ARG_TEST_ONLY="
|
||||
set "ARG_HELP="
|
||||
set "ARG_STEPS="
|
||||
set "CUSTOM_STEPS="
|
||||
|
||||
REM Parse command line arguments
|
||||
:parse_args
|
||||
if "%~1"=="" goto :args_parsed
|
||||
if /i "%~1"=="--lint" (
|
||||
set "ARG_LINT_ONLY=1"
|
||||
shift
|
||||
goto :parse_args
|
||||
)
|
||||
if /i "%~1"=="--format" (
|
||||
set "ARG_FORMAT_ONLY=1"
|
||||
shift
|
||||
goto :parse_args
|
||||
)
|
||||
if /i "%~1"=="--test" (
|
||||
set "ARG_TEST_ONLY=1"
|
||||
shift
|
||||
goto :parse_args
|
||||
)
|
||||
if /i "%~1"=="--help" (
|
||||
set "ARG_HELP=1"
|
||||
shift
|
||||
goto :parse_args
|
||||
)
|
||||
if /i "%~1"=="--steps" (
|
||||
set "ARG_STEPS=1"
|
||||
shift
|
||||
REM Collect remaining arguments as custom steps
|
||||
:collect_steps
|
||||
if "%~1"=="" goto :args_parsed
|
||||
if "!CUSTOM_STEPS!"=="" (
|
||||
set "CUSTOM_STEPS=%~1"
|
||||
) else (
|
||||
set "CUSTOM_STEPS=!CUSTOM_STEPS! %~1"
|
||||
)
|
||||
shift
|
||||
goto :collect_steps
|
||||
)
|
||||
REM Unknown argument
|
||||
echo ❌ Unknown argument: %~1
|
||||
echo Use --help for usage information
|
||||
exit /b 1
|
||||
|
||||
:args_parsed
|
||||
|
||||
REM Show help if requested
|
||||
if defined ARG_HELP (
|
||||
echo.
|
||||
echo 🔧 Skelly Development Tools Runner
|
||||
echo.
|
||||
echo Usage:
|
||||
echo run_dev.bat - Run all checks ^(lint + format + test^)
|
||||
echo run_dev.bat --lint - Run only linting
|
||||
echo run_dev.bat --format - Run only formatting
|
||||
echo run_dev.bat --test - Run only tests
|
||||
echo run_dev.bat --help - Show this help message
|
||||
echo run_dev.bat --steps lint test - Run specific steps in order
|
||||
echo.
|
||||
echo Available steps for --steps:
|
||||
echo lint - Run GDScript linting ^(gdlint^)
|
||||
echo format - Run GDScript formatting ^(gdformat^)
|
||||
echo test - Run Godot tests
|
||||
echo.
|
||||
echo Examples:
|
||||
echo run_dev.bat ^(runs lint, format, test^)
|
||||
echo run_dev.bat --lint ^(runs only linting^)
|
||||
echo run_dev.bat --steps format lint ^(runs format then lint^)
|
||||
echo.
|
||||
exit /b 0
|
||||
)
|
||||
|
||||
echo ================================
|
||||
echo 🚀 Development Tools Runner
|
||||
echo ================================
|
||||
echo.
|
||||
|
||||
REM Check if Python is available
|
||||
python --version >nul 2>&1
|
||||
if !errorlevel! neq 0 (
|
||||
echo ❌ ERROR: Python is not installed or not in PATH
|
||||
echo.
|
||||
echo Installation instructions:
|
||||
echo 1. Install Python: winget install Python.Python.3.13
|
||||
echo 2. Restart your command prompt
|
||||
echo 3. Run this script again
|
||||
echo.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
REM Check if pip is available
|
||||
pip --version >nul 2>&1
|
||||
if !errorlevel! neq 0 (
|
||||
echo ❌ ERROR: pip is not installed or not in PATH
|
||||
echo Please ensure Python was installed correctly with pip
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
REM Check if Godot is available (only if test step will be run)
|
||||
set "NEED_GODOT="
|
||||
if defined ARG_TEST_ONLY set "NEED_GODOT=1"
|
||||
if defined ARG_STEPS (
|
||||
echo !CUSTOM_STEPS! | findstr /i "test" >nul && set "NEED_GODOT=1"
|
||||
)
|
||||
if not defined ARG_LINT_ONLY if not defined ARG_FORMAT_ONLY if not defined ARG_STEPS set "NEED_GODOT=1"
|
||||
|
||||
if defined NEED_GODOT (
|
||||
godot --version >nul 2>&1
|
||||
if !errorlevel! neq 0 (
|
||||
echo ❌ ERROR: Godot is not installed or not in PATH
|
||||
echo.
|
||||
echo Installation instructions:
|
||||
echo 1. Download Godot from https://godotengine.org/download
|
||||
echo 2. Add Godot executable to your PATH environment variable
|
||||
echo 3. Or place godot.exe in this project directory
|
||||
echo 4. Restart your command prompt
|
||||
echo 5. Run this script again
|
||||
echo.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
)
|
||||
|
||||
REM Check if gdlint and gdformat are available (only if needed)
|
||||
set "NEED_GDTOOLS="
|
||||
if defined ARG_LINT_ONLY set "NEED_GDTOOLS=1"
|
||||
if defined ARG_FORMAT_ONLY set "NEED_GDTOOLS=1"
|
||||
if defined ARG_STEPS (
|
||||
echo !CUSTOM_STEPS! | findstr /i /c:"lint" >nul && set "NEED_GDTOOLS=1"
|
||||
echo !CUSTOM_STEPS! | findstr /i /c:"format" >nul && set "NEED_GDTOOLS=1"
|
||||
)
|
||||
if not defined ARG_TEST_ONLY if not defined ARG_STEPS set "NEED_GDTOOLS=1"
|
||||
|
||||
if defined NEED_GDTOOLS (
|
||||
gdlint --version >nul 2>&1
|
||||
if !errorlevel! neq 0 (
|
||||
echo ❌ ERROR: gdlint is not installed or not in PATH
|
||||
echo.
|
||||
echo Installation instructions:
|
||||
echo 1. pip install --upgrade "setuptools<81"
|
||||
echo 2. pip install gdtoolkit==4
|
||||
echo 3. Restart your command prompt
|
||||
echo 4. Run this script again
|
||||
echo.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
gdformat --version >nul 2>&1
|
||||
if !errorlevel! neq 0 (
|
||||
echo ❌ ERROR: gdformat is not installed or not in PATH
|
||||
echo.
|
||||
echo Installation instructions:
|
||||
echo 1. pip install --upgrade "setuptools<81"
|
||||
echo 2. pip install gdtoolkit==4
|
||||
echo 3. Restart your command prompt
|
||||
echo 4. Run this script again
|
||||
echo.
|
||||
pause
|
||||
exit /b 1
|
||||
)
|
||||
)
|
||||
|
||||
echo ✅ All dependencies are available. Running development workflow...
|
||||
echo.
|
||||
|
||||
REM Build Python command based on arguments
|
||||
set "PYTHON_CMD=python tools\run_development.py"
|
||||
|
||||
if defined ARG_LINT_ONLY (
|
||||
set "PYTHON_CMD=!PYTHON_CMD! --lint"
|
||||
echo 🔍 Running linting only...
|
||||
) else if defined ARG_FORMAT_ONLY (
|
||||
set "PYTHON_CMD=!PYTHON_CMD! --format"
|
||||
echo 🎨 Running formatting only...
|
||||
) else if defined ARG_TEST_ONLY (
|
||||
set "PYTHON_CMD=!PYTHON_CMD! --test"
|
||||
echo 🧪 Running tests only...
|
||||
) else if defined ARG_STEPS (
|
||||
set "PYTHON_CMD=!PYTHON_CMD! --steps !CUSTOM_STEPS!"
|
||||
echo 🔄 Running custom workflow: !CUSTOM_STEPS!...
|
||||
) else (
|
||||
echo 🚀 Running complete development workflow: format + lint + test...
|
||||
)
|
||||
|
||||
echo.
|
||||
|
||||
REM Run the Python development workflow script
|
||||
!PYTHON_CMD!
|
||||
|
||||
REM Capture exit code and display result
|
||||
set WORKFLOW_RESULT=!errorlevel!
|
||||
|
||||
echo.
|
||||
if !WORKFLOW_RESULT! equ 0 (
|
||||
echo 🎉 Development workflow completed successfully!
|
||||
) else (
|
||||
echo ⚠️ Development workflow completed with issues.
|
||||
echo Please review the output above and fix any problems.
|
||||
)
|
||||
|
||||
echo.
|
||||
pause
|
||||
exit /b !WORKFLOW_RESULT!
|
||||
240
run_dev.sh
Normal file
@@ -0,0 +1,240 @@
|
||||
#!/usr/bin/env bash
|
||||
set -e
|
||||
|
||||
# =============================================================================
|
||||
# Skelly Development Tools Runner
|
||||
# =============================================================================
|
||||
#
|
||||
# This script runs development tools for the Skelly Godot project.
|
||||
# By default, it runs all checks: linting, formatting, and testing.
|
||||
#
|
||||
# Usage:
|
||||
# ./run_dev.sh - Run all checks (lint + format + test)
|
||||
# ./run_dev.sh --lint - Run only linting
|
||||
# ./run_dev.sh --format - Run only formatting
|
||||
# ./run_dev.sh --test - Run only tests
|
||||
# ./run_dev.sh --help - Show this help message
|
||||
# ./run_dev.sh --steps lint test - Run specific steps in order
|
||||
#
|
||||
# =============================================================================
|
||||
|
||||
# Initialize variables
|
||||
ARG_LINT_ONLY=""
|
||||
ARG_FORMAT_ONLY=""
|
||||
ARG_TEST_ONLY=""
|
||||
ARG_HELP=""
|
||||
ARG_STEPS=""
|
||||
CUSTOM_STEPS=""
|
||||
|
||||
# Parse command line arguments
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case $1 in
|
||||
--lint)
|
||||
ARG_LINT_ONLY=1
|
||||
shift
|
||||
;;
|
||||
--format)
|
||||
ARG_FORMAT_ONLY=1
|
||||
shift
|
||||
;;
|
||||
--test)
|
||||
ARG_TEST_ONLY=1
|
||||
shift
|
||||
;;
|
||||
--help)
|
||||
ARG_HELP=1
|
||||
shift
|
||||
;;
|
||||
--steps)
|
||||
ARG_STEPS=1
|
||||
shift
|
||||
# Collect remaining arguments as custom steps
|
||||
while [[ $# -gt 0 ]]; do
|
||||
if [[ -z "$CUSTOM_STEPS" ]]; then
|
||||
CUSTOM_STEPS="$1"
|
||||
else
|
||||
CUSTOM_STEPS="$CUSTOM_STEPS $1"
|
||||
fi
|
||||
shift
|
||||
done
|
||||
;;
|
||||
*)
|
||||
echo "❌ Unknown argument: $1"
|
||||
echo "Use --help for usage information"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
# Show help if requested
|
||||
if [[ -n "$ARG_HELP" ]]; then
|
||||
echo
|
||||
echo "🔧 Skelly Development Tools Runner"
|
||||
echo
|
||||
echo "Usage:"
|
||||
echo " ./run_dev.sh - Run all checks (lint + format + test)"
|
||||
echo " ./run_dev.sh --lint - Run only linting"
|
||||
echo " ./run_dev.sh --format - Run only formatting"
|
||||
echo " ./run_dev.sh --test - Run only tests"
|
||||
echo " ./run_dev.sh --help - Show this help message"
|
||||
echo " ./run_dev.sh --steps lint test - Run specific steps in order"
|
||||
echo
|
||||
echo "Available steps for --steps:"
|
||||
echo " lint - Run GDScript linting (gdlint)"
|
||||
echo " format - Run GDScript formatting (gdformat)"
|
||||
echo " test - Run Godot tests"
|
||||
echo
|
||||
echo "Examples:"
|
||||
echo " ./run_dev.sh (runs lint, format, test)"
|
||||
echo " ./run_dev.sh --lint (runs only linting)"
|
||||
echo " ./run_dev.sh --steps format lint (runs format then lint)"
|
||||
echo
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "================================"
|
||||
echo "🚀 Development Tools Runner"
|
||||
echo "================================"
|
||||
echo
|
||||
|
||||
# Check if Python is available
|
||||
if ! command -v python3 &> /dev/null && ! command -v python &> /dev/null; then
|
||||
echo "❌ ERROR: Python is not installed or not in PATH"
|
||||
echo
|
||||
echo "Installation instructions:"
|
||||
echo "1. Ubuntu/Debian: sudo apt update && sudo apt install python3 python3-pip"
|
||||
echo "2. macOS: brew install python"
|
||||
echo "3. Or download from: https://python.org/downloads"
|
||||
echo "4. Restart your terminal"
|
||||
echo "5. Run this script again"
|
||||
echo
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Use python3 if available, otherwise python
|
||||
PYTHON_CMD="python3"
|
||||
if ! command -v python3 &> /dev/null; then
|
||||
PYTHON_CMD="python"
|
||||
fi
|
||||
|
||||
# Check if pip is available
|
||||
if ! command -v pip3 &> /dev/null && ! command -v pip &> /dev/null; then
|
||||
echo "❌ ERROR: pip is not installed or not in PATH"
|
||||
echo "Please ensure Python was installed correctly with pip"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Use pip3 if available, otherwise pip
|
||||
PIP_CMD="pip3"
|
||||
if ! command -v pip3 &> /dev/null; then
|
||||
PIP_CMD="pip"
|
||||
fi
|
||||
|
||||
# Check if Godot is available (only if test step will be run)
|
||||
NEED_GODOT=""
|
||||
if [[ -n "$ARG_TEST_ONLY" ]]; then
|
||||
NEED_GODOT=1
|
||||
fi
|
||||
if [[ -n "$ARG_STEPS" ]] && [[ "$CUSTOM_STEPS" == *"test"* ]]; then
|
||||
NEED_GODOT=1
|
||||
fi
|
||||
if [[ -z "$ARG_LINT_ONLY" && -z "$ARG_FORMAT_ONLY" && -z "$ARG_STEPS" ]]; then
|
||||
NEED_GODOT=1
|
||||
fi
|
||||
|
||||
if [[ -n "$NEED_GODOT" ]]; then
|
||||
if ! command -v godot &> /dev/null; then
|
||||
echo "❌ ERROR: Godot is not installed or not in PATH"
|
||||
echo
|
||||
echo "Installation instructions:"
|
||||
echo "1. Download Godot from https://godotengine.org/download"
|
||||
echo "2. Add Godot executable to your PATH environment variable"
|
||||
echo "3. Or place godot executable in this project directory"
|
||||
echo "4. Restart your terminal"
|
||||
echo "5. Run this script again"
|
||||
echo
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# Check if gdlint and gdformat are available (only if needed)
|
||||
NEED_GDTOOLS=""
|
||||
if [[ -n "$ARG_LINT_ONLY" ]]; then
|
||||
NEED_GDTOOLS=1
|
||||
fi
|
||||
if [[ -n "$ARG_FORMAT_ONLY" ]]; then
|
||||
NEED_GDTOOLS=1
|
||||
fi
|
||||
if [[ -n "$ARG_STEPS" ]] && ([[ "$CUSTOM_STEPS" == *"lint"* ]] || [[ "$CUSTOM_STEPS" == *"format"* ]]); then
|
||||
NEED_GDTOOLS=1
|
||||
fi
|
||||
if [[ -z "$ARG_TEST_ONLY" && -z "$ARG_STEPS" ]]; then
|
||||
NEED_GDTOOLS=1
|
||||
fi
|
||||
|
||||
if [[ -n "$NEED_GDTOOLS" ]]; then
|
||||
if ! command -v gdlint &> /dev/null; then
|
||||
echo "❌ ERROR: gdlint is not installed or not in PATH"
|
||||
echo
|
||||
echo "Installation instructions:"
|
||||
echo "1. $PIP_CMD install --upgrade \"setuptools<81\""
|
||||
echo "2. $PIP_CMD install gdtoolkit==4"
|
||||
echo "3. Restart your terminal"
|
||||
echo "4. Run this script again"
|
||||
echo
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! command -v gdformat &> /dev/null; then
|
||||
echo "❌ ERROR: gdformat is not installed or not in PATH"
|
||||
echo
|
||||
echo "Installation instructions:"
|
||||
echo "1. $PIP_CMD install --upgrade \"setuptools<81\""
|
||||
echo "2. $PIP_CMD install gdtoolkit==4"
|
||||
echo "3. Restart your terminal"
|
||||
echo "4. Run this script again"
|
||||
echo
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "✅ All dependencies are available. Running development workflow..."
|
||||
echo
|
||||
|
||||
# Build Python command based on arguments
|
||||
PYTHON_FULL_CMD="$PYTHON_CMD tools/run_development.py"
|
||||
|
||||
if [[ -n "$ARG_LINT_ONLY" ]]; then
|
||||
PYTHON_FULL_CMD="$PYTHON_FULL_CMD --lint"
|
||||
echo "🔍 Running linting only..."
|
||||
elif [[ -n "$ARG_FORMAT_ONLY" ]]; then
|
||||
PYTHON_FULL_CMD="$PYTHON_FULL_CMD --format"
|
||||
echo "🎨 Running formatting only..."
|
||||
elif [[ -n "$ARG_TEST_ONLY" ]]; then
|
||||
PYTHON_FULL_CMD="$PYTHON_FULL_CMD --test"
|
||||
echo "🧪 Running tests only..."
|
||||
elif [[ -n "$ARG_STEPS" ]]; then
|
||||
PYTHON_FULL_CMD="$PYTHON_FULL_CMD --steps $CUSTOM_STEPS"
|
||||
echo "🔄 Running custom workflow: $CUSTOM_STEPS..."
|
||||
else
|
||||
echo "🚀 Running complete development workflow: format + lint + test..."
|
||||
fi
|
||||
|
||||
echo
|
||||
|
||||
# Run the Python development workflow script
|
||||
$PYTHON_FULL_CMD
|
||||
|
||||
# Capture exit code and display result
|
||||
WORKFLOW_RESULT=$?
|
||||
|
||||
echo
|
||||
if [[ $WORKFLOW_RESULT -eq 0 ]]; then
|
||||
echo "🎉 Development workflow completed successfully!"
|
||||
else
|
||||
echo "⚠️ Development workflow completed with issues."
|
||||
echo "Please review the output above and fix any problems."
|
||||
fi
|
||||
|
||||
echo
|
||||
exit $WORKFLOW_RESULT
|
||||
@@ -1,11 +0,0 @@
|
||||
[gd_scene load_steps=4 format=3 uid="uid://bkgu1a3lnxnui"]
|
||||
|
||||
[ext_resource type="Script" uid="uid://sjgbdq7xije" path="res://scenes/game_scene.gd" id="1_xv2b7"]
|
||||
[ext_resource type="PackedScene" uid="uid://bojb35864qt8e" path="res://scenes/hero.tscn" id="1_xv4of"]
|
||||
[ext_resource type="Script" uid="uid://coqdjfhn4plph" path="res://scripts/characters/player.gd" id="2_xv2b7"]
|
||||
|
||||
[node name="GameScene" type="Node"]
|
||||
script = ExtResource("1_xv2b7")
|
||||
|
||||
[node name="Hero" parent="." instance=ExtResource("1_xv4of")]
|
||||
script = ExtResource("2_xv2b7")
|
||||
126
scenes/game/game.gd
Normal file
@@ -0,0 +1,126 @@
|
||||
extends Control
|
||||
|
||||
const GAMEPLAY_SCENES = {
|
||||
"match3": "res://scenes/game/gameplays/Match3Gameplay.tscn",
|
||||
"clickomania": "res://scenes/game/gameplays/ClickomaniaGameplay.tscn"
|
||||
}
|
||||
|
||||
var current_gameplay_mode: String
|
||||
var global_score: int = 0:
|
||||
set = set_global_score
|
||||
|
||||
@onready var back_button: Button = $BackButtonContainer/BackButton
|
||||
@onready var gameplay_container: Control = $GameplayContainer
|
||||
@onready var score_display: Label = $UI/ScoreDisplay
|
||||
|
||||
|
||||
func _ready() -> void:
|
||||
if not back_button.pressed.is_connected(_on_back_button_pressed):
|
||||
back_button.pressed.connect(_on_back_button_pressed)
|
||||
|
||||
# GameManager will set the gameplay mode, don't set default here
|
||||
DebugManager.log_debug(
|
||||
"Game _ready() completed, waiting for GameManager to set gameplay mode", "Game"
|
||||
)
|
||||
|
||||
|
||||
func set_gameplay_mode(mode: String) -> void:
|
||||
DebugManager.log_info("set_gameplay_mode called with mode: %s" % mode, "Game")
|
||||
current_gameplay_mode = mode
|
||||
await load_gameplay(mode)
|
||||
DebugManager.log_info("set_gameplay_mode completed for mode: %s" % mode, "Game")
|
||||
|
||||
|
||||
func load_gameplay(mode: String) -> void:
|
||||
DebugManager.log_debug("Loading gameplay mode: %s" % mode, "Game")
|
||||
|
||||
# Clear existing gameplay and wait for removal
|
||||
var existing_children = gameplay_container.get_children()
|
||||
if existing_children.size() > 0:
|
||||
DebugManager.log_debug("Removing %d existing children" % existing_children.size(), "Game")
|
||||
for child in existing_children:
|
||||
DebugManager.log_debug("Removing existing child: %s" % child.name, "Game")
|
||||
child.queue_free()
|
||||
|
||||
# Wait for children to be properly removed from scene tree
|
||||
await get_tree().process_frame
|
||||
DebugManager.log_debug(
|
||||
"Children removal complete, container count: %d" % gameplay_container.get_child_count(),
|
||||
"Game"
|
||||
)
|
||||
|
||||
# Load new gameplay
|
||||
if GAMEPLAY_SCENES.has(mode):
|
||||
DebugManager.log_debug("Found scene path: %s" % GAMEPLAY_SCENES[mode], "Game")
|
||||
var gameplay_scene = load(GAMEPLAY_SCENES[mode])
|
||||
var gameplay_instance = gameplay_scene.instantiate()
|
||||
DebugManager.log_debug("Instantiated gameplay: %s" % gameplay_instance.name, "Game")
|
||||
gameplay_container.add_child(gameplay_instance)
|
||||
DebugManager.log_debug(
|
||||
(
|
||||
"Added gameplay to container, child count now: %d"
|
||||
% gameplay_container.get_child_count()
|
||||
),
|
||||
"Game"
|
||||
)
|
||||
|
||||
# Connect gameplay signals to shared systems
|
||||
if gameplay_instance.has_signal("score_changed"):
|
||||
gameplay_instance.score_changed.connect(_on_score_changed)
|
||||
DebugManager.log_debug("Connected score_changed signal", "Game")
|
||||
else:
|
||||
DebugManager.log_error("Gameplay mode '%s' not found in GAMEPLAY_SCENES" % mode, "Game")
|
||||
|
||||
|
||||
func set_global_score(value: int) -> void:
|
||||
global_score = value
|
||||
if score_display:
|
||||
score_display.text = "Score: " + str(global_score)
|
||||
|
||||
|
||||
func _on_score_changed(points: int) -> void:
|
||||
self.global_score += points
|
||||
SaveManager.update_current_score(self.global_score)
|
||||
|
||||
|
||||
func get_global_score() -> int:
|
||||
return global_score
|
||||
|
||||
|
||||
func _get_current_gameplay_instance() -> Node:
|
||||
if gameplay_container.get_child_count() > 0:
|
||||
return gameplay_container.get_child(0)
|
||||
return null
|
||||
|
||||
|
||||
func _on_back_button_pressed() -> void:
|
||||
DebugManager.log_debug("Back button pressed in game scene", "Game")
|
||||
AudioManager.play_ui_click()
|
||||
|
||||
# Save current grid state if we have an active match3 gameplay
|
||||
var gameplay_instance = _get_current_gameplay_instance()
|
||||
if gameplay_instance and gameplay_instance.has_method("save_current_state"):
|
||||
DebugManager.log_info("Saving grid state before exit", "Game")
|
||||
# Make sure the gameplay instance is still valid and not being destroyed
|
||||
if is_instance_valid(gameplay_instance) and gameplay_instance.is_inside_tree():
|
||||
gameplay_instance.save_current_state()
|
||||
else:
|
||||
DebugManager.log_warn("Gameplay instance invalid, skipping grid save on exit", "Game")
|
||||
|
||||
# Save the current score immediately before exiting
|
||||
SaveManager.finish_game(global_score)
|
||||
GameManager.exit_to_main_menu()
|
||||
|
||||
|
||||
func _input(event: InputEvent) -> void:
|
||||
if event.is_action_pressed("ui_back"):
|
||||
# Handle gamepad/keyboard back action - same as back button
|
||||
_on_back_button_pressed()
|
||||
elif event.is_action_pressed("action_south") and Input.is_action_pressed("action_north"):
|
||||
# Debug: Switch to clickomania when primary+secondary actions pressed together
|
||||
if current_gameplay_mode == "match3":
|
||||
set_gameplay_mode("clickomania")
|
||||
DebugManager.log_debug("Switched to clickomania gameplay", "Game")
|
||||
else:
|
||||
set_gameplay_mode("match3")
|
||||
DebugManager.log_debug("Switched to match3 gameplay", "Game")
|
||||
1
scenes/game/game.gd.uid
Normal file
@@ -0,0 +1 @@
|
||||
uid://bs4veuda3h358
|
||||
77
scenes/game/game.tscn
Normal file
@@ -0,0 +1,77 @@
|
||||
[gd_scene load_steps=4 format=3 uid="uid://8c2w55brpwmm"]
|
||||
|
||||
[ext_resource type="Script" uid="uid://bs4veuda3h358" path="res://scenes/game/game.gd" id="1_uwrxv"]
|
||||
[ext_resource type="PackedScene" path="res://scenes/ui/DebugToggle.tscn" id="3_debug"]
|
||||
[ext_resource type="Texture2D" uid="uid://bengv32u1jeym" path="res://assets/textures/backgrounds/BGx3.png" id="GlobalBackground"]
|
||||
|
||||
[node name="Game" type="Control"]
|
||||
layout_mode = 3
|
||||
anchors_preset = 15
|
||||
anchor_right = 1.0
|
||||
anchor_bottom = 1.0
|
||||
grow_horizontal = 2
|
||||
grow_vertical = 2
|
||||
script = ExtResource("1_uwrxv")
|
||||
|
||||
[node name="Background" type="TextureRect" parent="."]
|
||||
layout_mode = 1
|
||||
anchors_preset = 15
|
||||
anchor_right = 1.0
|
||||
anchor_bottom = 1.0
|
||||
grow_horizontal = 2
|
||||
grow_vertical = 2
|
||||
texture = ExtResource("GlobalBackground")
|
||||
expand_mode = 1
|
||||
stretch_mode = 1
|
||||
|
||||
[node name="UI" type="Control" parent="."]
|
||||
layout_mode = 1
|
||||
anchors_preset = 15
|
||||
anchor_right = 1.0
|
||||
anchor_bottom = 1.0
|
||||
grow_horizontal = 2
|
||||
grow_vertical = 2
|
||||
|
||||
[node name="ScoreDisplay" type="Label" parent="UI"]
|
||||
layout_mode = 1
|
||||
anchors_preset = 2
|
||||
anchor_top = 1.0
|
||||
anchor_bottom = 1.0
|
||||
offset_left = 10.0
|
||||
offset_top = -31.0
|
||||
offset_right = 110.0
|
||||
offset_bottom = -10.0
|
||||
grow_vertical = 0
|
||||
text = "Score: 0"
|
||||
|
||||
[node name="GameplayContainer" type="Control" parent="."]
|
||||
layout_mode = 1
|
||||
anchors_preset = 15
|
||||
anchor_right = 1.0
|
||||
anchor_bottom = 1.0
|
||||
grow_horizontal = 2
|
||||
grow_vertical = 2
|
||||
|
||||
[node name="BackButtonContainer" type="Control" parent="."]
|
||||
layout_mode = 1
|
||||
anchors_preset = 1
|
||||
anchor_right = 0.0
|
||||
anchor_bottom = 0.0
|
||||
offset_left = 10.0
|
||||
offset_top = 10.0
|
||||
offset_right = 55.0
|
||||
offset_bottom = 41.0
|
||||
|
||||
[node name="BackButton" type="Button" parent="BackButtonContainer"]
|
||||
layout_mode = 1
|
||||
anchors_preset = 15
|
||||
anchor_right = 1.0
|
||||
anchor_bottom = 1.0
|
||||
grow_horizontal = 2
|
||||
grow_vertical = 2
|
||||
text = "back"
|
||||
|
||||
[node name="DebugToggle" parent="." instance=ExtResource("3_debug")]
|
||||
layout_mode = 1
|
||||
|
||||
[connection signal="pressed" from="BackButtonContainer/BackButton" to="." method="_on_back_button_pressed"]
|
||||
11
scenes/game/gameplays/ClickomaniaGameplay.gd
Normal file
@@ -0,0 +1,11 @@
|
||||
extends Node2D
|
||||
|
||||
signal score_changed(points: int)
|
||||
|
||||
|
||||
func _ready():
|
||||
DebugManager.log_info("Clickomania gameplay loaded", "Clickomania")
|
||||
# Example: Add some score after a few seconds to test the system
|
||||
await get_tree().create_timer(2.0).timeout
|
||||
score_changed.emit(100)
|
||||
DebugManager.log_info("Clickomania awarded 100 points", "Clickomania")
|
||||
1
scenes/game/gameplays/ClickomaniaGameplay.gd.uid
Normal file
@@ -0,0 +1 @@
|
||||
uid://bkheckv0upd82
|
||||
21
scenes/game/gameplays/ClickomaniaGameplay.tscn
Normal file
@@ -0,0 +1,21 @@
|
||||
[gd_scene load_steps=2 format=3 uid="uid://cl7g8v0eh3mam"]
|
||||
|
||||
[ext_resource type="Script" path="res://scenes/game/gameplays/ClickomaniaGameplay.gd" id="1_script"]
|
||||
|
||||
[node name="Clickomania" type="Node2D"]
|
||||
script = ExtResource("1_script")
|
||||
|
||||
[node name="Label" type="Label" parent="."]
|
||||
anchors_preset = 8
|
||||
anchor_left = 0.5
|
||||
anchor_top = 0.5
|
||||
anchor_right = 0.5
|
||||
anchor_bottom = 0.5
|
||||
offset_left = -100.0
|
||||
offset_top = -12.0
|
||||
offset_right = 100.0
|
||||
offset_bottom = 12.0
|
||||
grow_horizontal = 2
|
||||
grow_vertical = 2
|
||||
text = "Clickomania Gameplay (Demo)"
|
||||
horizontal_alignment = 1
|
||||
1
scenes/game/gameplays/GameplayInputHandler.gd.uid
Normal file
@@ -0,0 +1 @@
|
||||
uid://cgkrsgxk0stw4
|
||||
1
scenes/game/gameplays/GridGameplay.gd.uid
Normal file
@@ -0,0 +1 @@
|
||||
uid://t8awjmas4wcg
|
||||
46
scenes/game/gameplays/Match3DebugMenu.gd
Normal file
@@ -0,0 +1,46 @@
|
||||
extends DebugMenuBase
|
||||
|
||||
|
||||
func _ready():
|
||||
# Set specific configuration for Match3DebugMenu
|
||||
log_category = "Match3"
|
||||
target_script_path = "res://scenes/game/gameplays/Match3Gameplay.gd"
|
||||
|
||||
# Call parent's _ready
|
||||
super()
|
||||
|
||||
DebugManager.log_debug("Match3DebugMenu _ready() completed", log_category)
|
||||
|
||||
# Initialize with current debug state if enabled
|
||||
var current_debug_state = DebugManager.is_debug_enabled()
|
||||
if current_debug_state:
|
||||
_on_debug_toggled(true)
|
||||
|
||||
|
||||
func _find_target_scene():
|
||||
# Debug menu is now: Match3 -> UILayer -> Match3DebugMenu
|
||||
# So we need to go up two levels: get_parent() = UILayer, get_parent().get_parent() = Match3
|
||||
var ui_layer = get_parent()
|
||||
if ui_layer and ui_layer is CanvasLayer:
|
||||
var potential_match3 = ui_layer.get_parent()
|
||||
if potential_match3 and potential_match3.get_script():
|
||||
var script_path = potential_match3.get_script().resource_path
|
||||
if script_path == target_script_path:
|
||||
match3_scene = potential_match3
|
||||
DebugManager.log_debug(
|
||||
(
|
||||
"Found match3 scene: "
|
||||
+ match3_scene.name
|
||||
+ " at path: "
|
||||
+ str(match3_scene.get_path())
|
||||
),
|
||||
log_category
|
||||
)
|
||||
_update_ui_from_scene()
|
||||
_stop_search_timer()
|
||||
return
|
||||
|
||||
# If we couldn't find it, clear the reference and continue searching
|
||||
match3_scene = null
|
||||
DebugManager.log_error("Could not find match3_gameplay scene", log_category)
|
||||
_start_search_timer()
|
||||
1
scenes/game/gameplays/Match3DebugMenu.gd.uid
Normal file
@@ -0,0 +1 @@
|
||||
uid://ccfms5oiub35j
|
||||
83
scenes/game/gameplays/Match3DebugMenu.tscn
Normal file
@@ -0,0 +1,83 @@
|
||||
[gd_scene load_steps=2 format=3 uid="uid://b76oiwlifikl3"]
|
||||
|
||||
[ext_resource type="Script" path="res://scenes/game/gameplays/Match3DebugMenu.gd" id="1_debug_menu"]
|
||||
|
||||
[node name="DebugMenu" type="Control"]
|
||||
layout_mode = 3
|
||||
anchors_preset = 1
|
||||
anchor_left = 1.0
|
||||
anchor_right = 1.0
|
||||
offset_left = -201.0
|
||||
offset_top = 59.0
|
||||
offset_right = -11.0
|
||||
offset_bottom = 169.0
|
||||
grow_horizontal = 0
|
||||
script = ExtResource("1_debug_menu")
|
||||
|
||||
[node name="VBoxContainer" type="VBoxContainer" parent="."]
|
||||
layout_mode = 1
|
||||
anchors_preset = 15
|
||||
anchor_right = 1.0
|
||||
anchor_bottom = 1.0
|
||||
offset_left = 10.0
|
||||
offset_top = 10.0
|
||||
offset_right = -10.0
|
||||
offset_bottom = -10.0
|
||||
grow_horizontal = 2
|
||||
grow_vertical = 2
|
||||
|
||||
[node name="TitleLabel" type="Label" parent="VBoxContainer"]
|
||||
layout_mode = 2
|
||||
text = "Match-3 Debug Menu"
|
||||
horizontal_alignment = 1
|
||||
|
||||
[node name="RegenerateButton" type="Button" parent="VBoxContainer"]
|
||||
layout_mode = 2
|
||||
text = "Generate New Grid"
|
||||
|
||||
[node name="GemTypesContainer" type="HBoxContainer" parent="VBoxContainer"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="GemTypesLabel" type="Label" parent="VBoxContainer/GemTypesContainer"]
|
||||
layout_mode = 2
|
||||
text = "Gem Types: 5"
|
||||
|
||||
[node name="GemTypesSpinBox" type="SpinBox" parent="VBoxContainer/GemTypesContainer"]
|
||||
layout_mode = 2
|
||||
min_value = 3.0
|
||||
max_value = 8.0
|
||||
value = 5.0
|
||||
|
||||
[node name="GridSizeContainer" type="VBoxContainer" parent="VBoxContainer"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="GridSizeLabel" type="Label" parent="VBoxContainer/GridSizeContainer"]
|
||||
layout_mode = 2
|
||||
text = "Grid Size"
|
||||
horizontal_alignment = 1
|
||||
|
||||
[node name="GridWidthContainer" type="HBoxContainer" parent="VBoxContainer/GridSizeContainer"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="GridWidthLabel" type="Label" parent="VBoxContainer/GridSizeContainer/GridWidthContainer"]
|
||||
layout_mode = 2
|
||||
text = "Width: 8"
|
||||
|
||||
[node name="GridWidthSpinBox" type="SpinBox" parent="VBoxContainer/GridSizeContainer/GridWidthContainer"]
|
||||
layout_mode = 2
|
||||
min_value = 4.0
|
||||
max_value = 12.0
|
||||
value = 8.0
|
||||
|
||||
[node name="GridHeightContainer" type="HBoxContainer" parent="VBoxContainer/GridSizeContainer"]
|
||||
layout_mode = 2
|
||||
|
||||
[node name="GridHeightLabel" type="Label" parent="VBoxContainer/GridSizeContainer/GridHeightContainer"]
|
||||
layout_mode = 2
|
||||
text = "Height: 8"
|
||||
|
||||
[node name="GridHeightSpinBox" type="SpinBox" parent="VBoxContainer/GridSizeContainer/GridHeightContainer"]
|
||||
layout_mode = 2
|
||||
min_value = 4.0
|
||||
max_value = 12.0
|
||||
value = 8.0
|
||||