v0.5.0

Author: ffrostfall

CHANGELOG.md

@@ -2,6 +2,25 @@
 
 This project uses [semantic versioning](https://semver.org/spec/v2.0.0.html).
 
+## version 0.5.0
+
+### **Added**
+
+- Added `ServerBridge.OnServerInvoke` and `ClientBridge:InvokeServer()`
+- Added `.Connected` to connections
+
+### **Fixes**
+
+- Fixed a bug with `Bridge:Wait`
+
+## **Improvements**
+
+- Refactored the object-oriented programming pattern used w/ Bridges
+- Connections are now their own class
+- Calling methods with `.` instead of `:` will now error
+- Type improvements
+- `tostring()`-ing a bridge will now return its class type
+
 ## [version 0.4.1](https://github.com/ffrostflame/BridgeNet2/releases/tag/v0.4.1): 6/11/2023
 
 ### **Fixes**

README.md

@@ -4,7 +4,7 @@
 
 # BridgeNet2 v0.4.1
 
-A multi-paradigm, blazingly fast & highly equipped networking library for Roblox.
+Blazing fast & opinionated networking library designed to reduce bandwidth.
 
 [Documentation](https://ffrostflame.github.io/BridgeNet2/)
 

docs/Concepts.md

@@ -0,0 +1,3 @@
+---
+sidebar_position: 3
+---

docs/Features.md

@@ -1,26 +1,18 @@
 ---
-sidebar_position: 3
+sidebar_position: 2
 ---
 
 # Installation
 
-## With Wally
+## Through Wally [Recommended]
+
+If you're using Wally, you can simply drop this snippet in, except replace `latest` with the latest BridgeNet2 version.
 
-1. Install [Wally](https://wally.run)
-2. Put BridgeNet2 in the ``wally.toml`` file under ``[dependencies]``
 ```toml title="wally.toml"
 [dependencies]
-BridgeNet2 = ffrostflame/bridgenet2@0.4.0
+BridgeNet2 = "ffrostflame/bridgenet2@latest"
 ```
-3. Run ``wally install``
-
-## Without Wally
 
-## Option 1: Syncing with .rbxm:
-1. Get the ``.rbxm`` file from the latest [release](https://github.com/ffrostflame/BridgeNet2/releases).
-2. Sync manually or drop into studio manually
+## Standalone
 
-## Option 2: copying source folder:
-1. Copy the `src` folder of the repository
-2. Drop into your project
-3. Rename the folder to `BridgeNet2`
+Download `standalone.rbxm` from the [latest release](https://github.com/ffrostflame/BridgeNet2/releases/latest), and then insert it into your Roblox game.

docs/Identifiers.md

@@ -0,0 +1,3 @@
+---
+sidebar_position: 3
+---

docs/Installation.md

@@ -0,0 +1,29 @@
+---
+sidebar_position: 1
+---
+
+# Identifiers
+
+Identifiers are actually extremely simple: it's a shared key-value list. The key is the compressed identifier, the value is the string value. The list is stored as attributes under the BridgeNet2 RemoteEvent. Identifiers are actually just numbers compressed using `string.pack`- every time you create an identifier, it increments that number by one and creates the attribute.
+
+```lua title="/src/Server/ServerIdentifiers.luau" showLineNumbers
+-- optimization for under 255 identifiers
+local packed = if identifierCount <= 255
+	then string.pack("B", identifierCount)
+	else string.pack("H", identifierCount)
+
+identifierCount += 1
+identifierStorage:SetAttribute(identifierName, packed)
+
+fullIdentifierMap[identifierName] = packed
+compressedIdentifierMap[packed] = identifierName
+```
+
+On the client, the client listens for new attributes added and attribute changes. It then stores these identifiers locally- the `Serialize` and `Deserialize` functions just directly interface with that table. This is why the `ReferenceIdentifier` function yields- it basically just waits a bit to see if the attribute loads in. If it already exists, it just accesses that in the local table.
+
+```lua title="/src/Client/ClientIdentifiers.luau" {2-3} showLineNumbers
+for id, value in identifierStorage:GetAttributes() do
+	fullIdentifierMap[id] = value
+	compressedIdentifierMap[value] = id
+end
+```

docs/Technical Details.md

@@ -0,0 +1,3 @@
+---
+sidebar_position: 2
+---