Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tlsa/sgdk-helper
Helper script for working with SGDK on Linux
https://github.com/tlsa/sgdk-helper
Last synced: about 1 month ago
JSON representation
Helper script for working with SGDK on Linux
- Host: GitHub
- URL: https://github.com/tlsa/sgdk-helper
- Owner: tlsa
- License: isc
- Created: 2023-07-16T20:03:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-20T19:58:21.000Z (over 1 year ago)
- Last Synced: 2024-12-06T20:58:42.470Z (about 1 month ago)
- Language: Shell
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SGDK Helper
This is a helper script for developing on Linux with Stephane Dallongeville's
excellent [SGDK](https://github.com/Stephane-D/SGDK).
To generate a suitable cross compiler, SGDK Helper uses Andrew DeRosier's
[m68k-gcc-toolchain](https://github.com/andwn/m68k-gcc-toolchain) Makefile.
## Usage
SGDK Helper supports both containerized and native workflows. The advantage
of the former is you don't need to install loads of dependencies on your
machine, just a container tool.
To check if you have a container tool run:
```bash
./sgdk-helper.sh container_tool
```
It will report `podman` or `docker` if you have either tool installed.
> **Note:** If you have both, `podman` is used in preference.
If you don't have one, either install one now or continue with native setup. To
install `podman` on a Debian based system, run:
```bash
sudo apt install podman
```
### Container setup
We build our own container with the dependencies we need for SGDK development
based on a slimmed down Debian container.
```bash
./sgdk-helper.sh container
```
### Native setup
```bash
./sgdk-helper.sh toolchain
./sgdk-helper.sh deps
```
## SGDK development
Now that the setup is complete, we can use SGDK Helper for development of
a Mega Drive project.
From the top directory of an SGDK project, build the ROM with:
```bash
sgdk-helper.sh rom
```
> **Note:** An SGDK project looks like this
> [example](https://github.com/Stephane-D/SGDK/tree/master/sample/sonic) from
> SGDK. There are many others both in the SGDK project and around GitHub.
And you can run the ROM in [BlastEm](https://www.retrodev.com/blastem/) with:
```bash
sgdk-helper.sh rom
```
> **Note:** Further documentation coming soon.
> For now, see the documentation in the script.