Skip to content

Commit cefbc96

Browse files
committed
Update readme
1 parent f1288bc commit cefbc96

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<img src="https://github.com/mphe/GDNative-Ropesim/assets/7116001/272f4f65-cb79-4798-97ba-f0d43589caef" width=128px align="right"/>
44

5-
A 2D verlet integration based rope simulation for Godot 4.2.
5+
A 2D verlet integration based rope simulation for Godot 4.2+.
66

77
The computation-heavy simulation part is written in C++ using GDExtension, the rest in GDScript. This allows for fast processing and easy extendability, while keeping the code readable.
88

@@ -15,9 +15,9 @@ The last Godot 3.x version can be found on the [3.x branch](https://github.com/m
1515
* [Download](https://github.com/mphe/GDNative-Ropesim/releases/latest) the latest release from the release page, or
1616
* [Download](https://github.com/mphe/GDNative-Ropesim/actions) it from the latest GitHub Actions run, or
1717
* [Compile](#building) it yourself.
18-
3. Copy or symlink `addons/ropesim` to your project's `addons/` directory
19-
4. Enable the addon in the project settings
20-
5. Restart Godot
18+
2. Copy or symlink `addons/ropesim` to your project's `addons/` directory
19+
3. Enable the addon in the project settings
20+
4. Restart Godot
2121

2222
# Building
2323

@@ -29,7 +29,7 @@ To compile for Linux, run the following commands.
2929
Compiling for other platforms works analogously.
3030

3131
```sh
32-
$ scons target=template_release platform=linux arch=x86_64 -j8
32+
$ scons target=template_release platform=linux optimize=speed arch=x86_64 -j8
3333
$ scons target=template_debug platform=linux arch=x86_64 -j8
3434
```
3535

@@ -43,15 +43,17 @@ Following nodes exist:
4343
* `RopeHandle`: A handle that can be used to control, animate, or fixate parts of the rope.
4444
* `RopeRendererLine2D`: Renders a target rope using `Line2D`.
4545
* `RopeCollisionShapeGenerator`: Can be used e.g. in an `Area2D` to detect collisions with the target rope.
46-
47-
See inline comments for further information and documentation of node properties.
48-
49-
The included demo project and the showcase video below provide some usage examples.
46+
* `RopeInteraction`: Handles mutual interaction of a target node with a rope. Useful for rope grabbing or pulling mechanics where an object should be able to affect the rope and vice-versa.
5047

5148
When one of these nodes is selected, a "Ropesim" menu appears in the editor toolbar that can be used to toggle live preview in the editor on and off.
5249

5350
All rope related tools, automatically pause themselves when their target rope is paused to save performance.
5451

52+
Use the in-engine help to view the full documentation for each node.
53+
54+
The project also includes various example scenes that demonstrate the features of this plugin.
55+
See also the [showcase video](#showcase) for a basic usage example.
56+
5557
# Showcase
5658

5759
A quick overview of how to use each node.

0 commit comments

Comments
 (0)