{"id":"borritomes/vconsole","name":"vconsole","scope":"borritomes","platform":"roblox","description":"Mirrored from the Wally registry.","version":"0.2.1","latest":"0.2.1","versions":["0.1.5","0.1.6","0.1.7","0.1.8","0.2.0","0.2.1"],"license":"MIT","licenseRating":"safe","licenseCaveats":["License identified from the packaged LICENSE file; the manifest declared none."],"licenseVerified":true,"dependencies":{},"integrity":"cb344f73c006514c18ec605852efffad0cc639088a3aeebe9698b13c2f3ac068","likes":0,"downloads":0,"install":"forest install borritomes/vconsole","url":"https://forest.dev/p/roblox/borritomes/vconsole","files":"https://api.forest.dev/ai/package/roblox/borritomes/vconsole/files","readme":"# this project is unlikely to recieve any updates in the future\n\n# Important\n- **I haven't tested this very thoroughly so there will probably be bugs**\n- There is no console interface, you will have to make one yourself.\n- There is also no autocomplete.\n\n## Installation\n\nWally:<br>\n```vconsole = \"borritomes/vconsole@0.1.7\"```<br>\nManual:<br>\ncopy and paste\n\n## How to use\n\n### Running commands\n\n**commands have a character limit of 1024 characters. This can be changed by editing vconsole._MAX_COMMAND_LENGTH**<br>\nCommands are run with `vconsole.runCommand`.\n\n### Registering commands\n\nCommands are registered with `vconsole.registerCommand`. Commands are created with the `vconsole.createCommand` contructor.<br>\n\nExample:\n```lua\nargs = vconsole.args\n\nvconsole.registerCommand(\"sv_cheats\", vconsole.createCommand(\n  function()\n    --set cheats to true\n  end,\n  {\n    args.boolean\n  },\n  --protection\n  --an optional callback to check if a the command should be ran\n  function()\n    if canUseCommand then\n      return true\n    else\n      return false\n    end\n  end,\n)\n```\n\n### Args\n\nArgs is a simple type checker/converter<br>\nwill return a result (boolean) and value converted from string<br>\nwill fail by returning false if string can not be converted\n\n### Aliases\n\nAlias work mostly the same as in the source engine developer console.\n\n#### Registering aliases\n\nAliases are registered with `vconsole.registerAlias`, it takes the alias name as the first parameter and the alias' value as the second.\n\n#### Cross session alias storage\nAliases are **not** automatically saved across sessions. `vconsole.getAliases` can be used to get a map of all registerd aliases, the map can then be stored in a datastore. `vconsole.importAliases` can be used to import a map of aliases usually used for imported aliases saved in datastores.\n\n*there are a few other things you can do that aren't documented. You'll have to look through the code for that*\n","readmeTruncated":false}