.cursorrules (deprecated)

1# Godot 4.4 Game Development .cursorrules
2 
3## Core Development Guidelines
4 
5- Use strict typing in GDScript for better error detection and IDE support
6- Implement \_ready() and other lifecycle functions with explicit super() calls
7- Use @onready annotations instead of direct node references in \_ready()
8- Prefer composition over inheritance where possible
9- Use signals for loose coupling between nodes
10- Follow Godot's node naming conventions (PascalCase for nodes, snake_case for methods)
11 
12## Code Style
13 
14- Use type hints for all variables and function parameters
15- Document complex functions with docstrings
16- Keep methods focused and under 30 lines when possible
17- Use meaningful variable and function names
18- Group related properties and methods together
19 
20## Naming Conventions
21 
22- Files: Use snake_case for all filenames (e.g., player_character.gd, main_menu.tscn)
23- Classes: Use PascalCase for custom class names with class_name (e.g., PlayerCharacter)
24- Variables: Use snake_case for all variables including member variables (e.g., health_points)
25- Constants: Use ALL_CAPS_SNAKE_CASE for constants (e.g., MAX_HEALTH)
26- Functions: Use snake_case for all functions including lifecycle functions (e.g., move_player())
27- Enums: Use PascalCase for enum type names and ALL_CAPS_SNAKE_CASE for enum values
28- Nodes: Use PascalCase for node names in the scene tree (e.g., PlayerCharacter, MainCamera)
29- Signals: Use snake_case in past tense to name events (e.g., health_depleted, enemy_defeated)
30 
31## Scene Organization
32 
33- Keep scene tree depth minimal for better performance
34- Use scene inheritance for reusable components
35- Implement proper scene cleanup on queue_free()
36- Use SubViewport nodes carefully due to performance impact
37- Provide step-by-step instructions to create Godot scene(s) instead of providing scene source code
38 
39## Signal Best Practices
40 
41- Use clear, contextual signal names that describe their purpose (e.g., player_health_changed)
42- Utilize typed signals to improve safety and IDE assistance (e.g., signal item_collected(item_name: String))
43- Connect signals in code for dynamic nodes, and in the editor for static relationships
44- Avoid overusing signals - reserve them for important events, not frequent updates
45- Pass only necessary data through signal arguments, avoiding entire node references when possible
46- Use an autoload "EventBus" singleton for global signals that need to reach distant nodes
47- Minimize signal bubbling through multiple parent nodes
48- Always disconnect signals when nodes are freed to prevent memory leaks
49- Document signals with comments explaining their purpose and parameters
50 
51## Resource Management
52 
53- Implement proper resource cleanup in \_exit_tree()
54- Use preload() for essential resources, load() for optional ones
55- Consider PackedByteArray storage impact on backwards compatibility
56- Implement resource unloading for unused assets
57 
58## Performance Best Practices
59 
60- Use node groups judiciously for managing collections, and prefer direct node references for frequent, specific access to individual nodes.
61- Implement object pooling for frequently spawned objects
62- Use physics layers to optimize collision detection
63- Prefer packed arrays (PackedVector2Array, etc.) over regular arrays
64 
65## Error Handling
66 
67- Implement graceful fallbacks for missing resources
68- Use assert() for development-time error checking
69- Log errors appropriately in production builds
70- Handle network errors gracefully in multiplayer games
71 
72## TileMap Implementation
73 
74- TileMap node is deprecated - use multiple TileMapLayer nodes instead
75- Convert existing TileMaps using the TileMap bottom panel toolbox option "Extract TileMap layers"
76- Access TileMap layers through TileMapLayer nodes
77- Update navigation code to use TileMapLayer.get_navigation_map()
78- Store layer-specific properties on individual TileMapLayer nodes
79