GDNative-Ropesim - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #typescript #go #android #machine-learning #deep-learning #docker #macos #nodejs #java #awesome-list #security #open-source

GDNative-Ropesim

(★ 126)

A 2D verlet integration based rope simulation for Godot 4. Written in C++ using GDExtension for fast performance.

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug-issue.md
- - build.yml
  - ci.yml
- project.godot
- NativeRopeServer.xml
- RopeStiffnessParameters.xml
- RopeWindParameters.xml
- collisions.md
- developing.md
- execution_order.md
- gdlibrary.cpp
- gdlibrary.hpp
- NativeRopeContext.cpp
- NativeRopeContext.hpp
- NativeRopeServer.cpp
- NativeRopeServer.hpp
- RopeStiffnessParameters.cpp
- RopeStiffnessParameters.hpp
- RopeWindParameters.cpp
- RopeWindParameters.hpp
.clang-format
.clang-tidy
.clangd
.gitignore
.gitmodules
compile_debug.bat
compile_debug.sh
compile_release.bat
compile_release.sh
FAQ.md
godot-cpp
LICENSE
Makefile
README.md
run_clang_tidy.sh
SConstruct

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GDNative Ropesim

![Godot 4.3+ compatible](https://img.shields.io/badge/Godot-4.3+-%23478cbf?logo=godot-engine&logoColor=white)

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

A 2D verlet integration based rope simulation for Godot 4.3+.

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.

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 version is no longer maintained.

If you like this plugin and want to support my work, consider leaving a tip on Ko-fi.<br/>
[![Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Q5Q015GBOP)

## Setup

1. Download the addon
    * From the [Asset Library](https://godotengine.org/asset-library/asset/2334)
    * From the [Beta Asset Store](https://store-beta.godotengine.org/asset/mphe/gdnative-ropesim/)
    * From the [Release Page](https://github.com/mphe/GDNative-Ropesim/releases/latest)
    * From [GitHub Actions](https://github.com/mphe/GDNative-Ropesim/actions) (for preview builds mostly)
2. Move `addons/ropesim` to your project's `addons/` directory
3. Enable the addon in the project settings
4. Possibly restart Godot

## Documentation and Usage

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

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

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

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

### Advanced Topics
- [Collisions Documentation](docs/collisions.md)
- [Execution Order Documentation](docs/execution_order.md)
- [Developing](docs/developing.md)

## FAQ / Troubleshooting

See [FAQ](FAQ.md).

## Showcase

A quick overview of how to use each node.

https://user-images.githubusercontent.com/7116001/216790870-4e57fce0-7981-44f5-9963-daa1d9751abf.mp4

Jellyfish with rope simulated tentacles.

https://user-images.githubusercontent.com/7116001/216791913-35321ddb-ee35-44e2-85ba-0632a1123fda.mp4

More advanced usage examples.

https://github.com/user-attachments/assets/28e3dda1-6929-4ddf-8afa-041f66a5849b

Collisions with physics bodies

https://github.com/user-attachments/assets/424e8277-6e20-4ccc-9231-ec5003d57bae