{"id":19001686,"url":"https://github.com/itzkiwisky/progressutilities-lua","last_synced_at":"2025-02-21T13:25:55.773Z","repository":{"id":132756075,"uuid":"384582816","full_name":"itzKiwiSky/ProgressUtilities-Lua","owner":"itzKiwiSky","description":"created with learning purposes, feel free to use on your projects =3","archived":false,"fork":false,"pushed_at":"2021-07-29T20:03:58.000Z","size":31,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-01T18:33:14.529Z","etag":null,"topics":["lua","terminal"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itzKiwiSky.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-10T01:04:41.000Z","updated_at":"2023-07-11T20:05:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"7d58d9c4-80c0-4a07-adb3-3fbd879bdff5","html_url":"https://github.com/itzKiwiSky/ProgressUtilities-Lua","commit_stats":null,"previous_names":["itzkiwisky/progressutilities-lua"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itzKiwiSky%2FProgressUtilities-Lua","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itzKiwiSky%2FProgressUtilities-Lua/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itzKiwiSky%2FProgressUtilities-Lua/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itzKiwiSky%2FProgressUtilities-Lua/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itzKiwiSky","download_url":"https://codeload.github.com/itzKiwiSky/ProgressUtilities-Lua/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240021082,"owners_count":19735282,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lua","terminal"],"created_at":"2024-11-08T18:12:21.263Z","updated_at":"2025-02-21T13:25:55.738Z","avatar_url":"https://github.com/itzKiwiSky.png","language":"Lua","readme":"# ProgressUtilities-Lua\n\nCreated just for learning purposes, but feel free to use in your projects, change the code and redistribute.\nany mention or credit is highly appreciated =3\n\n# Simple Documentation\n\nSome functions will be explained here:\n\n# progress.Create\n\nUse: ```progress.Create(wait-time)```\n\nThis function start the progress counter on your project.\nIt only require **one** input, this input is the wait time or wait seconds\n\n**Example**:\n```progress.Create(1)```\n\nEvery **1** second(s) this will add a value to progress.\n\n# progress.Edit\n\nUse: ```progress.Edit(ValueName, Value)```\n\nThis function is used to edit some values you want, to create your progress.\n\n**Example**:\n\n```progress.Edit(AddValue, 4)```\n\nOn function ```progress.Create()``` it will add 4 to value every time.\n\n**Example2**:\n```lua\nprogress.AddValue(5)                -- edit value \"AddValue\"\nprogress.WaitTime(0.1)              -- edit value \"WaitTime\"\nprogress.Create(0)                  -- Create the progress\n```\nYou can create a simple function to help with this setup\n\n**Example 3**:\n``` lua\nfunction setup()\n    progress.AddValue(5)\n    progress.WaitTime(0.1)\n    progress.MaxValue(100)\n    progress.Message(\"Loading Content.\")\n    progress.Style(4)    \nend\n```\n\n**Output**:\n```\n====================================\n    Loading your content (45%)\n====================================\n```\n\nThese function are made to edit the progress content:\n\n```lua\nprogress.AddValue()             -- This function add to counter\nprogress.WaitTime()             -- This function is a sleep function to wait.\nprogress.MaxValue()             -- Set the maximum value, and if the counter reach this value it will be stopped\nprogress.Message()              -- Set your custom loading message\nprogress.Style()                -- Select the style, for now available [0, 1, 2, 3]\n``` \n\n# Debug functions (Optional)\n\n````lua\nprogress.ForceDraw()            -- This function force draw the loading style\nprogress.ValueTable()           -- This function will only show the variables\n````\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitzkiwisky%2Fprogressutilities-lua","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitzkiwisky%2Fprogressutilities-lua","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitzkiwisky%2Fprogressutilities-lua/lists"}