Last active
June 13, 2025 11:35
-
-
Save avivajpeyi/21788c072f251b2de756f1696304c4f3 to your computer and use it in GitHub Desktop.
Godot dir proj setup
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/bin/bash | |
# List of folders to create | |
folders=( | |
"assets/sprites" | |
"assets/sfx" | |
"assets/music" | |
"docs" | |
"godot/addons" | |
"godot/scenes/player" | |
"godot/scenes/enemies" | |
"godot/scenes/tiles" | |
"godot/scenes/levels" | |
"godot/scenes/props" | |
"godot/scenes/ui" | |
"godot/scripts/player" | |
"godot/scripts/enemies" | |
"godot/scripts/systems" | |
"godot/scripts/levels" | |
"godot/scripts/utils" | |
"godot/audio" | |
"godot/textures" | |
"godot/fonts" | |
"godot/shaders" | |
"godot/tests" | |
"exports" | |
".github/workflows" | |
) | |
# Create folders and add .gitkeep | |
for dir in "${folders[@]}"; do | |
mkdir -p "$dir" | |
touch "$dir/.gitkeep" | |
done | |
# Create docs | |
cat > docs/README.md << 'EOF' | |
# miniStealth | |
A fast-paced stealth platformer where you use a grappling hook to avoid detection. | |
This repo contains the Godot source files for the game, built for the GitHub Game Off 2024. | |
EOF | |
cat > docs/mechanics.md << 'EOF' | |
# Game Mechanics | |
- Enemies have vision cones and enter an 'alert' state when they see you. | |
- Grappling hook lets you zip across gaps and escape line of sight. | |
- Knock out enemies by sneaking up and hitting them. | |
EOF | |
cat > docs/inspiration.md << 'EOF' | |
# Inspirations | |
- miniStealth by Fer Gonzalez | |
- Celeste for movement feel | |
- Mark of the Ninja for stealth feedback | |
EOF | |
# Sandbox test scene | |
cat > godot/tests/sandbox.tscn << 'EOF' | |
[gd_scene load_steps=2 format=3 uid="test_sandbox"] | |
[node name="Sandbox" type="Node2D"] | |
# Drag test components here to quickly validate gameplay elements. | |
EOF | |
# .github/workflows README | |
cat > .github/workflows/README.md << 'EOF' | |
# GitHub Workflows | |
This folder is for GitHub Actions CI/CD workflows. | |
You can use it to: | |
- Build and export the Godot project automatically | |
- Run linting (if using GDScript linter or static analysis) | |
- Deploy web builds to GitHub Pages | |
Example files: `godot-export.yml`, `build-checks.yml`, etc. | |
EOF | |
# Optional: placeholder CI file | |
cat > .github/workflows/placeholder.yml << 'EOF' | |
# Example GitHub Actions workflow (disabled) | |
# Remove/comment out "workflow_dispatch" to enable manually | |
name: Placeholder Workflow | |
on: | |
workflow_dispatch: # Manual trigger only | |
jobs: | |
placeholder: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v3 | |
- name: Print hello | |
run: echo "Set up real CI when ready!" | |
EOF | |
echo "✅ Project structure complete — including .github/workflows/!" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment