Skip to content

Commit

Permalink
Add a few spelling fixes (#159)
Browse files Browse the repository at this point in the history
  • Loading branch information
bschwind authored Jul 4, 2024
1 parent f8f717a commit 72b6c3d
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,25 @@ Renet is a network library for Server/Client games written in rust. It is focuse
Provides the following features:

- Client/Server connection management
- Message based communication using channels, they can have different garantees:
- ReliableOrdered: garantee of message delivery and order
- ReliableUnordered: garantee of message delivery but not order
- Unreliable: no garantee of message delivery or order
- Packet fragmention and reassembly
- Message based communication using channels, they can have different guarantees:
- ReliableOrdered: guarantee of message delivery and order
- ReliableUnordered: guarantee of message delivery but not order
- Unreliable: no guarantee of message delivery or order
- Packet fragmentation and reassembly
- Authentication and encryption, using [renetcode](https://github.com/lucaspoffo/renet/tree/master/renetcode)
- The transport layer can be customizable. The default transport can be disabled and replaced with a custom one

## Channels

Renet communication is message based, and channels describe how the messages should be delivered.
Channels are unilateral, `ConnectionConfig.client_channels_config` describes the channels that the clients sends to the server, and `ConnectionConfig.server_channels_config` describes the channels that the server sends to the clients.
Channels are unidirectional, `ConnectionConfig.client_channels_config` describes the channels that the clients sends to the server, and `ConnectionConfig.server_channels_config` describes the channels that the server sends to the clients.

Each channel has its own configuration `ChannelConfig`:

```rust
// No garantee of message delivery or order
// No guarantee of message delivery or order
let send_type = SendType::Unreliable;
// Garantee of message delivery and order
// guarantee of message delivery and order
let send_type = SendType::ReliableOrdered {
// If a message is lost, it will be resent after this duration
resend_time: Duration::from_millis(300)
Expand All @@ -50,7 +50,7 @@ let channel_config = ChannelConfig {

## Usage

Renet aims to have a simple API that is easy to integrate with any code base. Pool for new messages at the start of a frame with `update`. Call `send_packets` from the transport layer to send packets to the client/server.
Renet aims to have a simple API that is easy to integrate with any code base. Poll for new messages at the start of a frame with `update`. Call `send_packets` from the transport layer to send packets to the client/server.

### Server

Expand Down
4 changes: 2 additions & 2 deletions renet/src/channel/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use std::time::Duration;

pub(crate) use slice_constructor::SliceConstructor;

/// Delivery garantee of a channel
/// Delivery guarantee of a channel
#[derive(Debug, Clone)]
pub enum SendType {
// Messages can be lost or received out of order.
Expand All @@ -32,7 +32,7 @@ pub struct ChannelConfig {
/// Unreliable channels will drop new messages when this value is reached.
/// Reliable channels will cause a disconnect when this value is reached.
pub max_memory_usage_bytes: usize,
/// Delivery garantee of the channel.
/// Delivery guarantee of the channel.
pub send_type: SendType,
}

Expand Down

0 comments on commit 72b6c3d

Please sign in to comment.