netfox

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 1,069)

Addons for building multiplayer games with Godot

netfox Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![License](https://img.shields.io/github/license/foxssake/netfox)](https://github.com/foxssake/netfox/blob/main/LICENSE)
[![GitHub Release](https://img.shields.io/github/v/release/foxssake/netfox)](https://github.com/foxssake/netfox/releases)
[![Documentation](https://img.shields.io/badge/Docs-github.io-blue)](https://foxssake.github.io/netfox/)
[![Netfox Sharp](https://img.shields.io/badge/View-Netfox_Sharp-orange)](https://github.com/CyFurStudios/NetfoxSharp)
[![Discord](https://img.shields.io/discord/1253434107656933447?logo=discord&label=Discord)](https://discord.gg/xWGh4GskG5)
[![ko-fi](https://img.shields.io/badge/Support%20on-ko--fi-ff5e5b?logo=ko-fi)](https://ko-fi.com/T6T8WZD0W)

A set of addons for responsive online games with the [Godot engine].

## Features

* ⏲️  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

## Overview

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*
* [netfox.internals]
  * Shared utilities for the other addons
  * Included as dependency, no need to install separately

## C# Support
For experimental C# support, see the [Netfox Sharp repo], and the corresponding
[Netfox Sharp guide].

## Install

### Releases

Find the latest netfox under
[Releases](https://github.com/foxssake/netfox/releases)

Each release contains the addons, and a build of [Forest Brawl] for Windows and
Linux. Each addon has its dependencies packed with it - e.g.
*"netfox.extras.vx.y.z.zip"* also contains both *netfox* and
*netfox.internals*.

> Note: For releases before v1.1.1, a separate *".with-deps.zip"* version
> contains the addon and its dependencies, while the regular zips contain only
> the addon itself.

### Asset Library

Search for the addon name in Godot's AssetLib or download from the site:

* [netfox](https://godotengine.org/asset-library/asset/2375)
* [netfox.noray](https://godotengine.org/asset-library/asset/2376)
* [netfox.extras](https://godotengine.org/asset-library/asset/2377)

### Source

Download the [source] and copy the addons of your choice to your Godot project.

### Enable the addons

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.

## Upgrading

If you're upgrading from an older version of netfox, refer to the [upgrade
guide](docs/upgrading.md).

## Usage

See the [docs](https://foxssake.github.io/netfox/).

### Supported versions

Godot 4.x is supported by netfox. If you find any issue using any supported
version, please [open an issue].

Forest Brawl and the other examples are written against Godot 4.1. They may or
may not work when opened with any other version.

### Prototyping

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.

### Examples

#### Comparison sample

* [Single player](examples/single-player)
* [Simple example](examples/multiplayer-simple)
* [Example with netfox](examples/multiplayer-netfox)

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.

#### Feature examples

Each of these examples give a starting point to a specific feature:

* [Input gathering](examples/input-gathering)
* [State machines](examples/multiplayer-state-machine)
* [Multiplayer FPS](examples/multiplayer-fps)
* [Rollback Debugger](examples/rollback-debugger)
* [Property Configuration](examples/property-configuration)
* [Input prediction](examples/input-prediction)
* [NPCs with rollback](examples/rollback-npc)
* [NPCs with StateSynchronizer](examples/state-synchronizer-npc)
* [Visibility filtering](examples/visibility-filtering)

#### Example games

##### Forest Brawl

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.

##### Godot Rocket League

Play soccer with cars, in Godot, with [Godot Rocket League](https://github.com/albertok/godot-rocket-league)!

Demonstrates *netfox*'s physics rollback capabilities, ensuring smooth and
responsive physics-based gameplay.

## Built with netfox

Games built with netfox, coming to a Steam near you! See the more on the site's
[Made with netfox](https://foxssake.github.io/netfox/latest/made-with-netfox/)
page!

![Bubble Battle](https://raw.githubusercontent.com/foxssake/netfox/main/docs/assets/showcase/bubble-battle.jpg)

</a>

![PL4no-B](https://raw.githubusercontent.com/foxssake/netfox/main/docs/assets/showcase/pl4nob.jpg)

</a>

![Chrome Carnage](https://raw.githubusercontent.com/foxssake/netfox/main/docs/assets/showcase/chrome-carnage.jpg)

</a>

![Nitro Turtles](https://raw.githubusercontent.com/foxssake/netfox/main/docs/assets/showcase/nitro-turtles.jpg)

</a>

![Kick and Hide](https://raw.githubusercontent.com/foxssake/netfox/main/docs/assets/showcase/kick-and-hide.jpg)

</a>

Building something cool with netfox? Whether it's released or in progress, feel
free to open a PR, adding your game to the list!

## License

netfox is under the [MIT license](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.

## Issues

In case of any issues, comments, or questions, please feel free to [open an issue]!

## Contribution

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

## Funding

If you've found netfox useful, feel free to fund us on ko-fi:

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/T6T8WZD0W)

Donations are always appreciated and taken as gratitude for the work that has
already been done.

If you'd like to fund a specific feature or development, please contact us in [email].

[Netfox Sharp repo]: https://github.com/CyFurStudios/NetfoxSharp
[Netfox Sharp guide]: https://foxssake.github.io/netfox/latest/netfox/guides/netfox-sharp/

[source]: https://github.com/foxssake/netfox/archive/refs/heads/main.zip
[Godot engine]: https://godotengine.org/
[noray]: https://github.com/foxssake/noray

[netfox]: addons/netfox
[netfox.noray]: addons/netfox.noray
[netfox.extras]: addons/netfox.extras
[netfox.internals]: addons/netfox.internals
[Forest Brawl]: examples/forest-brawl

[open an issue]: https://github.com/foxssake/netfox/issues
[GDScript style guide]: https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_styleguide.html

[email]: mailto:foxssake@gmail.com?subject=netfox

netfox

netfox Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

netfox

netfox Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README