Using Ruby for Sega Dreamcast development - Revision history

SiZiOUS: Major upgrade as mruby is now officially supported as kos-port.

2025-08-07T21:09:50Z

Major upgrade as mruby is now officially supported as kos-port.

← Older revision		Revision as of 21:09, 7 August 2025
Line 1:		Line 1:
	It's possible to develop in [https://www.ruby-lang.org Ruby] for the Sega Dreamcast system using the [https://mruby.org/ mruby implementation]. This ~~proof-of-concept~~ was ~~initially made~~ by [[Yuji Yokoo]] ~~back~~ in 2019. ~~This is experimental and a lot of features are missing~~, not ~~working and/or not~~ tested ~~(e.g. debugging)~~.		It is possible to develop in [https://www.ruby-lang.org Ruby] for the Sega Dreamcast system using the [https://mruby.org/ mruby implementation]. This support was originally introduced by [[Yuji Yokoo]] in 2019.

			Like most Sega Dreamcast software, this project uses [[KallistiOS]] (KOS) as its base.

			'''Note:''' Debugging support has not been tested as of 2025.

	~~As almost all Sega Dreamcast software, this uses [[KallistiOS]] (KOS) as base.~~

	== Prerequisites ==		== Prerequisites ==

	* ~~You should have a~~ working [[KallistiOS]] environment ~~and~~ all ~~the~~ dependencies ~~made~~ for ~~compiling~~ KallistiOS ~~installed~~;		* A working [[KallistiOS]] environment must be set up, including all necessary dependencies for building KallistiOS;
	* You ~~need to have~~ [[KallistiOS]] library ~~built;~~		* You must build the [[KallistiOS]] library;
	* The ''/opt/toolchains/dc/kos/kernel/build/newlib_kill.o'' and ''/opt/toolchains/dc/kos/kernel/build/newlib_getpid.o'' object files should be on your disk (they are produced when building KOS) - this is actually an issue that should be fixed later;		* You must have both ''ruby'' and ''bison'' installed (see the sections below).
	* You ~~need to~~ have ''~~rake~~'' and ''bison'' installed (see below).

	=== Installing prerequisites on Cygwin ===		=== Installing prerequisites on Cygwin ===

	~~Open~~ the Cygwin setup ~~and~~ search for the ''~~rake~~'' and ''bison'' packages and install them.		Launch the Cygwin setup utility, search for the ''ruby'' and ''bison'' packages, and install them.

			=== Installing prerequisites on DreamSDK ===

			Depending on the underlying environment installed with [[DreamSDK]], there are 2 possible cases:

			==== If you are using the modern MinGW-w64/MSYS2 foundation ====

	~~=== Installing~~ prerequisites ~~on DreamSDK (MinGW/MSYS) ===~~		No additional prerequisites are required — both Ruby and Bison are already preinstalled.

	If you ~~use~~ the ~~[[DreamSDK]] environment (or your custom [http://mingw.org~~ MinGW/MSYS~~] environment) you need to install '''Ruby''' for Windows and the additional ''bison'' package.~~		==== If you are using the legacy MinGW/MSYS foundation ====

	* Install [https://rubyinstaller.org/ RubyInstaller] ~~then verify~~ that the ''~~rake~~'' command is available in ~~the~~ ''PATH'' ~~environment variable.~~		Install manually the prerequisites:
	* ~~Install~~ ''msys-bison-bin'' package ~~from the '''MinGW Installation Manager''' program~~.		* Install [https://rubyinstaller.org/ RubyInstaller], and ensure that the ''ruby'' command is available in your system ''PATH'';
			* Use the '''MinGW Installation Manager''' to install the ''msys-bison-bin'' package.

	'''Note:''' If you are using DreamSDK on Windows XP, ~~then~~ you should install [https://rubyinstaller.org/ RubyInstaller] ~~2.0.0~~ as it the last version ~~which supports this~~ system.		'''Note:''' If you are using DreamSDK on Windows XP, you should install Ruby version 2.0.0 from [https://rubyinstaller.org/ RubyInstaller], as it is the last version compatible with that operating system.

	=== Installing prerequisites on GNU/Linux ===		=== Installing prerequisites on GNU/Linux ===

	~~Install~~ the ''~~rake~~'' and ''bison'' packages ~~with your package manager~~ (e.g. ''apt'' ~~with~~ Debian/Ubuntu).		Use your distribution’s package manager to install the ''ruby'' and ''bison'' packages (e.g., run ''apt install ruby bison'' on Debian/Ubuntu).

	=== Installing prerequisites on macOS ===		=== Installing prerequisites on macOS ===

	Install the ''~~rake~~'' and ''bison'' packages ~~with~~ your package manager (e.g. ''brew'').		Install the ''ruby'' and ''bison'' packages using your preferred package manager (e.g., ''brew'').

	=== Installing prerequisites on MinGW-w64/MSYS2 ===		=== Installing prerequisites on MinGW-w64/MSYS2 ===

	pacman -S ~~rake~~ bison		Run the following command in the MSYS2 shell:

			pacman -S ruby bison

	== Setting up mruby ==		== Setting up mruby ==

	~~Open a Terminal and type~~ the following:		The recommended way to use mruby on Dreamcast is to install the '''mruby''' port from the [https://github.com/KallistiOS/kos-ports KallistiOS Ports repository].

			First of all, make sure to clone the kos-ports repository:
			cd /opt/toolchains/dc
			git clone https://github.com/KallistiOS/kos-ports.git .

			Then, run the following commands:

			cd /opt/toolchains/dc/kos-ports/mruby
			make install clean

			This will build the embedded mruby library (''libmruby.a'') along with the required host tools (mainly ''/opt/toolchains/dc/bin/mrbc'') for the Dreamcast platform.

	cd /~~opt~~		'''Note:''' The configuration file is stored in ''build_config/dreamcast_shelf.rb'' in the [https://github.com/mruby/mruby mruby] official repository.
	~~git clone~~ https://github.com/mruby/mruby.~~git~~
	~~cd /opt/mruby~~
	~~make MRUBY_CONFIG=dreamcast_shelf~~

	~~This will generate all the required files, i.e. the host tools plus the embedded~~ mruby ~~library (''libmruby.~~a~~'') for the~~ Sega Dreamcast.		== Using mruby in a Sega Dreamcast project ==

	~~== Using~~ mruby ~~on a Sega Dreamcast project ==~~		Two example projects are included with [[KallistiOS]] in the ''/examples/dreamcast/mruby'' directory:

	~~Currently, two projects are available as template:~~		* '''dreampresent''' – A simple presentation tool (this needs the ''libpng'' port as well);
	* ~~[https://github.com/yujiyokoo/~~dreampresent ~~Dreampresent]:~~ A simple presentation tool;		* '''mrbtris''' – A sample game.
	* ~~[https://github.com/yujiyokoo/~~mrbtris~~-dreamcast Mrbtris]:~~ A sample game.

	~~Clone these~~ repositories ~~then~~ build ~~these projects by~~ using the ~~usual~~ ''make'' command (~~of course, this requires~~ '''mruby''' installed ~~properly!~~).		These examples were originally developed by [[Yuji Yokoo]] and correspond to the earlier stand-alone repositories. You can build them using the standard ''make'' command (assuming '''mruby''' and any additional required ports are properly installed via kos-ports).

Unknown user: Updating the build instruction for making mruby.

2023-01-06T21:56:42Z

Updating the build instruction for making mruby.

← Older revision		Revision as of 21:56, 6 January 2023
Line 42:		Line 42:
	git clone https://github.com/mruby/mruby.git		git clone https://github.com/mruby/mruby.git
	cd /opt/mruby		cd /opt/mruby
	~~cp examples/targets/build_config_dreamcast_shelf.rb build_config.rb~~		make MRUBY_CONFIG=dreamcast_shelf
	make

	This will generate all the required files, i.e. the host tools plus the embedded mruby library (''libmruby.a'') for the Sega Dreamcast.		This will generate all the required files, i.e. the host tools plus the embedded mruby library (''libmruby.a'') for the Sega Dreamcast.

Unknown user: Fixing introduction

2020-03-07T22:21:17Z

Fixing introduction

← Older revision		Revision as of 22:21, 7 March 2020
Line 1:		Line 1:
	~~Since 2019, it~~'s ~~now~~ possible to develop in [https://www.ruby-lang.org Ruby] for the Sega Dreamcast system using the [https://mruby.org/ mruby implementation]. ~~The~~ proof-of-concept was made by [[Yuji Yokoo]]. This is experimental and a lot of features are missing, not working and/or not tested (e.g. debugging).		It's possible to develop in [https://www.ruby-lang.org Ruby] for the Sega Dreamcast system using the [https://mruby.org/ mruby implementation]. This proof-of-concept was initially made by [[Yuji Yokoo]] back in 2019. This is experimental and a lot of features are missing, not working and/or not tested (e.g. debugging).

	As almost all Sega Dreamcast software, this uses [[KallistiOS]] (KOS) as base.		As almost all Sega Dreamcast software, this uses [[KallistiOS]] (KOS) as base.
Line 7:		Line 7:
	* You should have a working [[KallistiOS]] environment and all the dependencies made for compiling KallistiOS installed;		* You should have a working [[KallistiOS]] environment and all the dependencies made for compiling KallistiOS installed;
	* You need to have [[KallistiOS]] library built;		* You need to have [[KallistiOS]] library built;
	* ~~the~~ ''/opt/toolchains/dc/kos/kernel/build/newlib_kill.o'' and ''/opt/toolchains/dc/kos/kernel/build/newlib_getpid.o'' object files should be on your disk (they are produced when building KOS) - this is actually an issue that should be fixed later;		* The ''/opt/toolchains/dc/kos/kernel/build/newlib_kill.o'' and ''/opt/toolchains/dc/kos/kernel/build/newlib_getpid.o'' object files should be on your disk (they are produced when building KOS) - this is actually an issue that should be fixed later;
	* You need to have ''rake'' and ''bison'' installed (see below).		* You need to have ''rake'' and ''bison'' installed (see below).

Unknown user: Typo fix

2020-02-23T17:06:37Z

Typo fix

← Older revision		Revision as of 17:06, 23 February 2020
Line 7:		Line 7:
	* You should have a working [[KallistiOS]] environment and all the dependencies made for compiling KallistiOS installed;		* You should have a working [[KallistiOS]] environment and all the dependencies made for compiling KallistiOS installed;
	* You need to have [[KallistiOS]] library built;		* You need to have [[KallistiOS]] library built;
	* the ''/opt/toolchains/dc/kos/kernel/build/newlib_kill.o'' and ''/opt/toolchains/dc/kos/kernel/build/newlib_getpid.o'' object files should be on your disk (they are produced when building KOS) - this is actually an issue that should be ~~resolved~~ later;		* the ''/opt/toolchains/dc/kos/kernel/build/newlib_kill.o'' and ''/opt/toolchains/dc/kos/kernel/build/newlib_getpid.o'' object files should be on your disk (they are produced when building KOS) - this is actually an issue that should be fixed later;
	* You need to have ''rake'' and ''bison'' installed (see below).		* You need to have ''rake'' and ''bison'' installed (see below).

Unknown user at 17:06, 23 February 2020

2020-02-23T17:06:02Z

← Older revision		Revision as of 17:06, 23 February 2020
Line 7:		Line 7:
	* You should have a working [[KallistiOS]] environment and all the dependencies made for compiling KallistiOS installed;		* You should have a working [[KallistiOS]] environment and all the dependencies made for compiling KallistiOS installed;
	* You need to have [[KallistiOS]] library built;		* You need to have [[KallistiOS]] library built;
	* the ''/opt/toolchains/dc/kos/kernel/build/newlib_kill.o'' and ''/opt/toolchains/dc/kos/kernel/build/newlib_getpid.o'' object files should be on your disk (they are produced when building KOS).		* the ''/opt/toolchains/dc/kos/kernel/build/newlib_kill.o'' and ''/opt/toolchains/dc/kos/kernel/build/newlib_getpid.o'' object files should be on your disk (they are produced when building KOS) - this is actually an issue that should be resolved later;
	* You need to have ''rake'' and ''bison'' installed (see below).		* You need to have ''rake'' and ''bison'' installed (see below).

Unknown user: Some modification in intro

2020-02-23T17:05:14Z

Some modification in intro

← Older revision		Revision as of 17:05, 23 February 2020
Line 1:		Line 1:
	Since 2019, it's now possible to develop in [https://www.ruby-lang.org Ruby] for the Sega Dreamcast system using the [https://mruby.org/ mruby implementation]. The proof-of-concept was made by [[Yuji Yokoo]]. This is experimental and a lot of features are missing, not working and/or not tested (e.g. debugging).		Since 2019, it's now possible to develop in [https://www.ruby-lang.org Ruby] for the Sega Dreamcast system using the [https://mruby.org/ mruby implementation]. The proof-of-concept was made by [[Yuji Yokoo]]. This is experimental and a lot of features are missing, not working and/or not tested (e.g. debugging).

	As almost all Sega Dreamcast software, this uses [[KallistiOS]] (KOS).		As almost all Sega Dreamcast software, this uses [[KallistiOS]] (KOS) as base.

	== Prerequisites ==		== Prerequisites ==

Unknown user: Adding Ruby link

2020-02-23T17:04:47Z

Adding Ruby link

← Older revision		Revision as of 17:04, 23 February 2020
Line 1:		Line 1:
	Since 2019, it's now possible to develop in Ruby for the Sega Dreamcast system using the [https://mruby.org/ mruby implementation]. The proof-of-concept was made by [[Yuji Yokoo]]. This is experimental and a lot of features are missing, not working and/or not tested (e.g. debugging).		Since 2019, it's now possible to develop in [https://www.ruby-lang.org Ruby] for the Sega Dreamcast system using the [https://mruby.org/ mruby implementation]. The proof-of-concept was made by [[Yuji Yokoo]]. This is experimental and a lot of features are missing, not working and/or not tested (e.g. debugging).

	As almost all Sega Dreamcast software, this uses [[KallistiOS]] (KOS).		As almost all Sega Dreamcast software, this uses [[KallistiOS]] (KOS).

Unknown user: Major refactoring of the page

2020-02-23T17:04:15Z

Major refactoring of the page

← Older revision		Revision as of 17:04, 23 February 2020
Line 1:		Line 1:
	It's possible to develop in Ruby for the Sega Dreamcast using the mruby implementation. The proof-of-concept was made by [[Yuji Yokoo]] ~~back in 2019~~. This is experimental and a lot of features are missing/not working/not tested (e.g. debugging).		Since 2019, it's now possible to develop in Ruby for the Sega Dreamcast system using the [https://mruby.org/ mruby implementation]. The proof-of-concept was made by [[Yuji Yokoo]]. This is experimental and a lot of features are missing, not working and/or not tested (e.g. debugging).

			As almost all Sega Dreamcast software, this uses [[KallistiOS]] (KOS).

	== Prerequisites ==		== Prerequisites ==

	You should have a working [[KallistiOS]] environment. ~~Also you~~ need to have rake and bison installed.		* You should have a working [[KallistiOS]] environment and all the dependencies made for compiling KallistiOS installed;
			* You need to have [[KallistiOS]] library built;
			* the ''/opt/toolchains/dc/kos/kernel/build/newlib_kill.o'' and ''/opt/toolchains/dc/kos/kernel/build/newlib_getpid.o'' object files should be on your disk (they are produced when building KOS).
			* You need to have ''rake'' and ''bison'' installed (see below).

			=== Installing prerequisites on Cygwin ===

			Open the Cygwin setup and search for the ''rake'' and ''bison'' packages and install them.

			=== Installing prerequisites on DreamSDK (MinGW/MSYS) ===

			If you use the [[DreamSDK]] environment (or your custom [http://mingw.org MinGW/MSYS] environment) you need to install '''Ruby''' for Windows and the additional ''bison'' package.

			* Install [https://rubyinstaller.org/ RubyInstaller] then verify that the ''rake'' command is available in the ''PATH'' environment variable.
			* Install ''msys-bison-bin'' package from the '''MinGW Installation Manager''' program.

			'''Note:''' If you are using DreamSDK on Windows XP, then you should install [https://rubyinstaller.org/ RubyInstaller] 2.0.0 as it the last version which supports this system.

			=== Installing prerequisites on GNU/Linux ===

			Install the ''rake'' and ''bison'' packages with your package manager (e.g. ''apt'' with Debian/Ubuntu).

	=== Installing prerequisites on ~~MinGW/MSYS~~ ===		=== Installing prerequisites on macOS ===

	Install ~~RubyInstaller~~ (~~if XP : 2~~.0.0) ~~then add it to the path~~.		Install the ''rake'' and ''bison'' packages with your package manager (e.g. ''brew'').
	~~Install bison in the MinGW Get program~~

	=== Installing prerequisites on MinGW-w64/MSYS2 ===		=== Installing prerequisites on MinGW-w64/MSYS2 ===
Line 16:		Line 37:
	== Setting up mruby ==		== Setting up mruby ==

	Open a ~~Shell~~ and type the following:		Open a Terminal and type the following:

	cd /opt		cd /opt
Line 24:		Line 45:
	make		make

	This will generate all the required files, the -~~lmruby is now available~~		This will generate all the required files, i.e. the host tools plus the embedded mruby library (''libmruby.a'') for the Sega Dreamcast.

			== Using mruby on a Sega Dreamcast project ==

			Currently, two projects are available as template:
			* [https://github.com/yujiyokoo/dreampresent Dreampresent]: A simple presentation tool;
			* [https://github.com/yujiyokoo/mrbtris-dreamcast Mrbtris]: A sample game.

			Clone these repositories then build these projects by using the usual ''make'' command (of course, this requires '''mruby''' installed properly!).

Unknown user: /* Setting up mruby */

2020-02-23T10:21:23Z

Setting up mruby

← Older revision		Revision as of 10:21, 23 February 2020
Line 21:		Line 21:
	git clone https://github.com/mruby/mruby.git		git clone https://github.com/mruby/mruby.git
	cd /opt/mruby		cd /opt/mruby
	cp examples/targets/build_config_dreamcast_shelf.rb ~~/opt/mruby/~~build_config.rb		cp examples/targets/build_config_dreamcast_shelf.rb build_config.rb
	make		make

	This will generate all the required files, the -lmruby is now available		This will generate all the required files, the -lmruby is now available

Unknown user: /* Draft */

2020-02-22T13:52:25Z

Draft

New page

It's possible to develop in Ruby for the Sega Dreamcast using the mruby implementation. The proof-of-concept was made by [[Yuji Yokoo]] back in 2019. This is experimental and a lot of features are missing/not working/not tested (e.g. debugging).

== Prerequisites ==

You should have a working [[KallistiOS]] environment. Also you need to have rake and bison installed.

=== Installing prerequisites on MinGW/MSYS ===

Install RubyInstaller (if XP : 2.0.0) then add it to the path.
Install bison in the MinGW Get program

=== Installing prerequisites on MinGW-w64/MSYS2 ===

pacman -S rake bison

== Setting up mruby ==

Open a Shell and type the following:

cd /opt
git clone https://github.com/mruby/mruby.git
cd /opt/mruby
cp examples/targets/build_config_dreamcast_shelf.rb /opt/mruby/build_config.rb
make

This will generate all the required files, the -lmruby is now available