Skip to content

Commit c9d4798

Browse files
committed
Remove demo
1 parent a6fae76 commit c9d4798

20 files changed

Lines changed: 33 additions & 163 deletions

.vscode/extensions.json

Lines changed: 0 additions & 6 deletions
This file was deleted.

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ cmake_minimum_required(VERSION 3.17)
55
if(CMAKE_C_COMPILER)
66
endif()
77

8-
set(LIBNAME "EXTENSION-NAME" CACHE STRING "The name of the library")
8+
set(LIBNAME "netfox-boost" CACHE STRING "The name of the library")
99
set(GODOT_PROJECT_DIR "demo" CACHE STRING "The directory of a Godot project folder")
1010

1111
# Make sure all the dependencies are satisfied

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
# godot-cpp template
2-
This repository serves as a quickstart template for GDExtension development with Godot 4.0+.
1+
# 🦊⚡ netfox boost
32

4-
## Contents
5-
* An empty Godot project (`demo/`)
6-
* godot-cpp as a submodule (`godot-cpp/`)
7-
* GitHub Issues template (`.github/ISSUE_TEMPLATE.yml`)
8-
* GitHub CI/CD workflows to publish your library packages when creating a release (`.github/workflows/builds.yml`)
9-
* preconfigured source files for C++ development of the GDExtension (`src/`)
10-
* setup to automatically generate `.xml` files in a `doc_classes/` directory to be parsed by Godot as [GDExtension built-in documentation](https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/gdextension_docs_system.html)
3+
This repository contains a GDExtension that boosts the performance of [netfox](https://github.com/foxssake/netfox) by running
4+
repetitive tasks in cpp.
5+
6+
## Installation
7+
8+
Download the latest files from the releases page.
119

1210
## Usage - Template
1311

@@ -23,6 +21,10 @@ For getting started after cloning your own copy to your local machine, you shoul
2321
* change the `entry_symbol` string inside your `demo/bin/your-extension.gdextension` file to be configured for your GDExtension name. This should be the same as the `GDExtensionBool GDE_EXPORT` external C function. As the name suggests, this sets the entry function for your GDExtension to be loaded by the Godot editors C API.
2422
* register the classes you want Godot to interact with inside the `register_types.cpp` file in the initialization method (here `initialize_gdextension_types`) in the syntax `GDREGISTER_CLASS(CLASS-NAME);`.
2523

24+
## Development
25+
26+
After cloning your own copy to your local machine, make sure to initialize the godot-cpp git submodule via `git submodule update --init`.
27+
2628
### Configuring an IDE
2729
You can develop your own extension with any text editor and by invoking scons on the command line, but if you want to work with an IDE (Integrated Development Environment), you can use a compilation database file called `compile_commands.json`. Most IDEs should automatically identify this file, and self-configure appropriately.
2830
To generate the database file, you can run one of the following commands in the project root directory:
@@ -32,9 +34,4 @@ scons compiledb=yes
3234

3335
# Generate compile_commands.json without compiling
3436
scons compiledb=yes compile_commands.json
35-
```
36-
37-
## Usage - Actions
38-
39-
This repository comes with a GitHub action that builds the GDExtension for cross-platform use. It triggers automatically for each pushed change. You can find and edit it in [builds.yml](.github/workflows/builds.yml).
40-
After a workflow run is complete, you can find the file `godot-cpp-template.zip` on the `Actions` tab on GitHub.
37+
```

SConstruct

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import sys
55
from methods import print_error
66

77

8-
libname = "EXTENSION-NAME"
8+
libname = "netfox-boost"
99
projectdir = "demo"
1010

1111
localEnv = Environment(tools=["default"], PLATFORM="")
333 KB
Binary file not shown.

demo/bin/android/.gitkeep

Whitespace-only changes.

demo/bin/example.gdextension

Lines changed: 0 additions & 56 deletions
This file was deleted.

demo/bin/linux/.gitkeep

Whitespace-only changes.

demo/bin/macos/.gitkeep

Whitespace-only changes.

demo/bin/windows/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)