A set of addons for responsive online games with the Godot engine.
- ⏲️ Consistent timing across multiple machines
- 🖥️ Supports client-server architecture
- 🧈 Smooth motion with easy-to-use interpolation
- 💨 Lag compensation with Client-side Prediction and Server-side Reconciliation
- 🛜 Bullet-proof connectivity with noray integration
The package consists of multiple addons, each with different features:
- netfox
- The core package, implements timing, rollback and other multiplayer features
- Start here
- netfox.noray
- Implements noray integration to establish connection between players
- Useful for online games
- netfox.extras
- Provides high-level, game-specific, convenience features built on top of netfox, like base classes for input management or weapons
- Check for reusable components for your game
Find the latest netfox under Releases
Each release contains the addons, and a build of Forest Brawl for Windows and Linux.
In cases of dependencies, a ".with-deps.zip" version is included as well, which contains all the dependencies of the addon. For example, netfox.noray depends on netfox, so "netfox.noray.v1.x.y.with-deps.zip" includes both netfox.noray and netfox.
Search for the addon name in Godot's AssetLib or download from the site:
Download the source and copy the addons of your choice to your Godot project.
After adding netfox to your project, make sure to enable the addons in your project settings. Otherwise, Godot will present you with errors about undeclared identifiers.
See the docs.
To try your game online with noray, a free to use instance is hosted at
tomfol.io:8890, the same instance used by Forest Brawl.
You can use this noray instance to quickly test your games online, but is not recommended for shipping games. The instance has configured limits, and no uptime guarantees are made.
To provide a short intro on how to get started with netfox, and how it fares compared to built-in multiplayer tools, a simple demo was implemented as a single-player game, which was ported to multiplayer using both a naive approach and netfox.
To provide examples of netfox usage in an actual game, Forest Brawl was created and included specifically for this purpose.
It's a party game where an arbitrary amount of players compete by trying to knock eachother off of the map.
netfox is under the MIT license.
Note that the repository contains assets made by other people as well. For these cases, the relevant licenses can be found in the assets' directories.
In case of any issues, comments, or questions, please feel free to open an issue!
Contributions are welcome! Please feel free to fork the repository and open a PR. Ideally, your PR implements a single thing, optionally refers to an existing issue, and follows the GDScript style guide.
Please note that depending on the feature/fix you implement, the PR may need to undergo changes, or in some cases, get rejected if it doesn't fit netfox's intended feature set or vision.
If you feel like it, grant the netfox author(s) write permission to your fork, so we can update the PR if needed.
If you're not sure if the PR would fit netfox or not, open an issue first, mentioning that you'd be willing to contribute a PR.
Author(s) at the time of writing:
- @elementbound