{"id":13337695,"url":"https://github.com/fiskWasTaken/tic80-export","last_synced_at":"2025-03-11T07:30:43.905Z","repository":{"id":58671968,"uuid":"533028083","full_name":"fiskWasTaken/tic80-export","owner":"fiskWasTaken","description":"TIC-80 lua export companion","archived":false,"fork":false,"pushed_at":"2022-09-06T00:55:12.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-07-30T20:53:49.603Z","etag":null,"topics":["lua","tic-80"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/fiskWasTaken.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}},"created_at":"2022-09-05T19:09:29.000Z","updated_at":"2022-09-05T22:12:43.000Z","dependencies_parsed_at":"2023-01-17T20:50:25.125Z","dependency_job_id":null,"html_url":"https://github.com/fiskWasTaken/tic80-export","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiskWasTaken%2Ftic80-export","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiskWasTaken%2Ftic80-export/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiskWasTaken%2Ftic80-export/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiskWasTaken%2Ftic80-export/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fiskWasTaken","download_url":"https://codeload.github.com/fiskWasTaken/tic80-export/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242991110,"owners_count":20218103,"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","tic-80"],"created_at":"2024-07-29T19:14:56.001Z","updated_at":"2025-03-11T07:30:43.601Z","avatar_url":"https://github.com/fiskWasTaken.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tic80-export\n\nA bash executable that will help you with TIC-80 exports. This script will:\n\n* Inline all your external .lua includes.\n* Optionally export the project from the CLI edition of TIC-80. \n\nThis is intended for .lua carts which are available on the Pro version of TIC-80.\n\nTIC-80 currently won't flatten your lua includes. This means if you try to export your project, it won't include your imported modules. This script aims to provide a general-purpose solution that should help with the development and release of larger TIC-80 projects.\n\n## Rationale\n\nYou may have came across [the instructions on the TIC-80 wiki](https://github.com/nesbox/TIC-80/wiki/Splitting-a-TIC-80-project-into-multiple-files#combining-files-back-to-one), but this process looks annoying and bug-prone for larger projects. So, I've tried to provide a general-purpose script that'll handle this nicely (until a time comes where TIC-80 can support this better). \n\n## Installation\n\n1. Install [luarocks](https://luarocks.org/)\n2. Clone this repository and, preferably, somehow add tic80-export to your PATH.\n\n## Assumptions\n\nFor this script to work, these assumptions about your environment must be met:\n\n* Your project and any library subfolders are contained in the same directory.\n* Your game-specific libraries are inside a directory named without the .lua extension (e.g. `pacman.lua` would have those includes inside `pacman`). \n* Your generic libraries are in a directory called `lib`.\n\nIf the head of your project looks something like this:\n\n```lua\n-- desc:    Thing\n-- site:    https://fisk.cc\n-- license: MIT License\n-- version: 0.1\n-- script:  lua\n\npackage.path = package.path..\";/path/to/TIC-80/?.lua\"\n\nrequire(\"lib/a\")\nrequire(\"lib/b\")\n```\n\nYou should be good to go.\n\n## Usage\n\n1. Open the working directory for your project.\n2. Run the script as `tic80-export file` where `file` is the name of your .lua project without the extension.\n3. Project will be exported to game_export.lua.\n4. Optionally, provide an export option as the second argument. This will require tic80 to be in your PATH.\n\n## Caveats\n\nThis will include EVERY library under the two directories configured. I probably won't change this, because:\n* You might be programatically including files for whatever reason.\n* TIC-80's code limits are so large, optimising for character count is largely irrelevant (unlike in Pico-8).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FfiskWasTaken%2Ftic80-export","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FfiskWasTaken%2Ftic80-export","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FfiskWasTaken%2Ftic80-export/lists"}