You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ The computation-heavy simulation part is written in C++ using GDExtension, the r
8
8
9
9
The last Godot 3.x version can be found on the [3.x branch](https://github.com/mphe/GDNative-Ropesim/tree/3.x), however, this branch will no longer receive updates.
10
10
11
-
# Setup
11
+
##Setup
12
12
13
13
1. Get the addon
14
14
*[Download](https://godotengine.org/asset-library/asset/2334) from the asset store, or
@@ -19,7 +19,7 @@ The last Godot 3.x version can be found on the [3.x branch](https://github.com/m
19
19
3. Enable the addon in the project settings
20
20
4. Restart Godot
21
21
22
-
# Building
22
+
##Building
23
23
24
24
First, clone or download the repository and run `git submodule update --init --recursive`.
Output files are saved to `demo/addons/ropesim/bin/`.
37
37
38
-
# Documentation
38
+
##Documentation and Usage
39
39
40
-
Following nodes exist:
40
+
### Nodes
41
+
42
+
The following nodes exist:
41
43
*`Rope`: The basic rope node. Optionally renders the rope using `draw_polyline()`.
42
44
*`RopeAnchor`: Always snaps to the specified position on the target rope. Optionally, also adapts to the rope's curvature. Can be used to attach objects to a rope.
43
45
*`RopeHandle`: A handle that can be used to control, animate, or fixate parts of the rope.
44
46
*`RopeRendererLine2D`: Renders a target rope using `Line2D`.
45
47
*`RopeCollisionShapeGenerator`: Can be used e.g. in an `Area2D` to detect collisions with the target rope.
46
48
*`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.
47
49
48
-
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.
49
-
50
-
All rope related tools, automatically pause themselves when their target rope is paused to save performance.
50
+
**NOTE:** All rope related tools automatically pause themselves when their target rope is paused to reduce computation costs and improve performance.
51
51
52
52
Use the in-engine help to view the full documentation for each node.
53
53
54
-
The project also includes various example scenes that demonstrate the features of this plugin.
54
+
### Editor Menu
55
+
When one of the above nodes is selected, a "*Ropesim*" menu appears in the editor toolbar with the following options:
56
+
*`Preview in Editor`: Toggle live preview in the editor on or off.
57
+
*`Reset Rope`: Reset the selected rope to its resting position.
58
+
59
+
### Examples
60
+
The project includes various example scenes that demonstrate the features of this plugin.
55
61
See also the [showcase video](#showcase) for a basic usage example.
0 commit comments