comments and starting docs overhaul

Author: ffrostfall

dev/shared/testPackets.luau

@@ -3,14 +3,16 @@ local ReplicatedStorage = game:GetService("ReplicatedStorage")
 local ByteNet = require(ReplicatedStorage.Packages.ByteNet)
 --
 return ByteNet.defineNamespace("game", function()
+	local myStruct = ByteNet.struct({
+		a = ByteNet.uint8,
+		b = ByteNet.uint16,
+		c = ByteNet.string,
+		d = ByteNet.float32,
+	})
+
 	return {
 		myPacket = ByteNet.definePacket({
-			value = ByteNet.array(ByteNet.struct({
-				a = ByteNet.uint8,
-				b = ByteNet.uint16,
-				c = ByteNet.string,
-				d = ByteNet.float32,
-			})),
+			value = ByteNet.array(myStruct),
 		}),
 	}
 end)

docs/css/code.css

@@ -0,0 +1,8 @@
+:root {
+	--docs-black: #04080f;
+	--docs-blue: #456990;
+	--docs-lightblue: #b9d6f2;
+	--docs-pink: #f4a5ae;
+	--docs-pastelpink: #d999b9;
+	--docs-white: #f5f5f5;
+}

docs/css/colors.css

@@ -38,6 +38,7 @@ theme:
 extra_css:
   - assets/colors.css
   - assets/home.css
+  - css/colors.css
 
 markdown_extensions:
   - pymdownx.highlight:

docs/css/homepage.css

@@ -1 +1 @@
-{"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":"struct","className":"ModuleScript","filePaths":["src\\dataTypes\\struct.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":"namespaces","className":"Folder","children":[{"name":"namespace","className":"ModuleScript","filePaths":["src\\namespaces\\namespace.luau"]},{"name":"namespacesDependencies","className":"ModuleScript","filePaths":["src\\namespaces\\namespacesDependencies.luau"]},{"name":"packetIDs","className":"ModuleScript","filePaths":["src\\namespaces\\packetIDs.luau"]}]},{"name":"packets","className":"Folder","children":[{"name":"packet","className":"ModuleScript","filePaths":["src\\packets\\packet.luau"]},{"name":"definePacket","className":"ModuleScript","filePaths":["src\\packets\\definePacket.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":"replicated","className":"Folder","children":[{"name":"replicatedValue","className":"ModuleScript","filePaths":["src\\replicated\\replicatedValue.luau"]},{"name":"values","className":"ModuleScript","filePaths":["src\\replicated\\values.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":"struct","className":"ModuleScript","filePaths":["src\\dataTypes\\struct.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":"namespaces","className":"Folder","children":[{"name":"namespace","className":"ModuleScript","filePaths":["src\\namespaces\\namespace.luau"]},{"name":"namespacesDependencies","className":"ModuleScript","filePaths":["src\\namespaces\\namespacesDependencies.luau"]},{"name":"packetIDs","className":"ModuleScript","filePaths":["src\\namespaces\\packetIDs.luau"]}]},{"name":"packets","className":"Folder","children":[{"name":"definePacket","className":"ModuleScript","filePaths":["src\\packets\\definePacket.luau"]},{"name":"packet","className":"ModuleScript","filePaths":["src\\packets\\packet.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":"replicated","className":"Folder","children":[{"name":"replicatedValue","className":"ModuleScript","filePaths":["src\\replicated\\replicatedValue.luau"]},{"name":"values","className":"ModuleScript","filePaths":["src\\replicated\\values.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"]}]}]}]}

mkdocs.yml

@@ -13,23 +13,44 @@ type structData = {
 return function(input: {
 	[string]: types.dataTypeInterface<any>,
 }): types.dataTypeInterface<any>
+	-- This is used in the reading/writing parts, and isn't used in the initialization code
+	-- It's used to store the index-value pairs and the index-key pairs
+	-- Index being the position of the value in the array, and the key being the key in the struct dictionary
 	local indexValueTypePairs: {
 		[number]: types.dataTypeInterface<any>,
 	} = {}
 	local indexKeyPairs: { [number]: string } = {}
 
+	--[[
+		Array should look like {
+			[index (1)] = value
+			[index (2)] = value
+		}
+
+		Index value type is {
+			[index (1)] = int32
+		}
+
+		Index key is {
+			[index (1)] = "structField"
+		}
+	]]
+
 	if runContext == "server" then
 		local serializedStruct = {}
 
+		-- Convert the struct to an array
 		local count = 0
 		for key in input do
 			count += 1
 			serializedStruct[key] = count
 
+			-- Store the index-value pairs and the index-key pairs as a shortcut for serializing n all that
 			indexValueTypePairs[count] = input[key]
 			indexKeyPairs[count] = key
 		end
 
+		-- replicate
 		namespacesDependencies.add(serializedStruct)
 	elseif runContext == "client" then
 		-- There's a layer of complexity added here because we have to access the namespace data
@@ -40,8 +61,10 @@ return function(input: {
 		local namespaceReplicator = values.access(name)
 		local namespaceData = namespaceReplicator:read() :: types.namespaceData
 
+		-- struct id is just based on the order of creation in the namespace function
 		local structData = namespaceData.structs[namespacesDependencies.currentLength()]
 
+		-- Fetch the data from the server and store it in the index-value pairs and the index-key pairs
 		for key, index in structData do
 			indexValueTypePairs[index] = input[key]
 			indexKeyPairs[index] = key

sourcemap.json

@@ -45,6 +45,8 @@ return function(
 
 		namespaceReplicator:write(constructedNamespace)
 	elseif runContext == "client" then
+		-- yes, this means that packets technically don't need to be defined on the client
+		-- we do it anyway for typechecking and perf shortcuts
 		local namespaceData = namespaceReplicator:read() :: types.namespaceData
 
 		for key, packet in packets do

src/dataTypes/struct.luau

@@ -1,3 +1,7 @@
+--[[
+	Basic dependency graph for structs created within a namespace
+]]
+
 local current: { [number]: any }?
 local currentName: string
 

src/namespaces/namespace.luau

@@ -1,3 +1,6 @@
+--[[
+	Exists solely to get a packet instance from an ID in the reader file
+]]
 local dict = {}
 
 local packetIDs = {}