Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ricky26/rust-mega-drive
A proof-of-concept project using Rust to write Mega Drive ROMs.
https://github.com/ricky26/rust-mega-drive
Last synced: about 8 hours ago
JSON representation
A proof-of-concept project using Rust to write Mega Drive ROMs.
- Host: GitHub
- URL: https://github.com/ricky26/rust-mega-drive
- Owner: ricky26
- License: mit
- Created: 2021-02-16T11:26:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-14T17:58:43.000Z (about 3 years ago)
- Last Synced: 2024-08-10T02:54:43.053Z (3 months ago)
- Language: Rust
- Size: 289 KB
- Stars: 57
- Watchers: 6
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-megadrive - Writing ROMs using Rust - A proof-of-concept project using Rust to write Mega Drive ROMs (Programming / Snippets and Demos)
README
# Mega Drive toolkit for Rust
This repository hosts a few packages for use with the SEGA Mega Drive (Sega
Genesis in North America).
## Using these packages
At the moment, these packages only work with a fork of LLVM & Rust. To use them
you will need to build both.
### Building with Docker
For convenience, this repository provides a two-stage Dockerized approach to building the contained code:
- A [Dockerfile.toolchain](Dockerfile.toolchain) for a Motorola 68000-compatible Rust compiler. You can build this using
the command `docker build -t rust-m68k:latest -f Dockerfile.toolchain .`. If the build runs out of memory, you can
tweak the number of parallel build processes using `--build-arg NUM_JOBS=4` or lower if your system requires it.
- A [Dockerfile](Dockerfile) to compile the megapong application. Use `docker build -t rust-mega-drive .` to compile it.
It assumes that you built the toolchain Docker image as `rust-m68k:latest`. To obtain the "megapong" example, run:
```shell
# Run the image with default command to build megapong
docker run -it -v $(pwd)/target:/target rust-mega-drive:latest
# Take back control over the target directory
sudo chown -R $USER:$USER target
```
Now, you will have a `megapong.md` binary in the subfolder `target/m68k-none-eabi/release/`!
### Building LLVM
This is a more in-depth approach to building a Motorola 68000 compatible Rust/LLVM toolchain. You can skip these
instructions if you used Docker as the main build tool.
1. Checkout the `llvm-12` branch from the
[LLVM project fork](https://github.com/ricky26/llvm-project).
2. Build the toolchain with cmake:
1. Generate the project with the M68k backend enabled:
```bash
cd llvm-project
mkdir build
cd build
cmake -G Ninja "-DLLVM_USE_LINKER=lld" "-DCMAKE_BUILD_TYPE=Release" "-DLLVM_ENABLE_ASSERTIONS=ON" "-DLLVM_PARALLEL_LINK_JOBS=1" "-DLLVM_TARGETS_TO_BUILD=X86" "-DLLVM_EXPERIMENTAL_TARGETS_TO_BUILD=M68k" "-DLLVM_ENABLE_PROJECTS=clang;lld" ..
```
2. Build:
```
ninja -j16
```
(This step can take along time and a lot of memory if used with a lot of threads.)
3. You should now have all of the LLVM binaries in `build/bin`.
### Building Rust
1. Checkout the [Rust fork](https://github.com/ricky26/rust) (clone the
m68k-linux branch).
2. Copy `config.toml.example` to `config.toml` and edit:
1. Set `[build] target = ["x86_64-unknown-linux-gnu", "m68k-unknown-linux-gnu"`
2. Set `[target.x86_64-unknown-linux-gnu] llvm-config = "path/to/build/bin/llvm-config"`
3. Build:
```
./x.py build --stage=2 rustc cargo
```
4. You should now have a Rust toolchain in `build/x86_64-unknown-linux-gnu/stage2`.
5. Link the toolchain in rustup so it is easier to use:
```
rustup toolchain link m68k "path/to/build/x86_64-unknown-linux-gnu/stage2"
```
### Building this repository
1. Set the required environment variables:
```
export MEGADRIVE_HOME=path/to/rust-mega-drive/share
export RUSTUP_TOOLCHAIN=m68k
export LLVM_CONFIG=path/to/llvm/build/bin/llvm-config
```
2. Build the tools & libraries:
```
cargo build --release
```
3. Install the cargo tool:
```
cd tools/cargo-megadrive
cargo install --path=.
```
4. Build the example Mega Drive image:
```
cd examples/megapong
cargo megadrive build
```
5. You should now have an example megadrive image in
`target/m68k-none-eabi/release/megapong.md`.
# License
This suite is distributed under the terms of the MIT license. The full license
text can be read in LICENSE.