Skip to content

Commit 832b6fb

Browse files
committed
Update readme
1 parent e8e16b7 commit 832b6fb

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The computation-heavy simulation part is written in C++ using GDExtension, the r
88

99
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.
1010

11-
# Setup
11+
## Setup
1212

1313
1. Get the addon
1414
* [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
1919
3. Enable the addon in the project settings
2020
4. Restart Godot
2121

22-
# Building
22+
## Building
2323

2424
First, clone or download the repository and run `git submodule update --init --recursive`.
2525

@@ -35,26 +35,32 @@ $ scons target=template_debug platform=linux arch=x86_64 -j8
3535

3636
Output files are saved to `demo/addons/ropesim/bin/`.
3737

38-
# Documentation
38+
## Documentation and Usage
3939

40-
Following nodes exist:
40+
### Nodes
41+
42+
The following nodes exist:
4143
* `Rope`: The basic rope node. Optionally renders the rope using `draw_polyline()`.
4244
* `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.
4345
* `RopeHandle`: A handle that can be used to control, animate, or fixate parts of the rope.
4446
* `RopeRendererLine2D`: Renders a target rope using `Line2D`.
4547
* `RopeCollisionShapeGenerator`: Can be used e.g. in an `Area2D` to detect collisions with the target rope.
4648
* `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.
4749

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.
5151

5252
Use the in-engine help to view the full documentation for each node.
5353

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.
5561
See also the [showcase video](#showcase) for a basic usage example.
5662

57-
# Showcase
63+
## Showcase
5864

5965
A quick overview of how to use each node.
6066

0 commit comments

Comments
 (0)