Skip to content

Commit

Permalink
Update README to feature matrix format
Browse files Browse the repository at this point in the history 
Reformat the README's features section into a matrix for improved clarity. The matrix lists support for GDScript and C# across features, providing detailed descriptions for each, aiding in better visual comprehension.
  • Loading branch information
@khalidabuhakmeh
khalidabuhakmeh committed Sep 17, 2024
1 parent b715a3d commit f759db7
Showing 1 changed file with 15 additions and 19 deletions.
34 changes: 15 additions & 19 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,21 @@ Rider is JetBrains' cross platform .NET IDE, based on ReSharper and the IntelliJ

# Features

- Supports Godot versions 3.x and 4.x with a design ready for future updates.
- Bundles syntax highlighting for Godot file types, including GDScript, scenes, and resources.
- Integrated with the Language Server Protocol provided by Godot.
- Autogenerates multiple run configurations:
- Player to Run/Debug or Profile game in one click.
- Editor to Run/Debug or Profile Godot Editor in one click.
- [Godot3] Attach to debug already started player.
- Context menu on a scene file allows running game directly to that scene.
- Supports [gdUnit4Net](https://github.com/MikeSchulze/gdUnit4Net) test framework.
- Supports Input Action and NodePath completion in string literals [More](https://github.com/JetBrains/godot-support/pull/102).
- Debugger extension that adds a “Current Scene” item to the Variables and Watches tab and a Children node to every Godot.Node item in the Variables and Watches tab.
- Godot specific warnings and quick fixes, integrated with Roslyn provided ones.
- External annotations for Godot specific attributes:
- Fields marked with [Export] attribute would not be marked as not-initialized.
- Classes marked with [Tool] attribute would not be marked as unused.
- Delegates marked with [Signal] attribute would not be marked as unused.
- And more!

# Recomendations
| Feature | GDScript | C# | Details |
|------------------------------------------------------------------------|----------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| v3.0 | ✔ | ✔ | support for v3.0 versions and updates |
| v4.0 | ✔ | ✔ | design ready for future updates |
| Syntax Highlighting | ✔ | * | GDScript, scenes, & resources. *C# highlighting provided by [JetBrains Rider](https://jetbrains.com/rider) |
| Godot GDScript LSP | ✔ | ✔ | LSP from current editor |
| Run Configurations | ✔ | ✔ | Run/Debug, launch editor, and context menu on a scene file allows running game directly to that scene |
| [gdUnit4Net](https://github.com/MikeSchulze/gdUnit4Net) test framework | n/a | ✔ | Write and run unit tests in C# |
| Input Action and NodePath completions | ✔ | ✔ | completion in string literals and [more](https://github.com/JetBrains/godot-support/pull/102) |
| Debugger | ✔ | ✔ | adds a “Current Scene” item to the Variables and Watches tab and a Children node to every Godot.Node item in the Variables and Watches tab. .NET debugging occurs in .NET runtime with access to scene variables. |
| Godot warnings and quick fixes | ✔ | ✔ | Godot specific warnings and quick fixes, integrated with Roslyn provided ones. |
| External Annotations for Godot Attributes | n/a | ✔ | C# Warning suppression for known Godot idioms |
| and More... | | | |

# Recommendations

Add `.idea` to [.gitignore](https://github.com/van800/godot-demo-projects/pull/2/files#diff-a084b794bc0759e7a6b77810e01874f2R22)
Include `tscn` in your project as demonstrated [here](https://github.com/van800/godot-demo-projects/pull/2/files#diff-d6ab4c56e3f79be158a2dbd5b9ae8eb8R7)
Expand Down

0 comments on commit f759db7

Please sign in to comment.