Skip to content

Commit 59d19b5

Browse files
committedFeb 28, 2024
update readme
1 parent 2e6f07a commit 59d19b5

File tree

1 file changed

+5
-20
lines changed

1 file changed

+5
-20
lines changed
 

‎README.md

+5-20
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,7 @@
1-
# godot-cpp template
2-
This repository serves as a quickstart template for GDExtension development with Godot 4.0+.
1+
<div style="display: flex; align-items: center; gap: 2rem;"><img width="100" src="/godot/addons/godot-llama-cpp/assets/godot-llama-cpp-1024x1024.svg"><h1>godot-llama-cpp</h1></div>
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 to publish your library packages when creating a release (`.github/workflows/builds.yml`)
9-
* preconfigured source files for C++ development of the GDExtension (`src/`)
3+
![Godot v4.2](https://img.shields.io/badge/Godot-v4.2-%23478cbf?logo=godot-engine&logoColor=white&style=flat-square)
4+
![GitHub release (latest by date)](https://img.shields.io/github/v/release/hazelnutcloud/godot-llama-cpp)
5+
[![LICENSE](https://img.shields.io/github/license/hazelnutcloud/godot-llama-cpp)](https://github.com/hazelnutcloud/godot-llama-cpp/blob/main/LICENSE.md)
106

11-
## Usage
12-
To use this template, log in to github and click the green "Use this template" button at the top of the repository page.
13-
This will let you create a copy of this repository with a clean git history. Make sure you clone the correct branch as these are configured for development of their respective Godot development branches and differ from each other. Refer to the docs to see what changed between the versions.
14-
15-
For getting started after cloning your own copy to your local machine, you should:
16-
* initialize the godot-cpp git submodule via `git submodule update --init`
17-
* change the name of your library
18-
* change the name of the compiled library file inside the `SConstruct` file by modifying the `libname` string.
19-
* change the pathnames of the to be loaded library name inside the `demo/bin/example.gdextension` file. By replacing `libgdexample` to the name specified in your `SConstruct` file.
20-
* change the name of the `demo/bin/example.gdextension` file
21-
* 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.
22-
* 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 `ClassDB::register_class<CLASS-NAME>();`.
7+
Run large language models in [Godot](https://godotengine.org). Powered by [llama.cpp](https://github.com/ggerganov/llama.cpp).

0 commit comments

Comments
 (0)