Skip to content

Commit f6363f0

Browse files
committed
Update readme
1 parent 2d8a756 commit f6363f0

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,14 @@
44
<img alt="netfox banner" src="./docs/assets/press-kit/netfox-banner-hor-alt.svg.preview.png">
55
</picture>
66

7-
# 🦊⚡ netfox boost
7+
# 🦊⚡ netfox boost `custom`
88

99
This addon is an addon for implementing rollback netcode in Godot. This is based on the [netfox](https://github.com/foxssake/netfox), and it uses a GDExtension that boosts the performance by running core functionality in C++. This project aims to be a drop-in replacement for the original netfox addon.
1010

11+
> [!Important]
12+
>
13+
> This is the `custom` version of netfox boost, which may contain breaking API changes with netfox.
14+
1115
## Installation
1216

1317
Download the `netfox-boost` zip from the latest [GitHub action](https://github.com/Atlinx/netfox-boost/actions) or from the [Releases](https://github.com/Atlinx/netfox-boost/releases) page. Extract the contents and add them to the `res://addons/` directory of your project.

demo

Submodule demo updated 1 file

0 commit comments

Comments
 (0)