mphe / gdnative-ropesim Goto Github PK

View Code? Open in Web Editor NEW

38.0 1.0 1.0 72 KB

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

License: MIT License

Python 9.39% C++ 90.14% Shell 0.47%

fast gdnative godot integration rope simulation verlet gdextension

gdnative-ropesim's Introduction

GDNative Ropesim

A 2D verlet integration based rope simulation for Godot 4.2.

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, however, this branch will no longer receive updates.

Setup

Get the addon
- Download from the asset store, or
- Download the latest release from the release page, or
- Download it from the latest GitHub Actions run, or
- Compile it yourself.
Copy or symlink addons/ropesim to your project's addons/ directory
Enable the addon in the project settings
Restart Godot

Building

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

See here on how to create and compile GDExtension libraries.

To compile for Linux, run the following commands. Compiling for other platforms works analogously.

$ scons target=template_release platform=linux arch=x86_64 -j8
$ scons target=template_debug platform=linux arch=x86_64 -j8

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

Documentation

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.

See inline comments for further information and documentation of node properties.

The included demo project and the showcase video below provide some usage examples.

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.

Showcase

A quick overview of how to use each node.

ropesim_showcase.mp4

Jellyfish with rope simulated tentacles.

jelly.final_4M.mp4

gdnative-ropesim's People

Contributors

Stargazers

Watchers

Forkers

yangqingming

gdnative-ropesim's Issues

Problem with Android

I attempted to execute an Android version on my mobile device, but encountered an issue with the rope not rendering correctly. Upon inspecting the build console, I identified the following error message:

Can't open file from path 'res://addons/ropesim/bin/libropesim.android.template_debug.arm64.so'.
Parser Error: Identifier "NativeRopeServer" not declared in the current scope.

I saw that there are steps in the GitHub Actions for generating Android files: here. So I'm not sure about the cause of my error. Are there any specific guidelines or tricks to successfully get an Android build? I use the GUI godot exporter to directly run on my phone. and the addon is installed from godot AssetLib.

Thanks in advance :)

Web Export Support

Hi, I was using your addon and it worked great, until I tried using it in my web export and it resulted in the following error message:

No suitable library found for GDExtension: res://addons/ropesim/libropesim.gdextension. Possible feature flags for your platform: web, s3tc, wasm32, template, debug, template_debug

My game still ran but just with the ropes non-existent. I tried building my own library with the template for web into wasm files and I added these lines into the gdextension file:

web.debug.wasm = "res://addons/ropesim/bin/libropesim.web.template_debug.wasm32.a"
web.release.wasm = "res://addons/ropesim/bin/libropesim.web.template_release.wasm32.a"

But it still didn't work, so I was wondering if there will be any support for web or if its just a limitation of the Godot engine.

Provide more example scenes

Rope grabbing and swinging for platformers
Dynamic rope extension/retracting
Collision detection