Repo cleanup, nothing, unknown, and instance.

Author: ffrostfall

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,6 @@
+---
+name: Report a bug
+about: Report any issues with ByteNet
+title: ''
+labels: 'type: bug'
+---

.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,6 @@
+---
+name: Suggest a feature
+about: Request for a feature to be added to ByteNet
+title: ''
+labels: 'type: feature request'
+---

.github/ISSUE_TEMPLATE/improvement.md

@@ -0,0 +1,6 @@
+---
+name: Suggest an improvement
+about: Request for an improvement (Optimization, docs, API change, etc.) for ByteNet
+title: ''
+labels: 'type: enhancement'
+---

CHANGELOG.md

@@ -1,31 +1,36 @@
-# ByteNet
+# ByteNet Changelog
 
-This project uses [semantic versioning](https://semver.org/spec/v2.0.0.html).
+ByteNet uses [semantic versioning](https://semver.org/spec/v2.0.0.html).
 
 ---
 
-## version 0.4.0
+## 0.4.0-rc3
 
 ### Added
 - Namespaces have been added.
 - Structs have been added.
+- Three new data types: Instance, unknown, and nothing. The "nothing" type is to allow for packets without any contents.
+- Added `:wait()` to packets.
 
 ### Improvements
 - Packets are now based off closures, instead of metatables. This means you now have to use `.` indexxing instead of `:` to call methods.
 - You can now have duplicate packet contents
 - Packets now take a single value (Which can be a struct) instead of being "special".
-- Significant optimization
+- Significant optimization: Packets are now singular values that can be structs, which reduces complexity, thus increasing performance.
+
+### Fixes
+- Added `:sendTo()` to the `Packet` type. This fixes autocomplete.
 
 ---
 
-## version 0.3.1
+## 0.3.1
 
 ### Improvements
 - Rewrote serialization to use an allocator w/ resizing instead of using "deferred write" functions. Should be an incredibly large performance boost.
 
 ---
 
-## version 0.3.0
+## 0.3.0
 
 ### Added
 - Types: Vector2, CFrame, Array, Optional, Map
@@ -38,15 +43,15 @@ This project uses [semantic versioning](https://semver.org/spec/v2.0.0.html).
 
 ---
 
-## version 0.2.1
+## 0.2.1
 
 ### Fixes
 
 - Fixed absolute reference that broke the package. oops.
 
 ---
 
-## version 0.2.0
+## 0.2.0
 
 ### Added
 
@@ -65,15 +70,15 @@ This project uses [semantic versioning](https://semver.org/spec/v2.0.0.html).
 
 ---
 
-## version 0.1.3
+## 0.1.3
 
 ### Fixes
 
 - Fixed not all data types having types
 
 ---
 
-## version 0.1.2
+## 0.1.2
 
 ### Fixes
 
@@ -82,7 +87,7 @@ This project uses [semantic versioning](https://semver.org/spec/v2.0.0.html).
 
 ---
 
-## version 0.1.1
+## 0.1.1
 
 ### Improvements
 
@@ -95,4 +100,4 @@ This project uses [semantic versioning](https://semver.org/spec/v2.0.0.html).
 
 ---
 
-## version 0.1.0 (Release)
+## 0.1.0 (Release)

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing to ByteNet
+
+---
+
+# Tooling
+Ensure you have Aftman installed. After, run `aftman install` to fetch all the required tooling.
+
+## Extensions
+- Luau LSP
+- Selene
+- Rojo
+- StyLua
+
+---
+
+# Testing
+Use `dev.project.json`, and to test new features, just alter the code in that directory.
+It is hard to use automated testing w/ networking libraries. There will be a better testing solution eventually.

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":"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"]}]}]}]}
+{"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":"nothing","className":"ModuleScript","filePaths":["src\\dataTypes\\nothing.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":"unknown","className":"ModuleScript","filePaths":["src\\dataTypes\\unknown.luau"]},{"name":"inst","className":"ModuleScript","filePaths":["src\\dataTypes\\inst.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"]}]}]}]}

src/dataTypes/README.md

@@ -0,0 +1,42 @@
+This folder contains all of the data types contained within ByteNet. They are all imported manually in `src/init.luau`.
+
+Each data type follows the `dataTypeInterface` type. Static types (That don't need any parameters) should generally have the following template:
+```lua
+local dataTypeName = {
+	read = function(b: buffer, cursor: number)
+		return value, length
+	end,
+
+	write = function(value)
+		-- Allocate the data here
+		alloc()
+
+		-- write the value here
+	end,
+}
+
+return function(): dataTypeInterface<type>
+	return dataTypeName
+end
+```
+
+Dynamic data types are a little more performance-costly. They should follow the following format:
+```lua
+return function(parameter): dataTypeInterface<type>
+	return {
+		-- Same as static types here
+	}
+end
+```
+
+You will notice that this results in closure duping. This is necessary memory overhead, and while unfortunate, it doesn't actually cost that much. The speed benefits are far greater.
+
+When a data type requires another data type as a parameter, the `read` and `write` functions should be localized like so:
+```lua
+return function(parameterDataType: dataTypeInterface<any>): dataTypeInterface<type>
+	local write = parameterDataType.write
+	local read = parameterDataType.read
+end
+```
+
+While this is a micro optimization, it also helps for readability, so it is generally worth it.

src/dataTypes/bool.luau

@@ -15,6 +15,7 @@ local bool = {
 	read = function(b: buffer, cursor: number)
 		return buffer.readu8(b, cursor) == 1, 1
 	end,
+
 	write = function(value: boolean)
 		alloc(1)
 

src/dataTypes/inst.luau

@@ -0,0 +1,12 @@
+local types = require(script.Parent.Parent.types)
+
+local nothing = {
+	write = function() end,
+	read = function()
+		return nil, 0
+	end,
+}
+
+return function(): types.dataTypeInterface<nil>
+	return nothing
+end