https://github.com/Faless/godot-enet-better

A better ENet module for high performance multiplayer games with godot
https://github.com/Faless/godot-enet-better

Last synced: 6 days ago
JSON representation

A better ENet module for high performance multiplayer games with godot

• Host: GitHub
• URL: https://github.com/Faless/godot-enet-better
• Owner: Faless
• License: mit
• Archived: true
• Created: 2016-10-06T23:22:19.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-08-01T12:03:00.000Z (over 3 years ago)
• Last Synced: 2024-08-02T06:19:32.164Z (3 months ago)
• Language: C++
• Size: 580 KB
• Stars: 93
• Watchers: 6
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-godot - godot-enet-better - A better ENet module for high-performance multiplayer games with Godot. (Modules / 3D)

README

        
# About

The `benet` module for Godot is a fork of `NetworkedMultiplayerPacketPeer` (although it stays compatible) to allow access to multiple channels and the ability to run multiple clients/servers in the same scene.

The module is composed by two parts:

- `ENetPacketPeer`: The fork of `NetworkedMultiplayerPacketPeer`

  - `create_server`: Add parameter to specify max channels (default 1)

  - `create_client`: Add parameter to specify max channels (default 1)

  - `put_packet_channel`: New method, allow to put a packet in the specified channel

  - `send` (`_unreliable`, `_ordered`) allow to send to specific client in reliable, unreliable, ordered way whlie selecting the channel

  - `broadcast` (`_unreliable`, `_ordered`) allow to broadcast a packet in a reliable, unreliable, ordered way while selecting the channel

- `ENetNode`: Act like `SceneTree`:

  - Poll on idle/fixed time (must be in tree to work!)

  - Emit signals on idle/fixed time (must be in tree to work!)

  - Emit additional `server_packet` and `client_packet` signals when receiving packets

  - Allow kicking clients by unique id.

  - Will hopefully support RPC in the future

# Installation

Being a module you will need to recompile godot from source. To do that:

1. Clone the godot engine repository

2. Copy the `benet` folder from this repository into the godot `modules` folder

3. Recompile godot (see http://docs.godotengine.org/en/latest/reference/_compiling.html )

# Usage

For usage examples please refer to the project in the `demo` folder.

The methods should be self explainatory. 

# Disclaimer

> THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.