Skip to content

Commit

Permalink
Bump version, update docs, remove unused files
Browse files Browse the repository at this point in the history
  • Loading branch information
mphe committed Nov 5, 2023
1 parent ec920c1 commit 50f5bfa
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 37 deletions.
43 changes: 21 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,36 @@
# GDNative Ropesim

A 2D verlet integration based rope simulation for Godot 3.x. Written in C++ using GDNative for fast performance.
A 2D verlet integration based rope simulation for Godot 4.2.

The computation-heavy simulation part is written in C++, the rest in GDscript. This allows for fast processing and easy extendability, while keeping the code readable.
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 branch will no longer receive updates.

# Setup

1. Clone or download the repository
2. Run `git submodule update --init --recursive`
3. Get the library
* [Build](#building) it yourself or
* [Download](https://github.com/mphe/GDNative-Ropesim/actions) it from the latest Github Actions workflow run and put all contained files in `demo/addons/ropesim/bin/`.
4. Copy or symlink `demo/addons` to your project or use the provided demo project.
5. Enable the addon in the project settings
6. Restart Godot
1. Get the addon
* [Download]() the latest release from the release page, or
* [Download](https://github.com/mphe/GDNative-Ropesim/actions) it from the latest GitHub Actions run, or
* [Compile](#building) it yourself.
2. Copy or symlink `addons/ropesim` to your project's `addons/` directory
3. Enable the addon in the project settings
4. Restart Godot

# Building

See [here](https://docs.godotengine.org/en/stable/tutorials/scripting/gdnative/gdnative_cpp_example.html) on how to compile GDNative libraries.
First, clone or download the repository and run `git submodule update --init --recursive`.

Output files are saved to `demo/addons/ropesim/bin/`.
See [here](https://docs.godotengine.org/en/latest/tutorials/scripting/gdextension/gdextension_cpp_example.html#doc-gdextension-cpp-example) on how to create and compile GDExtension libraries.

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

E.g. to compile for Linux:
```sh
$ cd godot-cpp
$ scons platform=linux generate_bindings=yes -j8 bits=64 target=release
$ cd ..
$ scons platform=linux -j8 target=release "$@"
$ scons target=template_release platform=linux arch=x86_64 -j8
$ scons target=template_debug platform=linux arch=x86_64 -j8
```

You can use the provided scripts to build for Linux and Windows.

1. `./compile_bindings.sh`
2. `./compile.sh`

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

# Documentation

Expand All @@ -46,6 +43,8 @@ Following nodes exist:

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.
Expand Down
6 changes: 0 additions & 6 deletions compile.sh

This file was deleted.

7 changes: 0 additions & 7 deletions compile_bindings.sh

This file was deleted.

4 changes: 2 additions & 2 deletions demo/addons/ropesim/plugin.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[plugin]

name="Godot Ropesim"
description="Verlet Integration based Rope Simulation for Godot"
description="Fast verlet integration based rope simulation for Godot."
author="Marvin Ewald"
version="1.0.0"
version="1.1.0"
script="plugin.gd"

0 comments on commit 50f5bfa

Please sign in to comment.