{"id":15578900,"url":"https://github.com/tlsa/sgdk-helper","last_synced_at":"2025-03-29T07:44:17.258Z","repository":{"id":181693862,"uuid":"667150977","full_name":"tlsa/sgdk-helper","owner":"tlsa","description":"Helper script for working with SGDK on Linux","archived":false,"fork":false,"pushed_at":"2025-03-19T09:12:40.000Z","size":33,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-19T10:25:04.596Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tlsa.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2023-07-16T20:03:07.000Z","updated_at":"2025-03-19T09:12:45.000Z","dependencies_parsed_at":"2025-02-03T21:37:02.784Z","dependency_job_id":"a24f586d-6956-407b-911e-207f4fffe5a0","html_url":"https://github.com/tlsa/sgdk-helper","commit_stats":null,"previous_names":["tlsa/sgdk-helper"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlsa%2Fsgdk-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlsa%2Fsgdk-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlsa%2Fsgdk-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlsa%2Fsgdk-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tlsa","download_url":"https://codeload.github.com/tlsa/sgdk-helper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246156029,"owners_count":20732359,"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-10-02T19:13:17.575Z","updated_at":"2025-03-29T07:44:17.246Z","avatar_url":"https://github.com/tlsa.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SGDK Helper\n\nThis is a helper script for developing on Linux with Stephane Dallongeville's\nexcellent [SGDK](https://github.com/Stephane-D/SGDK).\n\nTo generate a suitable cross compiler, SGDK Helper uses Andrew DeRosier's\n[m68k-gcc-toolchain](https://github.com/andwn/m68k-gcc-toolchain) Makefile.\n\n## Usage\n\nSGDK Helper supports both containerized and native workflows. The advantage\nof the former is you don't need to install loads of dependencies on your\nmachine, just a container tool.\n\nTo check if you have a container tool run:\n\n```bash\n./sgdk-helper.sh container_tool\n```\n\nIt will report `podman` or `docker` if you have either tool installed.\n\n\u003e **Note:** If you have both, `podman` is used in preference.\n\nIf you don't have one, either install one now or continue with native setup. To\ninstall `podman` on a Debian based system, run:\n\n```bash\nsudo apt install podman\n```\n\n### Container setup\n\nWe build our own container with the dependencies we need for SGDK development\nbased on a slimmed down Debian container.\n\n```bash\n./sgdk-helper.sh container\n```\n\n### Native setup\n\n```bash\n./sgdk-helper.sh toolchain\n./sgdk-helper.sh deps\n```\n\n## SGDK development\n\nNow that the setup is complete, we can use SGDK Helper for development of\na Mega Drive project.\n\nFrom the top directory of an SGDK project, build the ROM with:\n\n```bash\nsgdk-helper.sh rom\n```\n\n\u003e **Note:** An SGDK project looks like this\n\u003e [example](https://github.com/Stephane-D/SGDK/tree/master/sample/sonic) from\n\u003e SGDK. There are many others both in the SGDK project and around GitHub.\n\nAnd you can run the built ROM in [BlastEm](https://www.retrodev.com/blastem/),\nif it's installed natively, with:\n\n```bash\nsgdk-helper.sh run\n```\n\n\u003e **Note:** Further documentation coming soon.\n\u003e For now, see the documentation in the script.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftlsa%2Fsgdk-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftlsa%2Fsgdk-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftlsa%2Fsgdk-helper/lists"}