ByteNet provides a large amount of "primitive" types for you to build more complex types that suit your game. Since primitive types don't need any parameters, you can just access them like the following: ByteNet.<typename>. For building more complex data structures, go look at the Specials page.
string: Stringbuff: Bufferbool: Booleannothing: Nothingunknown: Any typecframe: CoordinateFramevec2: Vector2vec3: Vector3inst: InstanceSpecial types always take parameters. You have to call them: ByteNet.<type name>(<any primitive type>).
Danger
-Structs let you send structured data in the form of dictionaries. The fields are optimized away, so they don't take any bandwidth. Structs are how you'll be sending most of your data likely: they are the best for organization, and they let you do really interesting things. For example: +
return ByteNet.defineNamespace("chunks", function()
+ local chunkData = ByteNet.struct({
+ biome = ByteNet.uint8,
+ seed = ByteNet.int32,
+ })
+
+ return {
+ sendChunks = ByteNet.definePacket({
+ value = ByteNet.array(chunkData)
+ })
+ }
+end)
+Optional types are a cool name for the concept of "This doesn't have to exist". It's good for optional parameters: for example if some invoked function were to fail, you might want to send back a blank copy to indicate that something is wrong.
-return {
- myCoolPacket = ByteNet.definePacket({
- structure = {
- -- An "optional" type takes in a parameter.
- -- This can be anything! You can even have optional arrays.
- helloWorldString = ByteNet.optional(ByteNet.string)
-
- -- This works!
- eachCharacter = ByteNet.optional(ByteNet.array(ByteNet.string))
- },
- })
-}
+packets.luaureturn ByteNet.defineNamespace("chunks", function()
+ return {
+ myCoolPacket = ByteNet.definePacket({
+ value = ByteNet.struct({
+ -- An "optional" type takes in a parameter.
+ -- This can be anything! You can even have optional arrays.
+ helloWorldString = ByteNet.optional(ByteNet.string)
+
+ -- This works!
+ eachCharacter = ByteNet.optional(ByteNet.array(ByteNet.string))
+ }),
+ })
+ }
+end)
You really don't have to think about using optional types. You just send it!
-server.luaulocal packets = require(path.to.packets)
-
-local randomlyStringOrNil =
- if math.random(1, 2) == 1 then "Hello, world!" else nil
-
-packets.myCoolPacket:sendToAll({
- helloWorldString = randomlyAppearingString,
-
- -- Note that even if we don't put the "eachCharacter" field here,
- -- it won't error. This is because it's optional!
-})
+server.luaulocal packets = require(path.to.packets)
+
+local randomlyStringOrNil =
+ if math.random(1, 2) == 1 then "Hello, world!" else nil
+
+packets.myCoolPacket.sendToAll({
+ helloWorldString = randomlyAppearingString,
+
+ -- Note that even if we don't put the "eachCharacter" field here,
+ -- it won't error. This is because it's optional!
+})
Arrays
Arrays are fairly self explanatory. They're just plain old arrays. However, it's important to note that mixed tables have undefined behavior when passed as an array. This means things might be missing when they come out on the other side!
There is a 2 byte overhead to sending an array in ByteNet. This is because these 2 bytes are an unsigned 16-bit integer, which stores the array length. As a side effect, arrays sent through ByteNet have a max length of 2^16, which is equal to 65,536. It's likely that in the future, you will be able to reduce the overhead to 1 byte through configuration, in turn reducing the max length of the array.
-packets.luaureturn {
- myCoolPacket = ByteNet.definePacket({
- structure = {
- myArray = ByteNet.array(ByteNet.bool)
- },
- })
-}
+packets.luaureturn ByteNet.defineNamespace("example", function()
+ return {
+ myCoolPacket = ByteNet.definePacket({
+ value = ByteNet.array(ByteNet.bool),
+ })
+ }
+}
-server.luaulocal packets = require(path.to.packets)
-
-packets.myCoolPacket:sendToAll({
- -- Important to note that mixed arrays/arrays with holes
- -- shouldn't be sent through.
- myArray = { true, false, true }
-})
+server.luaulocal packets = require(path.to.packets)
+
+packets.myCoolPacket.sendToAll({
+ -- Important to note that mixed arrays/arrays with holes
+ -- shouldn't be sent through.
+ true, false, true
+})
Maps
Maps are by far the most powerful "special" type in ByteNet. They let you send, what's most commonly referred to as a dictionary, through ByteNet. However it's important to keep in mind two things: the type of the key (or index), and the type of the value, cannot change.
Like arrays, maps have a 2-byte overhead to store the length of the map. This is done by iterating over the map using generic iteration and increasing a variable by 1 for every key-value pair. This, once again, means that there is a 2^16 (which equals to 65,536) cap to the number of elements in the map.
-packets.luaureturn {
- myCoolPacket = ByteNet.definePacket({
- structure = {
- -- [name] = age
- people = ByteNet.map(ByteNet.string, ByteNet.uint16)
- },
- })
-}
+packets.luaureturn ByteNet.defineNamespace("example", function()
+ return {
+ people = ByteNet.definePacket({
+ -- [name] = age
+ value = ByteNet.map(ByteNet.string, ByteNet.uint8)
+ })
+ }
+end)
-server.luaulocal packets = require(path.to.packets)
-
-packets.myCoolPacket:sendToAll({
- people = {
- john = 21,
- jane = 24,
- dave = 26,
- you = 162,
- }
-})
+server.luaulocal packets = require(path.to.packets)
+
+packets.myCoolPacket.sendToAll({
+ john = 21,
+ jane = 24,
+ dave = 26,
+ you = 162,
+})
diff --git a/api/functions/defineNamespace/index.html b/api/functions/defineNamespace/index.html
new file mode 100755
index 0000000..4461565
--- /dev/null
+++ b/api/functions/defineNamespace/index.html
@@ -0,0 +1,611 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ defineNamespace - ByteNet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ defineNamespace
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/api/functions/definePacket/index.html b/api/functions/definePacket/index.html
index 99f3ef3..c1853d2 100755
--- a/api/functions/definePacket/index.html
+++ b/api/functions/definePacket/index.html
@@ -41,14 +41,18 @@
-
-
+
+
-
+
-
+
+
+
+
+
@@ -713,19 +717,19 @@ what even is a packet in ByteNe
ByteNet's purpose as a library is to provide a way to structure your data, and send that structure in a hyper-optimized way.
Okay, where do I start?
-I highly recommended storing all of your packets in a single, shared module, and then using a dictionary to access the individual packets. Not only does this make using ByteNet a breeze, it also gives you a better form of typechecking.
-The keys of your packet determine the ID it gets. The server and the client sharing this key is essential: that's the core of how ByteNet works. Unfortunately, this means you cannot have duplicate contents of packets. This may change in the future.
-Enough of how it works, let's start off with making a basic packet:
+
Enough of how it works, let's start off with making a basic packet. We will also need to create a namespace:
packets.luaulocal ByteNet = require(path.to.bytenet)
-return {
- printSomething = ByteNet.definePacket({
- -- This structure field is very important!
- structure = {
- message = ByteNet.string,
- }
- })
-}
+return ByteNet.defineNamespace("messaging", function()
+ return {
+ printSomething = ByteNet.definePacket({
+ -- This value field is very important!
+ value = ByteNet.struct({
+ message = ByteNet.string,
+ })
+ })
+ }
+end)
Sending
@@ -739,40 +743,40 @@ Sending
send
-These functions must obey your structure created in definePacket, and if you have strict typing on, an error will be raised if the types do not match.
+Any data passed through these functions must obey your structure created in definePacket, and if you have strict typing on, an error will be raised if the types do not match.
code examples
client.luau-- Sending to server
-packets.myPacket:send({
+packets.myPacket.send({
message = "Hello, world!"
})
server.luau-- Sending to all players
-packets.myPacket:sendToAll({
+packets.myPacket.sendToAll({
message = "Hello, players!"
})
-- Sending to an individual player
local someArbitraryPlayer = Players.You
-packets.myPacket:sendTo({
+packets.myPacket.sendTo({
message = "Hello, random player!"
}, someArbitraryPlayer)
-- Sending to all except a certain player
local someArbitraryPlayer = Players.You
-packets.myPacket:sendToAllExcept({
+packets.myPacket.sendToAllExcept({
message = "Hello, everyone except one person!"
})
Receiving
You can use the listen method to listen for when a packet is received.
code examples
-
server.luaupackets.myPacket:listen(function(data, player)
+server.luaupackets.myPacket.listen(function(data, player)
print(`{player.UserId} says { data.message }`)
end)
-client.luaupackets.myPacket:listen(function(data)
+
diff --git a/assets/colors.css b/assets/colors.css
deleted file mode 100755
index f91b123..0000000
--- a/assets/colors.css
+++ /dev/null
@@ -1,39 +0,0 @@
-#nav__link {
- --md-primary-fg-color: #000000;
-}
-
-.md-header {
- background-color: #001127;
-}
-.md-tabs {
- background-color: #001127;
-}
-.md-ellipsis {
- color: rgb(255, 255, 255);
-}
-
-.md-typeset p {
- color: white
-}
-
-body {
- --md-primary-bg-color: #e6f9ff;
-}
-
-[data-md-color-scheme="slate"] {
- --md-code-fg-color: rgb(26, 26, 26);
- --md-code-bg-color: rgb(51, 51, 51);
- --md-code-hl-color: rgb(255, 255, 255);
- --md-code-hl-number-color: hsl(290, 60%, 70%);
- --md-code-hl-special-color: rgb(255, 255, 255);
- --md-code-hl-function-color: rgb(255, 255, 255);
- --md-code-hl-constant-color: rgb(233, 126, 126);
- --md-code-hl-keyword-color: hsl(187, 75%, 60%);
- --md-code-hl-string-color: hsl(330, 80%, 77%);
- --md-code-hl-name-color: rgb(253, 248, 255);
- --md-code-hl-operator-color: rgb(255, 182, 222);
- --md-code-hl-punctuation-color: hsl(61, 100%, 72%);
- --md-code-hl-comment-color: hsl(329, 24%, 51%);
- --md-code-hl-generic-color: rgb(165, 79, 79);
- --md-code-hl-variable-color: rgb(255, 147, 147);
-}
\ No newline at end of file
diff --git a/css/codeblocks.css b/css/codeblocks.css
new file mode 100755
index 0000000..2289530
--- /dev/null
+++ b/css/codeblocks.css
@@ -0,0 +1,17 @@
+[data-md-color-scheme="slate"] {
+ --md-code-fg-color: var(--docs-grey);
+ --md-code-bg-color: var(--docs-dark);
+ --md-code-hl-color: var(--docs-pink);
+ --md-code-hl-number-color: var(--docs-pink);
+ --md-code-hl-special-color: var(--docs-pink);
+ --md-code-hl-function-color: var(--docs-pink);
+ --md-code-hl-constant-color: var(--docs-pastelpink);
+ --md-code-hl-keyword-color: var(--docs-red);
+ --md-code-hl-string-color: var(--docs-yellow);
+ --md-code-hl-name-color: var(--docs-white);
+ --md-code-hl-operator-color: var(--docs-red);
+ --md-code-hl-punctuation-color: var(--docs-lightblue);
+ --md-code-hl-comment-color: var(--docs-green);
+ --md-code-hl-generic-color: var(--docs-lightblue);
+ --md-code-hl-variable-color: var(--docs-pastelpink);
+}
\ No newline at end of file
diff --git a/css/colors.css b/css/colors.css
new file mode 100755
index 0000000..f8c98e3
--- /dev/null
+++ b/css/colors.css
@@ -0,0 +1,15 @@
+:root {
+ --docs-black: #04080f;
+ --docs-dark: rgb(26, 26, 26);
+ --docs-gray: #7a7a7a63;
+ --docs-blue: #456990;
+ --docs-darkblue: #0f0f16;
+ --docs-lightblue: #b9d6f2;
+ --docs-pink: #f4a5ae;
+ --docs-pastelpink: #d999b9;
+ --docs-white: #f5f5f5;
+ --docs-green: #a7ffaa;
+ --docs-yellow: #f5f597;
+ --docs-red: #ff7b7b;
+ --docs-darkred: #310000;
+}
\ No newline at end of file
diff --git a/css/global.css b/css/global.css
new file mode 100755
index 0000000..7ee7d25
--- /dev/null
+++ b/css/global.css
@@ -0,0 +1,21 @@
+#nav__link {
+ --md-primary-fg-color: #000000;
+}
+
+.md-header {
+ background-color: #000313;
+}
+.md-tabs {
+ background-color: var(--docs-darkblue);
+}
+.md-ellipsis {
+ color: var(--docs-white);
+}
+
+.md-typeset p {
+ color: var(--docs-white)
+}
+
+body {
+ --md-primary-bg-color: var(--docs-white);
+}
\ No newline at end of file
diff --git a/assets/home.css b/css/homepage.css
similarity index 58%
rename from assets/home.css
rename to css/homepage.css
index c6decc6..05d7935 100755
--- a/assets/home.css
+++ b/css/homepage.css
@@ -13,50 +13,42 @@
}
[data-md-color-scheme="slate"] {
- --md-default-bg-color: rgb(10, 10, 10);
+ --md-default-bg-color: var(--docs-black);
}
#bytenet-header h1 {
font-size: 2.5em;
font-weight: bolder;
margin-bottom: 10px;
- color: white;
+ color: var(--docs-white);
}
.docs h1 {
font-size: 2em;
font-weight: bold;
margin-bottom: 10px;
- color: white;
+ color: var(--docs-white);
}
.md-typeset h1 {
margin-bottom: 1cm;
- color: white;
+ color: var(--docs-white);
font-weight: bold;
}
.md-typeset h2 {
- color: white;
+ color: var(--docs-white);
margin-top: 10px;
margin-bottom: 0px;
}
-.md-typeset h3#there-are-drawbacks-to-using-these {
- font-weight: bolder;
- color: #ff1744;
- margin-top: 10px;
- margin-bottom: 0px;
- font-size: 1.5em;
-}
-
.md-typeset .admonition.danger li {
font-size: 1.2em;
- color: #ff4a6f
+ color: var(--docs-red)
}
.md-typeset .admonition.danger {
- background-color: #4b071563;
+ background-color: var(--docs-darkred);
}
.md-grid {
@@ -66,56 +58,47 @@
.md-typeset ul li {
margin-bottom: 0px;
margin-top: 0px;
- color: rgb(255, 223, 163);
+ color: var(--docs-yellow);
}
-.md-typeset code {
- color: #e6f9ff;
- background-color: rgb(26, 26, 26);
+#no-top-margin {
+ margin-top: 0px;
}
-#bytenet-header h2 {
+#header h2 {
font-weight: bolder;
- color: white;
+ color: var(--docs-white);
margin-bottom: 0;
font-size: 1.5em;
margin-top: 10px;
}
-#bytenet-header hr {
+hr {
margin-top: 0;
margin-bottom: 0;
}
-#bytenet-header p {
+#header p {
font-size: 1.1em;
font-weight: lighter;
margin-top: 5px;
margin-bottom: 15px;
- color: rgb(255, 255, 255);
-}
-
-#bytenet-header #small {
- font-size: 1em;
- font-weight: lighter;
- margin-top: 0px;
- margin-bottom: 0px;
- color: rgb(130, 152, 153)
+ color: var(--docs-white);
}
-#bytenet-header #linkspan {
+#header #linkspan {
margin-top: 25px;
margin-bottom: 10px;
}
-#bytenet-header #link {
+#header #link {
margin-left: 10px;
margin-right: 10px;
color: hsl(187, 75%, 60%);
transition-duration: .1s;
}
-#bytenet-header #link:hover {
+#header #link:hover {
color: hsl(187, 100%, 85%);
transition-duration: .1s;
}
\ No newline at end of file
diff --git a/index.html b/index.html
index e83f1f5..03da81e 100755
--- a/index.html
+++ b/index.html
@@ -39,14 +39,18 @@
-
-
+
+
-
+
-
+
+
+
+
+
@@ -71,11 +75,6 @@
-
-
- Skip to content
-
-
@@ -290,19 +289,6 @@
-
-
-
-
@@ -314,43 +300,6 @@
-
-
-
-
@@ -596,34 +545,6 @@
-
-
-
-
-
-
- -
-
-
- - No more RemoteEvents
-
-
-
-
-
- -
-
-
- - As low-level as you can get
-
-
-
-
-
-
@@ -641,60 +562,68 @@
-
+
simple buffer-based networking
+
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.
+
Getting started
Download
+
+
-
- practical example of a packet's definition
-
+
+ practical example of a packet's definition
+
packets.luaulocal ByteNet = require(path.to.ByteNet)
-local packets = {
- myPacket = ByteNet.definePacket({
- structure = {
- -- A map where the key is a Vector3, and the value is a string
- map = ByteNet.dataTypes.map(ByteNet.dataTypes.vec3(), ByteNet.dataTypes.string())
- }
- })
-}
+return ByteNet.defineNamespace("example", function()
+ return {
+ vectorStringMap = ByteNet.definePacket({
+ value = ByteNet.dataTypes.map(ByteNet.dataTypes.vec3(), ByteNet.dataTypes.string())
+ })
+ }
+end)
-
+
example of sending a packet to all clients
server.luaulocal packets = require(path.to.packets)
-packets.myPacket:sendToAll({
- map = {
- [Vector3.new(1, 1, 1)] = "10x less bandwidth than a remote!",
- [Vector3.new(1, 2, 1)] = "oh wait, its way more than 10x less.",
-
- [Vector3.new(2, 1, 1)] = "depending on how you use your data,",
- [Vector3.new(1, 1, 2)] = "it could be 100x less!",
- }
-})
+packets.myPacket.sendToAll({
+ [Vector3.new(1, 1, 1)] = "10x less bandwidth than a remote!",
+ [Vector3.new(1, 2, 1)] = "oh wait, its way more than 10x less.",
+
+ [Vector3.new(2, 1, 1)] = "depending on how you use your data,",
+ [Vector3.new(1, 1, 2)] = "it could be 100x less!",
+})
+
+
+
+
+Not enough? here's more
+
+No more RemoteEvents
+ByteNet handles all instances for you; you don't need to worry about reliability type, parenting, etc
+
+ - As low-level as you can get
+ByteNet lets you directly read/write data types such as uint32, buffers, in a way where the keys are abstracted away. Reap the benefits of a structured, strictly typed library, while retaining the benefits of hardcore optimization.
+
-
-Not enough? here's more
-- No more RemoteEvents
-ByteNet handles all instances for you; you don't need to worry about reliability type, parenting, etc
-- As low-level as you can get
-ByteNet lets you directly read/write data types such as uint32, buffers, in a way where the keys are abstracted away. Reap the benefits of a structured, strictly typed library, while retaining the benefits of hardcore optimization.
+
diff --git a/search/search_index.json b/search/search_index.json
index cc61c83..550b1b3 100755
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":"simple buffer-based networking 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.
Getting started Download
practical example of a packet's definition
packets.luaulocal ByteNet = require(path.to.ByteNet)\n\nlocal packets = {\n myPacket = ByteNet.definePacket({\n structure = {\n -- A map where the key is a Vector3, and the value is a string\n map = ByteNet.dataTypes.map(ByteNet.dataTypes.vec3(), ByteNet.dataTypes.string())\n }\n })\n}\n
example of sending a packet to all clients
server.luaulocal packets = require(path.to.packets)\n\npackets.myPacket:sendToAll({\n map = {\n [Vector3.new(1, 1, 1)] = \"10x less bandwidth than a remote!\",\n [Vector3.new(1, 2, 1)] = \"oh wait, its way more than 10x less.\",\n\n [Vector3.new(2, 1, 1)] = \"depending on how you use your data,\",\n [Vector3.new(1, 1, 2)] = \"it could be 100x less!\",\n }\n})\n
"},{"location":"#not-enough-heres-more","title":"Not enough? here's more","text":""},{"location":"#-no-more-remoteevents","title":"- No more RemoteEvents","text":"ByteNet handles all instances for you; you don't need to worry about reliability type, parenting, etc
"},{"location":"#-as-low-level-as-you-can-get","title":"- As low-level as you can get","text":"ByteNet lets you directly read/write data types such as uint32, buffers, in a way where the keys are abstracted away. Reap the benefits of a structured, strictly typed library, while retaining the benefits of hardcore optimization.
"},{"location":"api/dataTypes/Primitives/","title":"Primitives","text":"ByteNet provides a large amount of \"primitive\" types for you to build more complex types that suit your game. Since primitive types don't need any parameters, you can just access them like the following: ByteNet.<typename>. For building more complex data structures, go look at the Specials page.
"},{"location":"api/dataTypes/Primitives/#available-primitive-types","title":"Available primitive types","text":""},{"location":"api/dataTypes/Primitives/#supported-generic-types","title":"Supported generic types","text":" string: Stringbuff: Bufferbool: Boolean
"},{"location":"api/dataTypes/Primitives/#supported-number-types","title":"Supported number types","text":" uint8: Unsigned 8-bit integeruint16: Unsigned 16-bit integeruint32: Unsigned 32-bit integerint8: Signed 8-bit integerint16: Signed 16-bit integerint32: Signed 32-bit integerfloat32: Standard 32-bit floatfloat64: Standard 64-bit float
"},{"location":"api/dataTypes/Primitives/#supported-roblox-types","title":"Supported Roblox types","text":" cframe: CoordinateFramevec2: Vector2vec3: Vector3
"},{"location":"api/dataTypes/Specials/","title":"Specials","text":"Special types are how complex packet types are made. They can take in nearly any type, including themselves, and most importantly they are dynamic. This means you can have an array of any length, a map of any key type and any value type, and an optional value of any type.
Special types always take parameters. You have to call them: ByteNet.<type name>(<any primitive type>).
Danger
"},{"location":"api/dataTypes/Specials/#available-special-types","title":"Available special types","text":""},{"location":"api/dataTypes/Specials/#there-are-drawbacks-to-using-these","title":"There are drawbacks to using these!","text":" - Using these types incurs 1-2 bytes of overhead due to the dynamic nature.
- They take drastically more time to parse
- They are heavier on memory usage, as a new closure is created each time. You will never have to worry about this unless you have dozens of packets, though.
"},{"location":"api/dataTypes/Specials/#optionals","title":"Optionals","text":"Optional types are a cool name for the concept of \"This doesn't have to exist\". It's good for optional parameters: for example if some invoked function were to fail, you might want to send back a blank copy to indicate that something is wrong.
packets.luau
return {\n myCoolPacket = ByteNet.definePacket({\n structure = {\n -- An \"optional\" type takes in a parameter.\n -- This can be anything! You can even have optional arrays.\n helloWorldString = ByteNet.optional(ByteNet.string)\n\n -- This works!\n eachCharacter = ByteNet.optional(ByteNet.array(ByteNet.string))\n },\n })\n}\n
You really don't have to think about using optional types. You just send it! server.luaulocal packets = require(path.to.packets)\n\nlocal randomlyStringOrNil = \n if math.random(1, 2) == 1 then \"Hello, world!\" else nil\n\npackets.myCoolPacket:sendToAll({\n helloWorldString = randomlyAppearingString,\n\n -- Note that even if we don't put the \"eachCharacter\" field here,\n -- it won't error. This is because it's optional!\n})\n
"},{"location":"api/dataTypes/Specials/#arrays","title":"Arrays","text":"Arrays are fairly self explanatory. They're just plain old arrays. However, it's important to note that mixed tables have undefined behavior when passed as an array. This means things might be missing when they come out on the other side!
There is a 2 byte overhead to sending an array in ByteNet. This is because these 2 bytes are an unsigned 16-bit integer, which stores the array length. As a side effect, arrays sent through ByteNet have a max length of 2^16, which is equal to 65,536. It's likely that in the future, you will be able to reduce the overhead to 1 byte through configuration, in turn reducing the max length of the array.
packets.luaureturn {\n myCoolPacket = ByteNet.definePacket({\n structure = {\n myArray = ByteNet.array(ByteNet.bool)\n },\n })\n}\n
server.luaulocal packets = require(path.to.packets)\n\npackets.myCoolPacket:sendToAll({\n -- Important to note that mixed arrays/arrays with holes\n -- shouldn't be sent through.\n myArray = { true, false, true }\n})\n
"},{"location":"api/dataTypes/Specials/#maps","title":"Maps","text":"Maps are by far the most powerful \"special\" type in ByteNet. They let you send, what's most commonly referred to as a dictionary, through ByteNet. However it's important to keep in mind two things: the type of the key (or index), and the type of the value, cannot change.
Like arrays, maps have a 2-byte overhead to store the length of the map. This is done by iterating over the map using generic iteration and increasing a variable by 1 for every key-value pair. This, once again, means that there is a 2^16 (which equals to 65,536) cap to the number of elements in the map.
packets.luaureturn {\n myCoolPacket = ByteNet.definePacket({\n structure = {\n -- [name] = age\n people = ByteNet.map(ByteNet.string, ByteNet.uint16)\n },\n })\n}\n
server.luaulocal packets = require(path.to.packets)\n\npackets.myCoolPacket:sendToAll({\n people = {\n john = 21,\n jane = 24,\n dave = 26,\n you = 162,\n }\n})\n
"},{"location":"api/functions/definePacket/","title":"definePacket","text":"Defining a packet"},{"location":"api/functions/definePacket/#what-even-is-a-packet-in-bytenet-anyway","title":"what even is a packet in ByteNet anyway?","text":"Packets are the structured dictionaries you use to define the \"format\" your data is going to be sent in. These are named packets as you 'send' packets through network, and packets have their contents usually formatted in a specific way because, well they have to be.
ByteNet's purpose as a library is to provide a way to structure your data, and send that structure in a hyper-optimized way.
"},{"location":"api/functions/definePacket/#okay-where-do-i-start","title":"Okay, where do I start?","text":"I highly recommended storing all of your packets in a single, shared module, and then using a dictionary to access the individual packets. Not only does this make using ByteNet a breeze, it also gives you a better form of typechecking.
The keys of your packet determine the ID it gets. The server and the client sharing this key is essential: that's the core of how ByteNet works. Unfortunately, this means you cannot have duplicate contents of packets. This may change in the future.
Enough of how it works, let's start off with making a basic packet: packets.luau
local ByteNet = require(path.to.bytenet)\n\nreturn {\n printSomething = ByteNet.definePacket({\n -- This structure field is very important!\n structure = {\n message = ByteNet.string,\n }\n })\n}\n
"},{"location":"api/functions/definePacket/#sending","title":"Sending","text":"On the server, there are 3 methods of sending packets to players. It's important to note that when a player should be specified, it's the second parameter given, not the first. This is an intentional design choice.
sendToAllsendToAllExceptsendTo
On the client, there is only one, because you can only send data to the server:
send
These functions must obey your structure created in definePacket, and if you have strict typing on, an error will be raised if the types do not match.
code examples client.luau
-- Sending to server\npackets.myPacket:send({\n message = \"Hello, world!\"\n})\n
server.luau-- Sending to all players\npackets.myPacket:sendToAll({\n message = \"Hello, players!\"\n})\n\n-- Sending to an individual player\nlocal someArbitraryPlayer = Players.You\n\npackets.myPacket:sendTo({\n message = \"Hello, random player!\"\n}, someArbitraryPlayer)\n\n-- Sending to all except a certain player\nlocal someArbitraryPlayer = Players.You\n\npackets.myPacket:sendToAllExcept({\n message = \"Hello, everyone except one person!\"\n})\n
"},{"location":"api/functions/definePacket/#receiving","title":"Receiving","text":"You can use the listen method to listen for when a packet is received.
code examples server.luau
packets.myPacket:listen(function(data, player)\n print(`{player.UserId} says { data.message }`)\nend)\n
client.luaupackets.myPacket:listen(function(data)\n print(`server says { data.message }`)\nend)\n
"},{"location":"api/functions/definePacket/#configuration-reliability-types","title":"Configuration (Reliability types)","text":"Currently, the only config accessible right now is reliability types. This will change as time goes on, however right now, you can switch reliability types by defining reliabilityType to be \"reliable\" or \"unreliable\".
"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":"simple buffer-based networking 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.
Getting started Download
practical example of a packet's definition
packets.luaulocal ByteNet = require(path.to.ByteNet)\n\nreturn ByteNet.defineNamespace(\"example\", function()\n return {\n vectorStringMap = ByteNet.definePacket({\n value = ByteNet.dataTypes.map(ByteNet.dataTypes.vec3(), ByteNet.dataTypes.string())\n })\n }\nend)\n
example of sending a packet to all clients
server.luaulocal packets = require(path.to.packets)\n\npackets.myPacket.sendToAll({\n [Vector3.new(1, 1, 1)] = \"10x less bandwidth than a remote!\",\n [Vector3.new(1, 2, 1)] = \"oh wait, its way more than 10x less.\",\n\n [Vector3.new(2, 1, 1)] = \"depending on how you use your data,\",\n [Vector3.new(1, 1, 2)] = \"it could be 100x less!\",\n})\n
Not enough? here's more No more RemoteEvents ByteNet handles all instances for you; you don't need to worry about reliability type, parenting, etc - As low-level as you can get ByteNet lets you directly read/write data types such as uint32, buffers, in a way where the keys are abstracted away. Reap the benefits of a structured, strictly typed library, while retaining the benefits of hardcore optimization."},{"location":"api/dataTypes/Primitives/","title":"Primitives","text":"ByteNet provides a large amount of \"primitive\" types for you to build more complex types that suit your game. Since primitive types don't need any parameters, you can just access them like the following: ByteNet.<typename>. For building more complex data structures, go look at the Specials page.
"},{"location":"api/dataTypes/Primitives/#available-primitive-types","title":"Available primitive types","text":""},{"location":"api/dataTypes/Primitives/#supported-general-types","title":"Supported general types","text":" string: Stringbuff: Bufferbool: Booleannothing: Nothingunknown: Any type
"},{"location":"api/dataTypes/Primitives/#supported-number-types","title":"Supported number types","text":" uint8: Unsigned 8-bit integeruint16: Unsigned 16-bit integeruint32: Unsigned 32-bit integerint8: Signed 8-bit integerint16: Signed 16-bit integerint32: Signed 32-bit integerfloat32: Standard 32-bit floatfloat64: Standard 64-bit float
"},{"location":"api/dataTypes/Primitives/#supported-roblox-types","title":"Supported Roblox types","text":" cframe: CoordinateFramevec2: Vector2vec3: Vector3inst: Instance
"},{"location":"api/dataTypes/Specials/","title":"Specials","text":"Special types are how complex packet types are made. They can take in nearly any type, including themselves, and most importantly they are dynamic. This means you can have an array of any length, a map of any key type and any value type, and an optional value of any type.
Special types always take parameters. You have to call them: ByteNet.<type name>(<any primitive type>).
Danger
- Using these types incurs 1-2 bytes of overhead due to the dynamic nature.
- They take drastically more time to parse
- They are heavier on memory usage, as a new closure is created each time. You will never have to worry about this unless you have dozens of packets, though.
"},{"location":"api/dataTypes/Specials/#available-special-types","title":"Available special types","text":""},{"location":"api/dataTypes/Specials/#structs","title":"Structs","text":"Structs let you send structured data in the form of dictionaries. The fields are optimized away, so they don't take any bandwidth. Structs are how you'll be sending most of your data likely: they are the best for organization, and they let you do really interesting things. For example: chunkPackets.luau
return ByteNet.defineNamespace(\"chunks\", function()\n local chunkData = ByteNet.struct({\n biome = ByteNet.uint8,\n seed = ByteNet.int32,\n })\n\n return {\n sendChunks = ByteNet.definePacket({\n value = ByteNet.array(chunkData)\n })\n }\nend)\n
"},{"location":"api/dataTypes/Specials/#optionals","title":"Optionals","text":"Optional types are a cool name for the concept of \"This doesn't have to exist\". It's good for optional parameters: for example if some invoked function were to fail, you might want to send back a blank copy to indicate that something is wrong.
packets.luau
return ByteNet.defineNamespace(\"chunks\", function()\n return {\n myCoolPacket = ByteNet.definePacket({\n value = ByteNet.struct({\n -- An \"optional\" type takes in a parameter.\n -- This can be anything! You can even have optional arrays.\n helloWorldString = ByteNet.optional(ByteNet.string)\n\n -- This works!\n eachCharacter = ByteNet.optional(ByteNet.array(ByteNet.string))\n }),\n })\n }\nend)\n
You really don't have to think about using optional types. You just send it! server.luaulocal packets = require(path.to.packets)\n\nlocal randomlyStringOrNil = \n if math.random(1, 2) == 1 then \"Hello, world!\" else nil\n\npackets.myCoolPacket.sendToAll({\n helloWorldString = randomlyAppearingString,\n\n -- Note that even if we don't put the \"eachCharacter\" field here,\n -- it won't error. This is because it's optional!\n})\n
"},{"location":"api/dataTypes/Specials/#arrays","title":"Arrays","text":"Arrays are fairly self explanatory. They're just plain old arrays. However, it's important to note that mixed tables have undefined behavior when passed as an array. This means things might be missing when they come out on the other side!
There is a 2 byte overhead to sending an array in ByteNet. This is because these 2 bytes are an unsigned 16-bit integer, which stores the array length. As a side effect, arrays sent through ByteNet have a max length of 2^16, which is equal to 65,536. It's likely that in the future, you will be able to reduce the overhead to 1 byte through configuration, in turn reducing the max length of the array.
packets.luaureturn ByteNet.defineNamespace(\"example\", function()\n return {\n myCoolPacket = ByteNet.definePacket({\n value = ByteNet.array(ByteNet.bool),\n })\n }\n}\n
server.luaulocal packets = require(path.to.packets)\n\npackets.myCoolPacket.sendToAll({\n -- Important to note that mixed arrays/arrays with holes\n -- shouldn't be sent through.\n true, false, true\n})\n
"},{"location":"api/dataTypes/Specials/#maps","title":"Maps","text":"Maps are by far the most powerful \"special\" type in ByteNet. They let you send, what's most commonly referred to as a dictionary, through ByteNet. However it's important to keep in mind two things: the type of the key (or index), and the type of the value, cannot change.
Like arrays, maps have a 2-byte overhead to store the length of the map. This is done by iterating over the map using generic iteration and increasing a variable by 1 for every key-value pair. This, once again, means that there is a 2^16 (which equals to 65,536) cap to the number of elements in the map.
packets.luaureturn ByteNet.defineNamespace(\"example\", function()\n return {\n people = ByteNet.definePacket({\n -- [name] = age\n value = ByteNet.map(ByteNet.string, ByteNet.uint8)\n })\n }\nend)\n
server.luaulocal packets = require(path.to.packets)\n\npackets.myCoolPacket.sendToAll({\n john = 21,\n jane = 24,\n dave = 26,\n you = 162,\n})\n
"},{"location":"api/functions/definePacket/","title":"definePacket","text":"Defining a packet"},{"location":"api/functions/definePacket/#what-even-is-a-packet-in-bytenet-anyway","title":"what even is a packet in ByteNet anyway?","text":"Packets are the structured dictionaries you use to define the \"format\" your data is going to be sent in. These are named packets as you 'send' packets through network, and packets have their contents usually formatted in a specific way because, well they have to be.
ByteNet's purpose as a library is to provide a way to structure your data, and send that structure in a hyper-optimized way.
"},{"location":"api/functions/definePacket/#okay-where-do-i-start","title":"Okay, where do I start?","text":"Enough of how it works, let's start off with making a basic packet. We will also need to create a namespace: packets.luau
local ByteNet = require(path.to.bytenet)\n\nreturn ByteNet.defineNamespace(\"messaging\", function()\n return {\n printSomething = ByteNet.definePacket({\n -- This value field is very important!\n value = ByteNet.struct({\n message = ByteNet.string,\n })\n })\n }\nend)\n
"},{"location":"api/functions/definePacket/#sending","title":"Sending","text":"On the server, there are 3 methods of sending packets to players. It's important to note that when a player should be specified, it's the second parameter given, not the first. This is an intentional design choice.
sendToAllsendToAllExceptsendTo
On the client, there is only one, because you can only send data to the server:
send
Any data passed through these functions must obey your structure created in definePacket, and if you have strict typing on, an error will be raised if the types do not match.
code examples client.luau
-- Sending to server\npackets.myPacket.send({\n message = \"Hello, world!\"\n})\n
server.luau-- Sending to all players\npackets.myPacket.sendToAll({\n message = \"Hello, players!\"\n})\n\n-- Sending to an individual player\nlocal someArbitraryPlayer = Players.You\n\npackets.myPacket.sendTo({\n message = \"Hello, random player!\"\n}, someArbitraryPlayer)\n\n-- Sending to all except a certain player\nlocal someArbitraryPlayer = Players.You\n\npackets.myPacket.sendToAllExcept({\n message = \"Hello, everyone except one person!\"\n})\n
"},{"location":"api/functions/definePacket/#receiving","title":"Receiving","text":"You can use the listen method to listen for when a packet is received.
code examples server.luau
packets.myPacket.listen(function(data, player)\n print(`{player.UserId} says { data.message }`)\nend)\n
client.luaupackets.myPacket.listen(function(data)\n print(`server says { data.message }`)\nend)\n
"},{"location":"api/functions/definePacket/#configuration-reliability-types","title":"Configuration (Reliability types)","text":"Currently, the only config accessible right now is reliability types. This will change as time goes on, however right now, you can switch reliability types by defining reliabilityType to be \"reliable\" or \"unreliable\".
"}]}
\ No newline at end of file
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index aae0403c5103253e16fd924536c688954badf483..87ced212bf59390cf8f2849c39a387f19b1f46be 100755
GIT binary patch
delta 13
Ucmb=gXP58h;0Tj`Igz~r02{glDgXcg
delta 13
Ucmb=gXP58h;E0=cZX$aH03GE7k^lez