Skip to content

Commit

Permalink
Update project for ownership transfer to godotengine
Browse files Browse the repository at this point in the history
Cleans up the README by removing funding links and checkout godot-cpp 4.1 branch
  • Loading branch information
paddy-exe committed Aug 4, 2023
1 parent 4c7bfd6 commit f2eb58f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 25 deletions.
31 changes: 7 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,11 @@
# GDExtension-Summator
<div id="badges" align="center">
<a href="https://ko-fi.com/flamelizard">
<img src="https://img.shields.io/badge/Support my work-red?style=for-the-badge&logo=kofi&logoColor=white" alt="Ko-Fi Badge"/>
</a>
<a href="https://twitter.com/patrick_exe">
<img src="https://img.shields.io/badge/Twitter-blue?style=for-the-badge&logo=twitter&logoColor=white" alt="Twitter Badge"/>
</a>
<a href="https://mastodon.gamedev.place/@flamelizard">
<img src="https://img.shields.io/badge/Mastodon-purple?style=for-the-badge&logo=mastodon&logoColor=white" alt="Mastodon Badge"/>
</a>
</div>

This repository is for showcasing the new GDExtension system in Godot 4.

This repository is for showcasing the GDExtension system in Godot 4.
The C++ code is from the [Custom modules example](https://docs.godotengine.org/en/latest/development/cpp/custom_modules_in_cpp.html "Click to get to the docs") of the Godot docs.

----> **Feel free to use this repository as a template for your GDExtensions**
----> **Feel free to use this repository as a template to get started with your GDExtension development by clicking the green "Use this template" button.**

## :tada: Using the extension
## 🎉 Using the extension
After compiling the extension successfully, you can now use the Summator Class inside Godot
```gdscript
func _ready() -> void:
Expand All @@ -36,17 +25,12 @@ If you can't compile the extension, please open an issue.
The releases are structured as ``GODOT_VERSION-EXTENSION_VERSION`` to clarify which version to use for which Godot version.

## ❓ What? How? Why?
If you are not sure what each file in this project does or if you want to know in detail: I wrote a blog post about the purpose of each file on [my Ko-Fi page](https://ko-fi.com/post/GDExtension--Godot-SUPERCHARGED--How-to-get-star-Z8Z4GLUSE).
If you are not sure what each file in this project does or if you want to know in detail you can refer to the [official documentation](https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/index.html)

## Alternative templates
If you want to work with the latest master and godot-cpp version, check out this [GDExtension template by Nathan Franke](https://github.com/nathanfranke/gdextension).
If you are more used to CMake than Scons you can use [this template here by asmalone](https://github.com/asmaloney/GDExtensionTemplate)

## ℹ️ Contributing
If you can't compile the extension, please open an issue with the error log in your terminal and/or the error log in the editor (if you can't run the example scene).

PRs for improvements are very welcome!

## ⚙️ Building the extension

### VSCode Compilation (only applicable if you are using VSCode as your code editor)
Expand All @@ -64,14 +48,13 @@ To compile the extension you need to follow these steps:
1. Clone the extension recursively from this repository
```bash
# The git adress can be found under the green "Code" dropdown menu
git clone (--GITHUB ADRESS--) # --recursive to automatically load the submodule godot-cpp
git clone (--GITHUB ADRESS--) # --recursive-submodules to automatically load the submodule godot-cpp
```

2. Make sure you are on the right commit of the godot-cpp repository
```bash
git status # this show's you the commit. Make sure that it has the correct commit for the release you are targeting
git status # this show's you the commit/branch. Make sure that it has the correct commit for the release you are targeting
```
To make sure you have the right commit, here the [link to the pinned updated issue with the commit hashes](https://github.com/godotengine/godot-cpp/issues/874)

3. Make sure you are in the top level of the repository so `pwd` returns the following
```bash
Expand Down
2 changes: 1 addition & 1 deletion godot-cpp

0 comments on commit f2eb58f

Please sign in to comment.