Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mphe committed Jul 28, 2024
1 parent e8e16b7 commit 832b6fb
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The computation-heavy simulation part is written in C++ using GDExtension, the r

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.

# Setup
## Setup

1. Get the addon
* [Download](https://godotengine.org/asset-library/asset/2334) from the asset store, or
Expand All @@ -19,7 +19,7 @@ The last Godot 3.x version can be found on the [3.x branch](https://github.com/m
3. Enable the addon in the project settings
4. Restart Godot

# Building
## Building

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

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

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

# Documentation
## Documentation and Usage

Following nodes exist:
### Nodes

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

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.

All rope related tools, automatically pause themselves when their target rope is paused to save performance.
**NOTE:** All rope related tools automatically pause themselves when their target rope is paused to reduce computation costs and improve performance.

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

The project also includes various example scenes that demonstrate the features of this plugin.
### Editor Menu
When one of the above nodes is selected, a "*Ropesim*" menu appears in the editor toolbar with the following options:
* `Preview in Editor`: Toggle live preview in the editor on or off.
* `Reset Rope`: Reset the selected rope to its resting position.

### Examples
The project includes various example scenes that demonstrate the features of this plugin.
See also the [showcase video](#showcase) for a basic usage example.

# Showcase
## Showcase

A quick overview of how to use each node.

Expand Down

0 comments on commit 832b6fb

Please sign in to comment.