{"id":"blinkybool/testpackage","name":"testpackage","scope":"blinkybool","platform":"roblox","description":"Mirrored from the Wally registry.","version":"0.1.3-rc.5","latest":"0.1.3-rc.5","versions":["0.1.0-rc1","0.1.1-dev1","0.1.1-dev2","0.1.1-dev3","0.1.1-rc1","0.1.1-rc10","0.1.1-rc2","0.1.1-rc3","0.1.1-rc4","0.1.1-rc5","0.1.1-rc6","0.1.1-rc7","0.1.1-rc8","0.1.1-rc9","0.1.2-rc1","0.1.2-rc2","0.1.3-rc.1","0.1.3-rc.2","0.1.3-rc.3","0.1.3-rc.4","0.1.3-rc.5"],"license":"AGPL-3.0","licenseRating":"unsafe","licenseCaveats":["Strongest copyleft: even network use counts as distribution, so running this in a live game plausibly requires releasing your game's entire source under AGPL-3.0. Not recommended for closed-source projects.","License identified from the packaged LICENSE file; the manifest declared none."],"licenseVerified":true,"dependencies":{"blinkybool/feather":{"version":"^0.1.0","alias":"Feather"},"stravant/goodsignal":{"version":"^0.2.1","alias":"GoodSignal"},"evaera/promise":{"version":"^4.0.0","alias":"Promise"},"roblox/roact":{"version":"^1.4.4","alias":"Roact"},"csqrl/sift":{"version":"^0.0.4","alias":"Sift"}},"integrity":"bd5b14b75c44ca9765c6761a6e16c5cae7e06e1fd289d7d68719e1d859dac973","likes":0,"downloads":0,"install":"forest install blinkybool/testpackage","url":"https://forest.dev/p/roblox/blinkybool/testpackage","files":"https://api.forest.dev/ai/package/roblox/blinkybool/testpackage/files","readme":"# metaboard\n\nMultiplayer drawing boards for sharing knowledge in Roblox.\n\n![](./metaboard-cover.png)\n\n## Installation\n\nThere are two components to install: the metaboard backend code, and a metaboard model to draw on.\n\n<!-- ### From Roblox - WARNING: NOT UP TO DATE\nYou can find [metaboard](https://www.roblox.com/library/8573087394/metaboard) in Roblox Studio by searching \"metaboard\" in the Toolbox.\nDouble-click it to insert it (it will appear under `Workspace`) and then move it to `ServerScriptService`. This contains the Scripts,\nLocalScripts and Guis for handling all metaboard interaction, which are automatically\ndistributed when you start your Roblox game.\nYou will need to manually update this file if you want the newest release. -->\n\n### From Github Releases\nDownload the [latest release](https://github.com/metauni/metaboard/releases/latest) (look for `metaboard-v*.rbxm`). In Roblox Studio, right click on `ServerScriptService`, click `Insert from File` and insert the `metaboard-v*.rbxm` file. This contains the Scripts,\nLocalScripts and Guis for handling all metaboard interaction and DataStore persistence.\nYou will need to manually update this file if you want the newest release.\n\n## Adding boards to your game\n\n[metauni](https://www.roblox.com/groups/13108882/metauni#!/about) maintains a few example boards you can use.\nThe easiest method to add these in Roblox Studio is to go to `Toolbox > Marketplace` and search \"metaboard\".\n\n- [WhiteBoard](https://www.roblox.com/library/8543134618/metaboard-WhiteBoard)\n- [BlackBoard](https://www.roblox.com/library/8542483968/metaboard-BlackBoard)\n- [TechBoard](https://www.roblox.com/library/8543176248/metaboard-TechBoard)\n\t- This is really two boards, both the `FrontBoard` and `BackBoard` are tagged as metaboards.\n\nDon't be afraid to resize and stretch these boards as you please!\n\n## Board Structure\n\nA metaboard can be either a `Part` or a `Model` with a `PrimaryPart` (the latter is recommended).\nTo turn a `Part`/`Model` into a metaboard, use the [Tag Editor](https://devforum.roblox.com/t/tag-editor-plugin/101465)\nplugin to give it the tag `\"metaboard\"`. Then add any of the following optional\nvalues as children.\n\n| Object      | Name        | Value | Description |\n| ----------- | ----------- | ----------- | ----- |\n| StringValue | Face        | `String` (one of \"Front\" (default), \"Back\", \"Left\", \"Right\", \"Top\", \"Bottom\") | The surface of the part that should be used as the board |\n\nIf the metaboard is a `Model`, the `PrimaryPart` should be set to the part which defines the drawing surface of the model (make sure the right `Face : StringValue` is configured).\n\nFor more customised positioning of the board, make an invisible part for the board and size/position it on your model however you like (you should tag the parent model as the metaboard, not the invisible part, and remember to set the invisible part as the `PrimaryPart`).\n\n## Custom Configuration\n\nAll of the configuration values used in metaboard are stored in a ModuleScript at `metaboard -> metaboardCommon -> Config`. There are cases where you may want to\nuse different config values on a per-place basis. Instead of modifying the `Config` script, you can copy the ModuleScript called `metaboardPlaceConfig` from `metaboard` to `ReplicatedStorage`. This ModuleScript returns a function which takes the config table as its argument and modifies the keys (no return value). All scripts that import the original Config file will receive the table with these edits applied (but only if `metaboardPlaceConfig` is a child of `ReplicatedStorage`).\n\nYou can keep this same config file around when you update the metaboard package.\n\n## Persistent Boards\n\nAny metaboard can be synced to a DataStore so that it retains its contents across server restarts.\n\nBy default, metaboard uses a datastore called `\"MetaboardPersistence\"` to save and restore board data. You can configure which datastore is used in `metaboardPlaceConfig`. For example you could use a different datastore for each place. There you can also set `Config.Persistence.ReadOnly` to `true`, so that you can see and draw on the existing boards in Studio without modifying anything in the datastore.\n\nNote that `Config.Persistence.DataStoreName` is ignored in pockets, where automatic naming is used.\n\nTo enable persistence for a board, create an `IntValue` under the board called `PersistId` and choose a unique value. This value is used to determine the key in the datastore where the board data will be saved, so it must be unique to prevent overwriting another board's data. You should also keep track of keys you've used in the past for the same reason.\n\nSince persistent boards use the Roblox DataStore API there are several limitations you should be aware of:\n\n<!-- * In private servers the DataStore key for a board is of the form \"ps<ownerId>:metaboard<PersistId>\". Since keys for DataStores cannot exceed `50` characters in length, and player Ids are (currently) eight digits, that means that you should keep `PersistId`'s to `30` digits or less. -->\n\n* The DataStore keys for persistent boards are the same in any live server, and `SetAsync` is currently used rather than `UpdateAsync`, so there is a risk of data corruption if two players in different servers attempt to the use the \"same\" persistent board. We strongly recommend therefore that you reserve use of persistent boards to *private servers*.\n\n* Changed persistent boards are autosaved by default every `30sec` - this can be modified (see [Custom Configuration](#custom-configuration)).\n\n* On server shutdown there is a 30sec hard limit, within which all boards which have changed after the last autosave must be saved if we are to avoid dataloss. A full board costs about 1.2sec to save under adversarial conditions (i.e. many other full boards). So if we assume we have 20 of those 30 seconds for metaboard shutdown, we can afford at most 16 changed boards per autosave period. There is a budget for datastore requests, but the more likely bottleneck is save time per-board.\n\n## License\n\nmetaboard uses the MPL-2.0 License. See [LICENSE](./LICENSE).\n\nExternal packages used in metaboard can be found under [packages](./packages/), and license information for those packages in [packages/LICENSES.md](packages/LICENSES.md).","readmeTruncated":false}