Proper notes & some cleanup and fixes

Author: ffrostfall

CHANGELOG.md

@@ -6,8 +6,14 @@ This project uses [semantic versioning](https://semver.org/spec/v2.0.0.html).
 
 ## version 0.3.0
 
+### Added
+- Types: Vector2, CFrame, Array, Optional, Map
+
 ### Improvements
 - Rewrote client/server processing. Should drastically improve stability and performance.
+- Completely re-did how serialization happens to be a lot more stable, and to allow a lot of room for improvement.
+- Many type improvements
+- Removed only dependency
 
 ---
 

dev.project.json

@@ -5,8 +5,7 @@
 
 		"ReplicatedStorage": {
 			"Packages": {
-				"$path": "Packages",
-				
+				"$className": "Folder",
 				"ByteNet": {
 					"$path": "src"
 				}

docs/index.md

@@ -10,8 +10,8 @@
 		In ByteNet, you don't need to worry about type validation, optimization, packet structure, etc. ByteNet does all the hard parts for you! Strictly typed with an incredibly basic API that explains itself, ByteNet makes networking simple, easy, and quick.
 	</p>
 	<span id="linkspan">
-		<a href="" id="link">Getting started</a>
-		<a href="" id="link">Download</a>
+		<a href="./api/functions/definePacket" id="link">Getting started</a>
+		<a href="https://github.com/ffrostflame/ByteNet/releases/latest" id="link">Download</a>
 	</span>
 	<hr />
 	<p>

sourcemap.json

@@ -1 +1 @@
-{"name":"bytenet-dev","className":"DataModel","filePaths":["dev.project.json"],"children":[{"name":"ReplicatedStorage","className":"ReplicatedStorage","children":[{"name":"Packages","className":"Folder","children":[{"name":"TableKit","className":"ModuleScript","filePaths":["Packages\\TableKit.lua"]},{"name":"_Index","className":"Folder","children":[{"name":"ffrostflame_tablekit@0.2.4","className":"Folder","children":[{"name":"tablekit","className":"ModuleScript","filePaths":["Packages\\_Index\\ffrostflame_tablekit@0.2.4\\tablekit\\src\\init.luau","Packages\\_Index\\ffrostflame_tablekit@0.2.4\\tablekit\\default.project.json"]}]},{"name":"ffrostflame_wally-instance-manager@0.1.0","className":"Folder","children":[{"name":"wally-instance-manager","className":"ModuleScript","filePaths":["Packages\\_Index\\ffrostflame_wally-instance-manager@0.1.0\\wally-instance-manager\\src\\init.luau","Packages\\_Index\\ffrostflame_wally-instance-manager@0.1.0\\wally-instance-manager\\default.project.json"]}]}]},{"name":"wallyInstanceManager","className":"ModuleScript","filePaths":["Packages\\wallyInstanceManager.lua"]},{"name":"ByteNet","className":"ModuleScript","filePaths":["src\\init.luau"],"children":[{"name":"dataTypes","className":"Folder","children":[{"name":"array","className":"ModuleScript","filePaths":["src\\dataTypes\\array.luau"]},{"name":"bool","className":"ModuleScript","filePaths":["src\\dataTypes\\bool.luau"]},{"name":"buff","className":"ModuleScript","filePaths":["src\\dataTypes\\buff.luau"]},{"name":"cframe","className":"ModuleScript","filePaths":["src\\dataTypes\\cframe.luau"]},{"name":"float32","className":"ModuleScript","filePaths":["src\\dataTypes\\float32.luau"]},{"name":"float64","className":"ModuleScript","filePaths":["src\\dataTypes\\float64.luau"]},{"name":"int16","className":"ModuleScript","filePaths":["src\\dataTypes\\int16.luau"]},{"name":"int32","className":"ModuleScript","filePaths":["src\\dataTypes\\int32.luau"]},{"name":"int8","className":"ModuleScript","filePaths":["src\\dataTypes\\int8.luau"]},{"name":"map","className":"ModuleScript","filePaths":["src\\dataTypes\\map.luau"]},{"name":"optional","className":"ModuleScript","filePaths":["src\\dataTypes\\optional.luau"]},{"name":"string","className":"ModuleScript","filePaths":["src\\dataTypes\\string.luau"]},{"name":"uint16","className":"ModuleScript","filePaths":["src\\dataTypes\\uint16.luau"]},{"name":"uint32","className":"ModuleScript","filePaths":["src\\dataTypes\\uint32.luau"]},{"name":"uint8","className":"ModuleScript","filePaths":["src\\dataTypes\\uint8.luau"]},{"name":"vec2","className":"ModuleScript","filePaths":["src\\dataTypes\\vec2.luau"]},{"name":"vec3","className":"ModuleScript","filePaths":["src\\dataTypes\\vec3.luau"]}]},{"name":"packets","className":"Folder","children":[{"name":"clientPacketIDs","className":"ModuleScript","filePaths":["src\\packets\\clientPacketIDs.luau"]},{"name":"packet","className":"ModuleScript","filePaths":["src\\packets\\packet.luau"]},{"name":"serverPacketIDs","className":"ModuleScript","filePaths":["src\\packets\\serverPacketIDs.luau"]}]},{"name":"process","className":"Folder","children":[{"name":"bufferWriter","className":"ModuleScript","filePaths":["src\\process\\bufferWriter.luau"]},{"name":"client","className":"ModuleScript","filePaths":["src\\process\\client.luau"]},{"name":"read","className":"ModuleScript","filePaths":["src\\process\\read.luau"]},{"name":"server","className":"ModuleScript","filePaths":["src\\process\\server.luau"]}]},{"name":"types","className":"ModuleScript","filePaths":["src\\types.luau"]}]}]},{"name":"shared","className":"Folder","children":[{"name":"testPackets","className":"ModuleScript","filePaths":["dev/shared\\testPackets.luau"]}]}]},{"name":"ServerScriptService","className":"ServerScriptService","children":[{"name":"server","className":"Folder","children":[{"name":"serverTests","className":"Script","filePaths":["dev/server\\serverTests.server.luau"]}]}]},{"name":"StarterPlayer","className":"StarterPlayer","children":[{"name":"StarterPlayerScripts","className":"StarterPlayerScripts","children":[{"name":"clientTests","className":"LocalScript","filePaths":["dev/client\\clientTests.client.luau"]}]}]}]}
+{"name":"bytenet-dev","className":"DataModel","filePaths":["dev.project.json"],"children":[{"name":"ReplicatedStorage","className":"ReplicatedStorage","children":[{"name":"Packages","className":"Folder","children":[{"name":"ByteNet","className":"ModuleScript","filePaths":["src\\init.luau"],"children":[{"name":"dataTypes","className":"Folder","children":[{"name":"array","className":"ModuleScript","filePaths":["src\\dataTypes\\array.luau"]},{"name":"bool","className":"ModuleScript","filePaths":["src\\dataTypes\\bool.luau"]},{"name":"buff","className":"ModuleScript","filePaths":["src\\dataTypes\\buff.luau"]},{"name":"cframe","className":"ModuleScript","filePaths":["src\\dataTypes\\cframe.luau"]},{"name":"float32","className":"ModuleScript","filePaths":["src\\dataTypes\\float32.luau"]},{"name":"float64","className":"ModuleScript","filePaths":["src\\dataTypes\\float64.luau"]},{"name":"int16","className":"ModuleScript","filePaths":["src\\dataTypes\\int16.luau"]},{"name":"int32","className":"ModuleScript","filePaths":["src\\dataTypes\\int32.luau"]},{"name":"int8","className":"ModuleScript","filePaths":["src\\dataTypes\\int8.luau"]},{"name":"map","className":"ModuleScript","filePaths":["src\\dataTypes\\map.luau"]},{"name":"optional","className":"ModuleScript","filePaths":["src\\dataTypes\\optional.luau"]},{"name":"string","className":"ModuleScript","filePaths":["src\\dataTypes\\string.luau"]},{"name":"uint16","className":"ModuleScript","filePaths":["src\\dataTypes\\uint16.luau"]},{"name":"uint32","className":"ModuleScript","filePaths":["src\\dataTypes\\uint32.luau"]},{"name":"uint8","className":"ModuleScript","filePaths":["src\\dataTypes\\uint8.luau"]},{"name":"vec2","className":"ModuleScript","filePaths":["src\\dataTypes\\vec2.luau"]},{"name":"vec3","className":"ModuleScript","filePaths":["src\\dataTypes\\vec3.luau"]}]},{"name":"packets","className":"Folder","children":[{"name":"clientPacketIDs","className":"ModuleScript","filePaths":["src\\packets\\clientPacketIDs.luau"]},{"name":"packet","className":"ModuleScript","filePaths":["src\\packets\\packet.luau"]},{"name":"serverPacketIDs","className":"ModuleScript","filePaths":["src\\packets\\serverPacketIDs.luau"]}]},{"name":"process","className":"Folder","children":[{"name":"bufferWriter","className":"ModuleScript","filePaths":["src\\process\\bufferWriter.luau"]},{"name":"client","className":"ModuleScript","filePaths":["src\\process\\client.luau"]},{"name":"read","className":"ModuleScript","filePaths":["src\\process\\read.luau"]},{"name":"server","className":"ModuleScript","filePaths":["src\\process\\server.luau"]}]},{"name":"types","className":"ModuleScript","filePaths":["src\\types.luau"]}]}]},{"name":"shared","className":"Folder","children":[{"name":"testPackets","className":"ModuleScript","filePaths":["dev/shared\\testPackets.luau"]}]}]},{"name":"ServerScriptService","className":"ServerScriptService","children":[{"name":"server","className":"Folder","children":[{"name":"serverTests","className":"Script","filePaths":["dev/server\\serverTests.server.luau"]}]}]},{"name":"StarterPlayer","className":"StarterPlayer","children":[{"name":"StarterPlayerScripts","className":"StarterPlayerScripts","children":[{"name":"clientTests","className":"LocalScript","filePaths":["dev/client\\clientTests.client.luau"]}]}]}]}

src/process/server.luau

@@ -26,8 +26,11 @@ local jobs = {}
 
 local function load(freshChannel: channelData?)
 	if not freshChannel then
+		-- It's important to note this creates a new channel and creates a new reference
+		-- It is the only way new channels are created
 		cursor = 0
-		jobs = {} -- It's important to note this creates a new channel and creates a new reference
+		-- We assume that there's going to be at least 16 elements in the channel if it exists just to speed things up
+		jobs = table.create(16)
 		bufferWriter.set(jobs)
 		return
 	end
@@ -78,11 +81,11 @@ local function dumpLoadedChannel(): buffer
 	-- iterate over all jobs in increments of 3, and call accordingly
 	for index = 1, #jobs, 3 do
 		-- We have to do this typecasting because luau doesn't have tuple tables yet
-		(jobs[index] :: (b: buffer, cursor: number, value: any) -> ())(
-			dumpBuffer,
-			jobs[index + 1] :: number,
-			jobs[index + 2]
-		)
+		-- It's ugly I know, but it's the only way to get it to work
+		local job, position, value: any =
+			jobs[index] :: (b: buffer, cursor: number, value: any) -> (), jobs[index + 1] :: number, jobs[index + 2]
+
+		job(dumpBuffer, position, value)
 	end
 
 	return dumpBuffer

wally.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ffrostflame/bytenet"
-version = "0.3.0-dev3"
+version = "0.3.0"
 registry = "https://github.com/UpliftGames/wally-index"
 realm = "shared"