![](\"https://i.imgur.com/YgpbX7G.png\"/)
\r \r \r Note: I am working on the API for the Zircon scripting still - so Coming soon™
\r\r Note: I am working on the API for the Zircon scripting still - so Coming soon™
\r\r \r \r \r \r \r \r \r ![](\"https://i.imgur.com/YgpbX7G.png\")
\r \r\n ![](\"./assets/Example2.jpg\"/)
\r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n![](\"./assets/Example1.png\"/)
\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n","readmeFilename":"README.md","gitHead":"70824152c34e7b6da0233cbb10020d19f14a9807","_id":"@rbxts/zircon@0.20.0-dev-7082415","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-1BW7eWOBMKXS/Ey9FWukZ/QYndW8TmBOvIK6RaWU+7tPmH1hkBjR0zMAsylyPLsl+wNfwCcWel3KOpHo88EkGw==","shasum":"aecb6af84165b8fbe856d5a7548076c6eb8072a0","tarball":"https://registry.npmjs.org/@rbxts/zircon/-/zircon-0.20.0-dev-7082415.tgz","fileCount":116,"unpackedSize":281672,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhxUmrCRA9TVsSAnZWagAAlh8QAISrafqmY/NGBIc6NIsm\nKoOtLv1/l87ihzomkLQU7CWu1pnUCKY4hHYexvDqXD87K1RZ3/pLjnXgC4nX\nW+wp5Ry6+FC8cITXtuwHFNfEl6f4I4BBANQN3DsUjLhgxfdCnnI1PEocZ3dv\n2EHG2z/5/dqQETs5GMWzvqekvTyVD3OfzHqHxc/cCdaosD/2hbvpUkOjjfN2\nz7/SXeYNpszbwR5vgPc/d6O5ip8AUn+Wfi0LIOM9RiRbCcr8bPQhqht5XA5b\nuohfVTMPYDtoYBs5u7JFMA7vlzob3AnYIQrE5KtLWAYBArZOXivcspuY5426\nZ6ZV0Dr957qocODonFDKAimnU9+jgNrelKF+f0pHzSTVL1Jh/Qz7FVgwZLCE\nBizpcl4RXC8/iazs7OYQ1j6h0dopgHt3WYwIyjTtAYgtjPZvmhGR5Kd1SrK/\nJh0gfJwsdseydebF47sW2XO1blXKgZIH5iu+0Ph383UaynmYMxdg8UYBFAkK\ndeYe3E0Br9ZIzYaFhJ6j5JeAV5VUJESezyIlF6dvX0aeH53EPe459m1nhwi6\nuZldoJUnS0f2EPVN3ZGgN+P255jW7TPH3rADRMwosOSUhFnSHXpfld/QoMwd\ndUlOn/tbabUiR8vyCMvCp7EHby+t5vXBOZgcX6fpMkq5QeSis9sPXjlmimQQ\nNKzc\r\n=ArT/\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFwQd5YzMre9q62kqGofhiK3VysuzHFYXylsjmkszDsoAiBgrzLFomxV7aXVgxbOWz8G+53znq0Da/68f6EpWpP1cg=="}]},"_npmUser":{"name":"vorlias","email":"vorlias.npm@outlook.com"},"directories":{},"maintainers":[{"name":"vorlias","email":"vorlias.npm@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zircon_0.20.0-dev-7082415_1640319403155_0.1645069202229592"},"_hasShrinkwrap":false},"0.20.0-dev-d6adb62":{"name":"@rbxts/zircon","version":"0.20.0-dev-d6adb62","description":"\r \r\n \r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n","readmeFilename":"README.md","gitHead":"d6adb62af9ef260a97ce926cb7ff938ce4986da8","_id":"@rbxts/zircon@0.20.0-dev-d6adb62","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-NYeyqWSUiL8KFbHqcSGhtG6YFzMdnt6WYS5WEY4UlMjAX48hYY5TQaaqVZRqLzgQ1RBEYs9B+FN6naGQi8vSGg==","shasum":"b5c3892b2e73b2dde65db91c24ac9bd512547dd9","tarball":"https://registry.npmjs.org/@rbxts/zircon/-/zircon-0.20.0-dev-d6adb62.tgz","fileCount":116,"unpackedSize":281707,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhxU//CRA9TVsSAnZWagAASi8P/ikHIyy5rbC0QwkHtclR\ncQYNDgZbT8pH0CLTZPBY+JVbe/sB2S1WBUX8FpwnS+ZmotKVsTjoiJN1FB9l\nQ0FC8syzDCrTAbp3INXIupNvyRc/ly2onoqgZdLhQIf+RGLOc9iTyQ/F240y\nfN22tWcTAsud92vN1TOAmAvpxBmBPEU4RexBqfl4fpv+3qjYYacfyaGBHtSI\nV3Bif/Ia9jSv3yaMKAU9D052YeZUhw3gb5qtDfTSYDMiP6/WXHJ2gy5MG/oK\n4xdsplXra+4J44NBeQPDsgsBuZ9vkLtxR+aUr1kQQRUBd4FuryhmFKaaLWdh\n11euw8vwxd9Dv6LQR9VFptKA7ph2E2bMqunnRW1w6ciML0104bhf5uOreahV\nJRnPNVpGkZ7UN/JCsugdNvW9B7yw88gFLTLD8y7uKflVLrzU5yyjEORY9k6n\nE/fAYPEy/4iNXL4U1KDTSXhIWs1Hl0dzHNGJeewvywP8Dglxw9IznxQFli0s\npGpTreDB6YeLV9hGR924fdxkfyTsjs+6sRizFNV5HoHYsKP55TXqEcG8g0kk\nHAbTAZCOjNqKr7P8wZSyj5F/WDZ/VjXqcC2huo0ue9tXE4AoxdbnKzh1entl\n2YRbjw2MWggbIp4uMODbBq8YB0Vmhm2i3An9UKe8kYEozvpRbi4IicqaE4JI\nSExx\r\n=y5HO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDmQ+jSIam87r40FeqknmCy4LKngBSoPsHeEYncBiKaPAiEAk0x8xb74mArlO9LmVmLYOFl46dcmOz1sEozhGv0sa2I="}]},"_npmUser":{"name":"vorlias","email":"vorlias.npm@outlook.com"},"directories":{},"maintainers":[{"name":"vorlias","email":"vorlias.npm@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zircon_0.20.0-dev-d6adb62_1640321023144_0.07522984589097592"},"_hasShrinkwrap":false},"0.20.0-dev-80c902e":{"name":"@rbxts/zircon","version":"0.20.0-dev-80c902e","description":"\r \r\n \r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n","readmeFilename":"README.md","gitHead":"80c902e0d3f01ec79ab013d702a4883e682e69d3","_id":"@rbxts/zircon@0.20.0-dev-80c902e","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-kxwMhnMaPxHqgTHxcBKndh0l3sryz3cm281BD9QixZsLHQR/dpd7j+8r5ylI9ENvauQcx0BRVy/kTiCGvXeT7A==","shasum":"a88308228c1b728b013d05270d54c92f6d252ae6","tarball":"https://registry.npmjs.org/@rbxts/zircon/-/zircon-0.20.0-dev-80c902e.tgz","fileCount":116,"unpackedSize":286839,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhyE6BCRA9TVsSAnZWagAARBsP/2L0KBaqtHtGqSSbH8BJ\n1kHuIkZHUdOm2DqQkm/ENE31kH4u0lNEABLD/dv1nzlwDec41ov9udc6gKTM\nYz+hHw6eBj6AZAgbYXGfdv0XcoSBJFNAVzUvV4btHKGIfF5Hgpn14+C9vCCZ\n2ETYBEJc35dBun+vcOtjVFag6U2d6J7iJq/Q8BK3Bs+TaydtlHlHqUbXZJc5\nlsqTlxLzmh3tzzzG7myvB7GtER3sRMAlxU4gq9BOhmSckjQMdVL56uffri2l\ngkXcKDwbfyqRiyqrd6pNzrMOToTstv4ls2PYJ3GQQXxya6BPdjvCkrIjnhuB\naehkT0UbAXal2VmQgfsXTorxhwUoXzhk3BZ14ETJLV9Grw4QaK8iEMS/AAIH\nPYDi3Ygqk+T4+/EFbgsiCn526HrGZC1euTasU0VZENruELHp6bHmEkNUdz6s\npFt/yG0/DtdKm8q6MyI61MFAqkNGhQk95c8RKj+RqX/LdZV6fs18bMK+hLut\n55ER8Nv0SMdLAmsTilXzortmq9R+shOSPM0E/tbpgz3iPYVtEsuPEyi5i/yp\nIMpzYvGGUE5uqju2F0RJ49K6kSLYbWyZbsQzDM8RDBG9SUDXDIRVFoj0GAWN\nX/onLz7HVNTOzSEKpYWdu3fnKFWh2paZdU0Rta4DMHWuBiITl0Sxnuqxc6/T\nE3DJ\r\n=5FVj\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGYvuGb9/00XXcghA8JfqLaU+SWIXo7MLa+UeIwr+EVsAiEAxJXN3GZhAOzeatedfUZXUfbDIJzE6Ja76Uerj4xznGM="}]},"_npmUser":{"name":"vorlias","email":"vorlias.npm@outlook.com"},"directories":{},"maintainers":[{"name":"vorlias","email":"vorlias.npm@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zircon_0.20.0-dev-80c902e_1640517249670_0.2329513125057181"},"_hasShrinkwrap":false},"0.20.0-dev-45e1b88":{"name":"@rbxts/zircon","version":"0.20.0-dev-45e1b88","description":"\r \r\n \r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n","readmeFilename":"README.md","gitHead":"45e1b88aa7b2d46997e6f7a49985020a7ede6efe","_id":"@rbxts/zircon@0.20.0-dev-45e1b88","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-mJYIxs3JA09+AiXUTk2upTpG9UkSRCQYCeXwE65e5Xq7za3WTWQgAYt3nuzXOAOoRD/rjx2rYBz/tyHHDWRH5w==","shasum":"9df00e20dc602d4adf8ffd80ab4ac6774c93165d","tarball":"https://registry.npmjs.org/@rbxts/zircon/-/zircon-0.20.0-dev-45e1b88.tgz","fileCount":120,"unpackedSize":301620,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhzDptCRA9TVsSAnZWagAA6sEQAIoeAMIBN1sa0LOOACOR\nPtchH6oebjRYEpjDLpdnMJUsaD+6clpqIRqJlwzVaA9FT+y8Y3k6DfFXfxV6\nJvH57fInvym+fcSisBfClvXmY3tyWmH9iZQjsZEPJMjPwz3S4AdQEIymwI3v\nTSjy/FQI6QrUkDGDg/Jf9L5tI5VUmxexinRlPZJ5WIgjdFiYTkB1AnTt+POi\nWydjGZU00qkTnTL6g6QM664agHNDx4IkNrZ3Mf1e2EYYrRlakuYOMEjz4fTU\nuM4oi9jksEns5G3a+MWryC6P/Y6GGGd7czFdCq62wSote16os2xfxcRYmdad\nu04qhn5YLXGoxfymOmOHO1yfMyPcAuE3+EGAM7Byse9+IVOmKhJkr3M17vTI\n6I/Xyyx9HYOvGGWqtUrDQIb+qZjshy437QQ9eTrLvVgVcRochvfPz2trqzin\nYu0tNRPkSqFsv1cUggj3m58ldSgPT4u09sGphhHWPomj/g4VvGrpXqVwh7kB\nN44vXscH0h0XbPE8ZfNgT2n1cOG2b4hE3kGHAtFVB05KqgVj4mxroektfMCO\nkz3a9X0iAEMcx6zdgurD27kObWrPN6+FjLIWc0QoaelTcNXpYzPQjmQKvcDO\nUImFZiPi6jrydxG557f/JruC+ER2JnyzvDaCt3tSHdQ3DEL1dtSjqz4aSq0a\nLYGS\r\n=6xoo\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDGFwboUq7G5q4vMp0cpoKBOyO2unR0o9CM9wUCg5PMwQIgBCPHofCYeRqrNNlro3SGnTRSTZd+6dQO66LanHCcrz0="}]},"_npmUser":{"name":"vorlias","email":"vorlias.npm@outlook.com"},"directories":{},"maintainers":[{"name":"vorlias","email":"vorlias.npm@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zircon_0.20.0-dev-45e1b88_1640774253464_0.1722019320258228"},"_hasShrinkwrap":false},"0.20.0-dev-d95e756":{"name":"@rbxts/zircon","version":"0.20.0-dev-d95e756","description":"\r \r\n \r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n","readmeFilename":"README.md","gitHead":"d95e75643dddc1bbd15920df4de06bf3aa6e7795","_id":"@rbxts/zircon@0.20.0-dev-d95e756","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-N6F1XiDIuknTwal+0ndiSUGPbWKpB1b2bFqN6IQMNgYrxqetf5cibLfAzWxsOi5c/FXhMnzmVWkk4IDkM9NJxA==","shasum":"50f850a635ccbde239ac532a7792709baef2c574","tarball":"https://registry.npmjs.org/@rbxts/zircon/-/zircon-0.20.0-dev-d95e756.tgz","fileCount":122,"unpackedSize":306288,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhzELPCRA9TVsSAnZWagAAK+wQAI+vi1jfWhE9P4sdyUZ0\nxLlIBLGd9ElWo2DsMyBjz8Op4dCIgIyOxepqUeTVdnvJRIdnRMK9Pk4Y+YYu\npJAiP2EZcap2ds5Qm5gGbtEB0ZHICbAz9w1opYngHFoEyTa4PADo4h9w34oF\n1szT6xc9MfPL+D4+XqMq9Wi4E82xe4LVeiO2VqmcKAO6c9QBbd0DY5t4woxB\ncBsjAq6qC3/D+PmW36RZYJJwIVI1hyT0iLm02NQK6cbjBBwJzcREV+mk5+Zf\ndFU1uUO6nefzq5xk8i0y6PCqzSYdlE0xAoyjDUnIP6/es7RTuWse6WE2fXK0\nQwxYCCmBvr1dVOw09Zaoi59WkilZFF80TwwcCGVW3m9cEiM7mZbXI4UdtTPG\no1WKtO/yrLMlxECrmH1rjoDwgeD6eBGO8f8n68Litf9IldOP0RSLEQ7H4RG/\nOoCKxSBU0mBI+tEH0zo6geJaqvkHBuJYTsLNYemT+9DqTnQXWriqt3kLk8Lr\ndraduX088R/iPQYGKSqXxN1SyVZ8VcT2qSopioL6r5+xDcZahMHLN8Fb++WP\nfd62LNJktWv6PkLOOrqjanuYtRFz9ICQWlgrRv/oCtv5eTd+H9zhVHZ6Dr4S\n+bklA31d/5v2YL7L+DGpJDXyw6ku5FLYS3G2QqCVqx31lhN9V9sPD0SzOV+t\nKwIw\r\n=eNsa\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBiGS42wK6Owj1klwVYQBfJesjeZiTTMNQF2nx/wupRSAiAGAuCS2PjtSzp6VlTZLRYw7OncU7anj14Y4RA52tA8Ug=="}]},"_npmUser":{"name":"vorlias","email":"vorlias.npm@outlook.com"},"directories":{},"maintainers":[{"name":"vorlias","email":"vorlias.npm@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zircon_0.20.0-dev-d95e756_1640776399032_0.5475368647315566"},"_hasShrinkwrap":false},"0.20.0-dev-56edce6":{"name":"@rbxts/zircon","version":"0.20.0-dev-56edce6","description":"\r \r\n \r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n","readmeFilename":"README.md","gitHead":"56edce613f193bd5704430ffd898d485b28f77d1","_id":"@rbxts/zircon@0.20.0-dev-56edce6","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-PiJVtHAH902iYJC4K7L8V4oI1uQhkMB2KngdEmGQZFsEYBB0xYeLIZmuzp7502QB4G1Z0mucjnCUTi7WFNz0GA==","shasum":"5065bf9f6e9700064604fe56fb81c00802127d81","tarball":"https://registry.npmjs.org/@rbxts/zircon/-/zircon-0.20.0-dev-56edce6.tgz","fileCount":124,"unpackedSize":312073,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhzQnpCRA9TVsSAnZWagAAVPMQAItTIMzYCXlXQRe2i5vu\n7QUasubeuytW9gdkc0uHvjQfQ6vExChV+6r3a84+cqZ6IVKiWd+h5jATNHf+\nEYQFWnguGUuCBv75skCRgLdUK9vQwS+aoEPrYBANOIOINpAf6VTPf5IioGyN\nD6CbpL7Hel5siovRWP1SC+jnAipPY1sCusuYqTLj4Ju4n7yUKLLx8YmEp6al\nm6S9gK3wLsLebCbwnD6h9PzAseTIrpvVG4CypNstbMoCac+eWAFXWfvNb4Jb\ntnxKknbpSmjuiKdiiE6C3r9RrjtROrSo8ubwUbBXZElrwS8p0ivxTgHXuTAK\nOp9a+fzM/Mz8Zz/r9/1uuSWJybiv8fT6HgJOVOrZG2mwOt9HINvYjebeMZ1q\nvYPfPC16uKkLZg4bxeYSmh57rhGSFuRmXEVod0qjJPsrVPEm7nCWzbFwjIiJ\nk5cKNJLIyaNPEdaax6RV3L/YzIwNcZE1id8EwZkeBpfSEV0FyeRZwCtmx6R7\n1/x/0coq3reKp6+QsBiKji7u7WewjXn1W6qHKaDCx+z2SSslvstMgQq+0gHH\n/xOgDRM4NuaNQ8chz2fbgt3JwXkH1nYE303vH4IkphBgVa8CLPmpojln336G\nNrlcL2GowLhlzZopwX26bs7OdRvO81AigLb5vFuUhF+YTOdc1xHQMOvJ4cPQ\n9OpN\r\n=rSdx\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCRkpRZRcsAEeQ0z+QW8eFWFRyaJ5d1vvK8TLczTE90sAIgbTxPREV/iyKXJPHYCbShcUWyEGuqgzSgHD9zEedKetM="}]},"_npmUser":{"name":"vorlias","email":"vorlias.npm@outlook.com"},"directories":{},"maintainers":[{"name":"vorlias","email":"vorlias.npm@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zircon_0.20.0-dev-56edce6_1640827369791_0.15522033885704434"},"_hasShrinkwrap":false},"0.20.0-dev-0b57a82":{"name":"@rbxts/zircon","version":"0.20.0-dev-0b57a82","description":"\r \r\n ![](\"./assets/Example2.png\"/)
\r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n","readmeFilename":"README.md","gitHead":"0b57a82a5e98b94ae97819857db95e0de7330eec","_id":"@rbxts/zircon@0.20.0-dev-0b57a82","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-7SN7giEBbbbnLINLSqncmmbgvWlaeDdlMAma/DnZThnbWAjqm9oLjnfYj0SrGdL9HUNlmhoV1/Dx/fnjO6ddXg==","shasum":"e5d68ef0c45d70d2909818835bb5431bea229677","tarball":"https://registry.npmjs.org/@rbxts/zircon/-/zircon-0.20.0-dev-0b57a82.tgz","fileCount":126,"unpackedSize":314360,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhzTHQCRA9TVsSAnZWagAAnBkQAJ+DTIxqT1LjX76mb2Ee\nRPTgdvfcK5osAic8f2bvmHYdM6K2gpoUlbbcq/RBM78yiWWlGwMLVCRwkHD2\nkzA7jObI0WbtmQUpYW6S0hzQZFQucFbmqAKKjqPkEKhAq0acNop+jilVSh7I\naZ0iTJh+/ikjjxIxzwDqoCQCkj/HiDesN3TBM7csvfL3SGKK+K08/gtVoLZw\nGjR9UNHBWkt6db1nChIE5jk0O1mqD1i5LR4cbeTOp2eHmKDDTKDecmsJFgRu\nz5tLlwUCM0+VeV/qYMlu1IrmQGOlvzxQDWpgDed/DNUA2Fd/oAAmmVR93GAJ\nlWMJOD6c4Q2O2/gV3OYcGYy4lmQiSlag56pDQcZ4yb7J3NrpwxM72F7yHHse\nbd88QXdHAmUJvTi4QO65L/Z8iQ2CMdQu68iTIoO5I2DVTB9wUPyuswMtS7iU\n/OcyeVeKl9jLg7aRSItjB0063m4HPfTGweijsEMPEMC9cZcvFVh9Lk792H84\nW1HuqZ00fv2pv0O0/Q1HQ58Y7hTp1PtHJ2hJo0D+LPC4H1Di5Gfd/yxGj5sJ\nMoAhtHPpzsbHLf5L5Uebp6Kep5x/p37SpeEiwM0Xb/mJk+dBYjrAgLaC0lbC\n0erPhVdqVBmekyWxuqC5FeV0e47kYpZ3jX6CeOJsqXV2v/d7uS+fzLDX/jxY\nLgJE\r\n=b3sZ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFq3bAOHfiqHEtXDLBvZ8uXHFgTtOklX+FpblgV+n0pPAiEA3e1biA1cc0mCWrWcceMYK6snBPFNiji3H6QoMkjxZyI="}]},"_npmUser":{"name":"vorlias","email":"vorlias.npm@outlook.com"},"directories":{},"maintainers":[{"name":"vorlias","email":"vorlias.npm@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zircon_0.20.0-dev-0b57a82_1640837584767_0.5195253332252883"},"_hasShrinkwrap":false},"0.20.0-dev-0a6f56d":{"name":"@rbxts/zircon","version":"0.20.0-dev-0a6f56d","description":"\r \r\n \r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n\r\n# More Help & Links\r\n\r\n[Australis OSS Community](https://discord.gg/SvUcvTRjPZ)\r\n","readmeFilename":"README.md","gitHead":"0a6f56d01e4aa6485940e1abd7fe8998d9fff864","_id":"@rbxts/zircon@0.20.0-dev-0a6f56d","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-rNEq4j+VFEzG/hurWzN5MeoOI2deS3iTPRP8h6fplo0Y4HjLSCxdSWkpwZnIoHLQaWhooR/89GWZAEUujXI99w==","shasum":"b359f6e2bd075beda2771844cd5371febacefe23","tarball":"https://registry.npmjs.org/@rbxts/zircon/-/zircon-0.20.0-dev-0a6f56d.tgz","fileCount":126,"unpackedSize":316526,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhzWBVCRA9TVsSAnZWagAAP+AP/3+1Id6sxLZByUK3qbVS\nNQc8hOAvAbMbvfPWmj6K7XznMnNh9ksGs6rf26qlkvnqj9/K4phnap98G74c\n0AtNI+x8ancd1oC1ivcNDdYiyDYSt2ubOkWDFXAWPgoaOHA5BofErEuqKUc7\nei3sFCaIRUX8XSngQzYnUTVpDL5UAQb5kb5c2uLPbS49U/05N0L0LK2d13FO\nJTzfEg3l5q6jsoj/XQYS7e+7Zgga7ool3b+841zchehf5Y66a39pTy946n/D\nDYQBJVdbsNSIF94rcIVtvt0PiBluGsheVikquvamECSP9ID1cKUIuYxdxnnj\nX1IUacer+O8s7Z+gfIHTVG5wS+mWqOstMGjzbbsk1607V+sHsT1LR8M59HAG\nKKoQcrBh/baJci1G0p0wM00WiAyFnStFscVtvjQzHn0Xk8E+LtXP20Ep3WGk\n8R24CKmbpIqFRlSlq1n+JpbpWVttMBuitq6EARzCIla7UR3PLo8B4EzouGZn\nhI5+/e/jPD1K7lcMo8rUOJy7VZuirsOxR5i6nvKDSvGAWrWjLCsu07TcQUJI\nqYtl3fajO9YpXFPFqby227c6FVWEb52OcZNkPJX8QYTzI4Npb12JtmgtlG5W\nnBSOwJW8ZjMUCKpy2VlmA6nnXd3nfP2K26m1tQ7N4bG6x/Hd/luxo577RGQC\neA5W\r\n=Bkfn\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIB1ZKmdVaigRFAMZQMSIJ1Z3Ktf1guvqL5OAC3Gp8uynAiEA84VosIPTEGzTRpYofQNrCRyYz+GEPZHtQ9l0VuguVTA="}]},"_npmUser":{"name":"vorlias","email":"vorlias.npm@outlook.com"},"directories":{},"maintainers":[{"name":"vorlias","email":"vorlias.npm@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zircon_0.20.0-dev-0a6f56d_1640849493480_0.9163078023668958"},"_hasShrinkwrap":false},"0.20.0-dev-8dd8b18":{"name":"@rbxts/zircon","version":"0.20.0-dev-8dd8b18","description":"\r \r\n \r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n\r\n# More Help & Links\r\n\r\n[Australis OSS Community](https://discord.gg/SvUcvTRjPZ)\r\n","readmeFilename":"README.md","gitHead":"8dd8b18e7e31ac0b4c7ceffde5e221485867079d","_id":"@rbxts/zircon@0.20.0-dev-8dd8b18","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-1OnDw1Oj5xy9URZRen4bNgEMXRFEP+GW0sOLinM+hp4Nq9kYWv8lFnToFe6f9MkIoR/oxphxepYfIEPvN5cPgg==","shasum":"325ca0078d360b20e66c708c72bf1976003ec85c","tarball":"https://registry.npmjs.org/@rbxts/zircon/-/zircon-0.20.0-dev-8dd8b18.tgz","fileCount":126,"unpackedSize":316526,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhzX5GCRA9TVsSAnZWagAAxgsQAIAKgSF1Vbh0Md3N9RdQ\nbF9WCEfBTKgKyFDI8MnKpVrhcVSl02bzbUqyEGfKQT87REIlyNhaehp/w3qN\nYghuJk8XDCVCcMPrIol1CjHaa4yrjnDz5LrIlRHSFZfB1IBc2V3G5A4fisQW\nKF0VL/nY7otxLXIbAhStxKyxwMFFHd5KgivNCWtK9mkFsmiNnX0XS0mPm9ej\npNdjpKgK44HX0+RqhV69BrEfX1RphPj0+deIjG30DwWgBmmxrRHWGvWKWVDL\nSiMxLr1UIKe5+Vbc/PKgiN2UD4CVSueJnmJbAVH4ha7Vh0kU3Vi08cY0uxBS\noapO9N6S8AUk9iUJKYF2h6sAfAr3S5ZPD+5+Ck8mWdIWmBg2+UuGHF/NC+xR\nFJccra6+uUPXIdq9/oRxgooeDJfx4DcEhVFgz7H6qDh+A5xgNf80nW5YncrF\nKFDxVnDdek4Muh8eOZgkWJSqMkqVM/7cgo2fWu3jYqIPLawJfEx80Q/V0kOg\nYOD6cjLd78UJXDUcQ2Rxsc1aMXV2fqGsxazxfBaoLxaWPWqMoK75zWMUr9C2\nO4nohbdVF9KZlnPbi0TK3dZXPL4OCZzK9VVcl4qhJIoHG7F/m8E64MXMv4It\nmWOWs2agsYqYxV6nlLBMP0hsY2VDfcrGLOFoD/kI4/XkNbzaDocEsKPMMrY5\nRnnj\r\n=2suG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCjCtI+SiK7VqT33wVvI10LIMBMYHZ9k1X+DYE0WUc5cgIhAMOVqOHGWigSosjm1ZmUtR9jzS5K2/hcrJP81tO9gwQc"}]},"_npmUser":{"name":"vorlias","email":"vorlias.npm@outlook.com"},"directories":{},"maintainers":[{"name":"vorlias","email":"vorlias.npm@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zircon_0.20.0-dev-8dd8b18_1640857158475_0.21198138179267656"},"_hasShrinkwrap":false},"0.20.0-dev-35f1c60":{"name":"@rbxts/zircon","version":"0.20.0-dev-35f1c60","description":"\r \r\n \r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n\r\n# More Help & Links\r\n\r\n[Australis OSS Community](https://discord.gg/SvUcvTRjPZ)\r\n","readmeFilename":"README.md","gitHead":"35f1c60d318827eb8d64b57fb3646c7067c03b46","_id":"@rbxts/zircon@0.20.0-dev-35f1c60","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-pcM41JyXsX0hCH2t2yQLAuC9dnNv2SRvHUp3Bg0CBWJBZhYAN5kkQMqDsyXlPjh9abCvsN4NbWfPbOY95XGOeg==","shasum":"8dccd17092a81d8639d3968b12f54c5750c60a76","tarball":"https://registry.npmjs.org/@rbxts/zircon/-/zircon-0.20.0-dev-35f1c60.tgz","fileCount":128,"unpackedSize":324780,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh2DyfCRA9TVsSAnZWagAAAHgP/Rr7ZN/oNPEitzSpQVoQ\nrctHfYp2CJoISPLoawNnT1iAAeRB//oA5yhU8a72CzB2uOBXjOjz67iIsnum\nUFrste0Re/ZahpFL34qdsWaQ41D/DC6kzFm8XRHRcXC6tO2w1oOauuS8Xx72\nJGYQeYJSg8DMg0VpzXDO0EbhhQMn2PAJ2sbIt4t1VwdGn1ZPpYv8aNsw5QNo\nadkLaOmgY89H0NLARARDEKOL7afhuDWqkruQ86WG9BWHRhaYeKF0AxTvF7+J\n10VVxPysXCyTHNOxa9o/tXWrp8QxLmc9gglpQ2F3aAboxtXnxsF8u8+t6qkf\ndVejXRYCIhNCJ9IVkO++2FTo+MM0fmOlJD0gJicfat6ZrOL9Z2hi7WDGfaH1\nynZAh0TQTcPIXBGFlDvTKQyYOrdNMszKzB4lA9xOGQ/5o55KPlDfdvqaanQQ\n0x7MxvIDCRewtwzgOju5ITrzRuJX7/jwt8vVkoyAl7FYcunCGZNzhByE/6BM\nwrvgyCo4XotPzMZUC86de3iMWa6zUugIrIr5lM+JjYF9ieYLo39xOfsRhyu9\n6fbH1wgvtnrU97ALU5/aUkf38MT4CiQB7tVP1JrKKIf2fLOP8wk+5VRsnQQZ\nDW5lSIHfa0YLv8Cb2n7h/zCJvQL9eg1d83Urjqp62zQj9rrpWh+5FHrsGLtZ\nE/C/\r\n=iaYN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHt14UAKtvAJE8XLgCcFOw1JtswYnhHak8Ul6zRnXRRsAiEAg8ky8DyMUV3bixVUiNhpFYfYmN02aFs7t1ACJRNG1ro="}]},"_npmUser":{"name":"vorlias","email":"vorlias.npm@outlook.com"},"directories":{},"maintainers":[{"name":"vorlias","email":"vorlias.npm@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zircon_0.20.0-dev-35f1c60_1641561247449_0.7180247802615678"},"_hasShrinkwrap":false},"0.20.0-dev-a4aa7c2":{"name":"@rbxts/zircon","version":"0.20.0-dev-a4aa7c2","description":"\r \r\n \r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n\r\n# More Help & Links\r\n\r\n[Australis OSS Community](https://discord.gg/SvUcvTRjPZ)\r\n","readmeFilename":"README.md","gitHead":"a4aa7c2e810d4fab446efce3a843407d297b3163","_id":"@rbxts/zircon@0.20.0-dev-a4aa7c2","_nodeVersion":"16.13.1","_npmVersion":"8.1.2","dist":{"integrity":"sha512-oMgvZWjwoe6x111AgDOTFzuNqIZ558/EM0hwABE+CDeqFWw6TdUzmC10IHFft1XTg2RTXl03z1OOZmxqpTsTNA==","shasum":"e6d295729715bffa9dca727feab84cf4690c0383","tarball":"https://registry.npmjs.org/@rbxts/zircon/-/zircon-0.20.0-dev-a4aa7c2.tgz","fileCount":130,"unpackedSize":332407,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh2OVJCRA9TVsSAnZWagAAUrIP/iPIJtLgf21MkrOI64G4\n/+zdEC3gTxmqnkk8tAakYoipYsEqmCQMQNKr61Y4KFf3MGYClKr12q7OZt7A\nYkRvLxnsKsU/ECvoBhxPRel9YxA3R1sKsUcOOJ1A1YDpBdG0Aqmvi2d7vBBj\nC/1QD7rIbaPPyWy41GeET9JTQqC1q5I4c+v9ckRu9Q0dZERDz7IRux+F55Mi\nMAYWIuBE7sRK2v5ThnyfWjIIh/eCF65RzS+/2sPHc8+A/I1Dgwm76Iu8EnrN\nr8xm73+lXl2JgVnxTzxAN5Q0bPd8HSr91bVsouY0/EQY8uNtoeV9woFy5gqZ\nbJjxDRR60Br5P/PBdVg3uXFgEZfi8gihn4yrSO42aY0d5B84N4ip/2aRK0pu\nX9rtCMbaRDGAMb64NQgUhzl6Y4zsTiS1TQx8GCSMB0QLdwC1VIokKaVW0Iv1\nrjwGYqOnL7+B70/8Up0pptMeXhPw3yCEgy/ToeC2BJvEUDgirRYee5yVosZn\nzeOwIc4fn/Hfi5PnheRva1Kmb6O8L+cfBBzsKbgvxjXtjnlI5Nalh5N/WhZl\nt2WXoCzGw0dHtDQOPwRobHduOBnZcO2NWyLb3htERl5ssQuFIewaja4umky/\n8v11d5A3KeW7qSeQoeMnFWN75Xt6j1bEnB/IspHf6DpYwEULiog0ddLJhn+o\ncJ3/\r\n=HJft\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCqe8ExmFGWzTpK4VyX9PCuQaK3YwcohEddTtbpzDuJMAIhAKfNxOt16m/rgNfoA0TJTBaPfeDAPZoy5G0F5vvR6G4P"}]},"_npmUser":{"name":"vorlias","email":"vorlias.npm@outlook.com"},"directories":{},"maintainers":[{"name":"vorlias","email":"vorlias.npm@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/zircon_0.20.0-dev-a4aa7c2_1641604425254_0.7352437761609092"},"_hasShrinkwrap":false},"0.20.1":{"name":"@rbxts/zircon","version":"0.20.1","description":"\r ![](\"https://badge.fury.io/js/@rbxts%2Fzircon.svg\"/){kind=icon}
\r \r \r \r \r \r \r \r \r \r \r \r \r \r\n \r\n ![](\"https://raw.githubusercontent.com/roblox-aurora/zircon/master/assets/Example2.png\"/)
\r\n\r\n## Setup\r\nTo begin, it is recommended to do\r\n```\r\nnpm i @rbxts/zircon @rbxts/log\r\n```\r\n\r\nThis will install both Zircon, as well as the logging support. It is recommended to use the logging as it can be filtered easily through the Zircon console.\r\n\r\n## Features\r\n- ### Zirconium Language Scripting\r\n Zircon comes inbuilt with a runtime scripting language called [Zirconium](https://github.com/roblox-aurora/zirconium). This allows you to run scripts against your game during runtime.\r\n\r\n More information on how to set this up, will come when Zircon is closer to being production-ready.\r\n\r\n Supports:\r\n\r\n - Functions\r\n \r\n Using `ZirconServer.Registry.RegisterFunction` + `ZirconFunctionBuilder`\r\n - Namespaces\r\n \r\n Using `ZirconServer.Registry.RegisterNamespace` + `ZirconNamespaceBuilder`\r\n - Enums\r\n \r\n Using `ZirconServer.Registry.RegisterEnum` + `ZirconEnumBuilder`\r\n- ### Structured Logging\r\n If you want logging for Zircon, you will need to install [@rbxts/log](https://github.com/roblox-aurora/rbx-log).\r\n\r\n Then to use Zircon with Log, you simply do \r\n ```ts\r\n import Log from \"@rbxts/log\";\r\n import Log, { Logger } from \"@rbxts/log\";\r\n import Zircon from \"@rbxts/zircon\";\r\n\r\n Log.SetLogger(\r\n Logger.configure()\r\n // ... Any other configurations/enrichers go here.\r\n .WriteTo(Zircon.Log.Console()) // This will emit any `Log` messages to the Zircon console\r\n .Create() // Creates the logger from the configuration\r\n );\r\n ```\r\n\r\n This will need to be done on both the _client_ and _server_ to achieve full logging.\r\n\r\n All logging done through this can be filtered through the console itself. That's the power of structured logging! ;-)\r\n\r\n## Registering and using Zircon Commands\r\nBelow is an example of how to register a command in Zircon:\r\n\r\n```ts\r\nimport { \r\n ZirconServer,\r\n ZirconFunctionBuilder,\r\n ZirconDefaultGroup,\r\n ZirconConfigurationBuilder\r\n} from \"@rbxts/zircon\";\r\nimport Log from \"@rbxts/log\";\r\n\r\nconst PrintMessage = new ZirconFunctionBuilder(\"print_message\")\r\n .AddArguments(\"string\")\r\n .Bind((context, message) => Log.Info(\r\n \"Zircon says {Message} from {Player}\", \r\n message,\r\n context.GetExecutor()\r\n ));\r\n\r\nconst CreatorCommand = new ZirconFunctionBuilder(\"kill\")\r\n .AddArguments(\"player\")\r\n .Bind((context, player) => {\r\n const character = player.Character;\r\n if (character) {\r\n character.BreakJoints()\r\n }\r\n });\r\n\r\nZirconServer.Registry.Init(\r\n new ZirconConfigurationBuilder()\r\n // Creates a 'creator' group\r\n .CreateDefaultCreatorGroup()\r\n // Creates a 'user' group\r\n .CreateDefaultUserGroup()\r\n // Adds an executable function called 'print_message', allowed to be executed by `User` (everyone)\r\n .AddFunction(PrintMessage, [ZirconDefaultGroup.User])\r\n // Adds an executable function called 'kill' that can only be executed by a creator of the place.\r\n .AddFunction(CreatorCommand, [ZirconDefaultGroup.Creator])\r\n // Builds the configuration for Zircon\r\n .Build()\r\n);\r\n```\r\n\r\nThis will create a global `print_message` that all players can run.\r\n\r\nThen if run in Zircon:\r\n\r\n![](\"https://raw.githubusercontent.com/roblox-aurora/zircon/master/assets/Example1.png\"/)
\r\n\r\nThe first argument of `RegisterFunction` takes a `ZirconFunctionBuilder` - which is the easiest way to build a function. `AddArguments` takes any number of arguments for types you want, in built types in Zircon you can use a string for. Otherwise you supply the type validator object.\r\n\r\n# Troubleshooting\r\n### Attempted to call AsyncFunction 'ZrSOi4/GetZirconInit' - which has no user defined callback\r\n- You need to call `ZirconServer.Registry.Init` - an example of that can be found [here](https://github.com/roblox-aurora/zircon-example/blob/master/src/server/main.server.ts#L20)\r\n### Unhandled promise rejection: ... Component returned invalid children ...\r\n- You need to update your version of roact to the latest. That can be done via `npm i @rbxts/roact@latest`.\r\n\r\n# More Help & Links\r\n\r\n[Australis OSS Community](https://discord.gg/SvUcvTRjPZ)\r\n","readmeFilename":"README.md","author":{"name":"Vorlias"}}