{"id":19457948,"url":"https://github.com/sharparam/cc-api","last_synced_at":"2025-08-21T23:19:03.319Z","repository":{"id":236060127,"uuid":"785836217","full_name":"Sharparam/cc-api","owner":"Sharparam","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-27T18:13:43.000Z","size":215,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-08T01:52:29.524Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sharparam.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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},"funding":{"community_bridge":null,"github":["Sharparam"],"issuehunt":null,"ko_fi":"sharparam","liberapay":"Sharparam","open_collective":null,"otechie":null,"patreon":null,"tidelift":null,"custom":["https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=5SCGZ5FTAQM38\u0026currency_code=EUR"]}},"created_at":"2024-04-12T18:16:48.000Z","updated_at":"2024-04-27T18:13:46.000Z","dependencies_parsed_at":"2024-04-27T19:26:14.431Z","dependency_job_id":null,"html_url":"https://github.com/Sharparam/cc-api","commit_stats":null,"previous_names":["sharparam/cc-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sharparam%2Fcc-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sharparam%2Fcc-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sharparam%2Fcc-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sharparam%2Fcc-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sharparam","download_url":"https://codeload.github.com/Sharparam/cc-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240662435,"owners_count":19837366,"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":[],"created_at":"2024-11-10T17:24:43.304Z","updated_at":"2025-02-25T11:41:35.351Z","avatar_url":"https://github.com/Sharparam.png","language":"Lua","funding_links":["https://github.com/sponsors/Sharparam","https://ko-fi.com/sharparam","https://liberapay.com/Sharparam","https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=5SCGZ5FTAQM38\u0026currency_code=EUR"],"categories":[],"sub_categories":[],"readme":"# Cc::Api\n\nWork-in-progress project to generate LuaLS library files for CC: Tweaked (and some supported mods).\n\nCurrently (2024-04-12), all the library files are handwritten, sometimes with some help from generator tools.\n\n## Installation\n\nTODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.\n\nInstall the gem and add to the application's Gemfile by executing:\n\n    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG\n\nIf bundler is not being used to manage dependencies, install the gem by executing:\n\n    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG\n\n## Usage\n\n### LuaLS\n\nAdd the path to the `api` folder in this repo to your Lua settings in VS Code:\n\n```json\n{\n  \"Lua.workspace.library\": [\n    \"/path/to/this/repo/api\"\n  ]\n}\n```\n\n## Mod support\n\n - CC APIs from Mekanism\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies.\nThen, run `rake spec` to run the tests.\nYou can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`.\nTo release a new version, update the version number in `version.rb`,\nand then run `bundle exec rake release`, which will create a git tag for the version,\npush git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n### Generating Mekanism API files\n\nIn-game, in a CC computer, run the dump script in `vendor/mekanism/dump.lua`\nto generate the help files for all necessary Mekanism blocks.\n\nThen extract the Lua files it generated by going into the world save folder,\nfinding the folder for the computer you were using, and grabbing the files\nfrom the `dump` folder.\n\nPlace them into the `vendor/mekanism` folder in this repo to update them.\n\nRun `bundle exec exe/cc-api` to generate new API files to `out/mekanism`.\n\nThen check if any of the existing mekanism files in `api/mekanism` need updating.\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/Sharparam/cc-api.\n\n## License\n\nCopyright \u0026copy; 2024 by [Adam Hellberg][sharparam].\n\nThis Source Code Form is subject to the terms of the Mozilla Public\nLicense, v. 2.0. If a copy of the MPL was not distributed with this\nfile, You can obtain one at http://mozilla.org/MPL/2.0/.\n\n[sharparam]: https://sharparam.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharparam%2Fcc-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsharparam%2Fcc-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharparam%2Fcc-api/lists"}