Getting Started with Dreamcast development - Revision history

Darc: /* Setting up and compiling the toolchain with the dc-chain script */

2025-12-10T09:04:52Z

Setting up and compiling the toolchain with the dc-chain script

← Older revision		Revision as of 09:04, 10 December 2025
Line 63:		Line 63:
	===Dependencies===		===Dependencies===
	First, we'll need to install dependencies before building the toolchain. Below we have provided commands to install these dependencies on various systems. Many of the packages will likely already be installed on your system, but we have provided an exhaustive list for good measure.		First, we'll need to install dependencies before building the toolchain. Below we have provided commands to install these dependencies on various systems. Many of the packages will likely already be installed on your system, but we have provided an exhaustive list for good measure.
	====macOS ~~13 Ventura~~ on an Intel or Apple Silicon processor====
			<div class="mw-collapsible mw-collapsed">
			====macOS on an Intel or Apple Silicon processor====
			<div class="mw-collapsible-content">
	First, make sure you install Apple Xcode, including the Command Line tools. You will also need to install several other packages for which we'll include instructions assuming you have installed the [https://brew.sh/ Homebrew] package manager on your system.		First, make sure you install Apple Xcode, including the Command Line tools. You will also need to install several other packages for which we'll include instructions assuming you have installed the [https://brew.sh/ Homebrew] package manager on your system.
	brew install make wget gettext texinfo gmp mpfr libmpc libelf jpeg-turbo libpng cmake meson libisofs		brew install make wget gettext texinfo gmp mpfr libmpc libelf jpeg-turbo libpng cmake meson libisofs
Line 70:		Line 73:
	export CPATH=/opt/homebrew/include		export CPATH=/opt/homebrew/include
	export LIBRARY_PATH=/opt/homebrew/lib		export LIBRARY_PATH=/opt/homebrew/lib
			</div></div>

			<div class="mw-collapsible mw-collapsed">
	====Debian/Ubuntu-based Linux====		====Debian/Ubuntu-based Linux====
			<div class="mw-collapsible-content">
	sudo apt-get update		sudo apt-get update
	sudo apt install gawk patch bzip2 tar make libgmp-dev libmpfr-dev libmpc-dev gettext wget libelf-dev texinfo bison flex sed git build-essential diffutils curl libjpeg-dev libpng-dev python3 pkg-config cmake libisofs-dev meson ninja-build rake cmake		sudo apt install gawk patch bzip2 tar make libgmp-dev libmpfr-dev libmpc-dev gettext wget libelf-dev texinfo bison flex sed git build-essential diffutils curl libjpeg-dev libpng-dev python3 pkg-config cmake libisofs-dev meson ninja-build rake cmake
			</div></div>

			<div class="mw-collapsible mw-collapsed">
	====Fedora-based Linux====		====Fedora-based Linux====
			<div class="mw-collapsible-content">
	sudo dnf install gawk patch bzip2 tar make gmp-devel mpfr-devel libmpc-devel gettext wget elfutils-libelf-devel texinfo bison flex sed git diffutils curl libjpeg-turbo-devel libpng-devel gcc-c++ python3 rubygem-rake meson ninja-build cmake		sudo dnf install gawk patch bzip2 tar make gmp-devel mpfr-devel libmpc-devel gettext wget elfutils-libelf-devel texinfo bison flex sed git diffutils curl libjpeg-turbo-devel libpng-devel gcc-c++ python3 rubygem-rake meson ninja-build cmake
			</div></div>

			<div class="mw-collapsible mw-collapsed">
	====Arch-based Linux====		====Arch-based Linux====
			<div class="mw-collapsible-content">
	sudo pacman -S --needed gawk patch bzip2 tar make gmp mpfr libmpc gettext wget libelf texinfo bison flex sed git diffutils curl libjpeg-turbo libpng python3 meson ruby-rake cmake		sudo pacman -S --needed gawk patch bzip2 tar make gmp mpfr libmpc gettext wget libelf texinfo bison flex sed git diffutils curl libjpeg-turbo libpng python3 meson ruby-rake cmake
			</div></div>

			<div class="mw-collapsible mw-collapsed">
	====Alpine-based Linux====		====Alpine-based Linux====
			<div class="mw-collapsible-content">
	sudo apk --update add build-base patch bash texinfo gmp-dev mpfr-dev libjpeg-turbo-dev libpng-dev elfutils-dev curl wget python3 git ruby-rake cmake fmt		sudo apk --update add build-base patch bash texinfo gmp-dev mpfr-dev libjpeg-turbo-dev libpng-dev elfutils-dev curl wget python3 git ruby-rake cmake fmt
			</div></div>

	====Other Linux distributions====		====Other Linux distributions====

Darc at 23:51, 1 December 2025

2025-12-01T23:51:25Z

← Older revision		Revision as of 23:51, 1 December 2025
Line 65:		Line 65:
	====macOS 13 Ventura on an Intel or Apple Silicon processor====		====macOS 13 Ventura on an Intel or Apple Silicon processor====
	First, make sure you install Apple Xcode, including the Command Line tools. You will also need to install several other packages for which we'll include instructions assuming you have installed the [https://brew.sh/ Homebrew] package manager on your system.		First, make sure you install Apple Xcode, including the Command Line tools. You will also need to install several other packages for which we'll include instructions assuming you have installed the [https://brew.sh/ Homebrew] package manager on your system.
	brew install wget gettext texinfo gmp mpfr libmpc libelf jpeg-turbo libpng cmake meson libisofs		brew install make wget gettext texinfo gmp mpfr libmpc libelf jpeg-turbo libpng cmake meson libisofs

	''Important Note for Apple Silicon users'': On Apple Silicon, Homebrew installs libraries to a path not included by default by the compiler. If you haven't added these to your '''~/.zprofile''', then add the following lines now and reload your session (or run them in your Terminal session whenever you compile KOS):		''Important Note for Apple Silicon users'': On Apple Silicon, Homebrew installs libraries to a path not included by default by the compiler. If you haven't added these to your '''~/.zprofile''', then add the following lines now and reload your session (or run them in your Terminal session whenever you compile KOS):

Darc: /* Cloning the KallistiOS git repository */

2025-08-20T17:06:56Z

Cloning the KallistiOS git repository

← Older revision		Revision as of 17:06, 20 August 2025
Line 93:		Line 93:
	sudo chown -R $(id -u):$(id -g) /opt/toolchains/dc		sudo chown -R $(id -u):$(id -g) /opt/toolchains/dc
	===Cloning the KallistiOS git repository===		===Cloning the KallistiOS git repository===
	Next, clone the git repository for the latest '''2.2.0''' stable version of KallistiOS:		Next, clone the git repository for the latest '''2.2.x''' stable version of KallistiOS:
	git clone https://github.com/KallistiOS/KallistiOS.git -b v2.2.0 /opt/toolchains/dc/kos		git clone https://github.com/KallistiOS/KallistiOS.git -b v2.2.x /opt/toolchains/dc/kos

	Alternatively, you may clone the latest unstable version, which contains the latest changes, but may also contain bugs or issues:		Alternatively, you may clone the latest unstable version, which contains the latest changes, but may also contain bugs or issues. Proceed at your own risk using unstable master!
	git clone https://github.com/KallistiOS/KallistiOS.git -b master /opt/toolchains/dc/kos		git clone https://github.com/KallistiOS/KallistiOS.git -b master /opt/toolchains/dc/kos

Darc: /* Cleaning up temporary files */

2025-08-04T19:17:37Z

Cleaning up temporary files

← Older revision		Revision as of 19:17, 4 August 2025
Line 115:		Line 115:
	===Cleaning up temporary files===		===Cleaning up temporary files===
	After building everything, you can clean up the extraneous files in your dc-chain directory by entering:		After building everything, you can clean up the extraneous files in your dc-chain directory by entering:
	make clean		make clean distclean

	=Configuring and compiling KOS and kos-ports=		=Configuring and compiling KOS and kos-ports=

Darc: /* Downloading and compiling the toolchain */

2025-08-04T19:17:18Z

Downloading and compiling the toolchain

← Older revision		Revision as of 19:17, 4 August 2025
Line 108:		Line 108:

	===Downloading and compiling the toolchain===		===Downloading and compiling the toolchain===
	Now we will run a script to download files and compile the toolchain. At this point, we have the option of building both the main CPU SH4 compiler and the AICA sound processor ARM compiler, or we can skip the ARM compiler and just build the SH4 compiler. Thankfully, KallistiOS includes a prebuilt sound driver, so the ARM compiler is only necessary if you're wanting to make changes to the sound driver or write custom code to run ~~on the sound processor.~~		Now we will run a script to download files and compile the toolchain. Simply run:
	~~To build '''only the SH4 compiler'''~~:
	make		make
	~~To build '''both''' the SH4 and the ARM compilers:~~
	~~make all~~		This will download and unpack the relevant necessary files and then begin the compilation process. The compilation can take anywhere from minutes to a few hours depending on your CPU and number of threads available. When successfully finished, the toolchains will be ready. If you used the command above, the '''gdb''' debugger will have been built as well.
	This will download and unpack the relevant necessary files and then begin the compilation process. The compilation can take anywhere from minutes to a few hours depending on your CPU and number of threads available. When successfully finished, the toolchains will be ready. If you used the ~~commands~~ above, the '''gdb''' debugger will have been built as well.

	===Cleaning up temporary files===		===Cleaning up temporary files===

Darc: /* Configuring the dc-chain script */

2025-08-04T19:16:19Z

Configuring the dc-chain script

← Older revision		Revision as of 19:16, 4 August 2025
Line 103:		Line 103:
	cd /opt/toolchains/dc/kos/utils/dc-chain		cd /opt/toolchains/dc/kos/utils/dc-chain

	You may now configure the options to your liking by creating a <code>Makefile.cfg</code> file in this directory. Copy or rename the <code>Makefile.default.cfg</code> file to <code>Makefile.cfg</code> and then use a text editor to edit this file's settings to your liking. For example, you may like to alter the <code>makejobs</code> option to the number of threads available on your CPU to speed up the compilation. However, if you run into errors during compilation, you may want to set <code>makejobs=1</code>, as on some operating systems the toolchain may fail to build with a higher setting.		You may now configure the options to your liking by creating a <code>Makefile.cfg</code> file in this directory. Copy or rename the <code>Makefile.default.cfg</code> (KOS 2.2.0 stable) or <code>Makefile.dreamcast.cfg</code> (KOS master unstable) file to <code>Makefile.cfg</code> and then use a text editor to edit this file's settings to your liking. For example, you may like to alter the <code>makejobs</code> option to the number of threads available on your CPU to speed up the compilation. However, if you run into errors during compilation, you may want to set <code>makejobs=1</code>, as on some operating systems the toolchain may fail to build with a higher setting.

	We will leave the default '''stable''' profile for the toolchain, which currently uses GCC 13.2. For advanced users, other profiles are available to you; read the <code>README.md</code> file in the dc-chain directory for more information if you are interested. If you are unsure about options in the <code>Makefile.cfg</code>, just leave the defaults alone.		We will leave the default '''stable''' profile for the toolchain, which currently uses GCC 13.2. For advanced users, other profiles are available to you; read the <code>README.md</code> file in the dc-chain directory for more information if you are interested. If you are unsure about options in the <code>Makefile.cfg</code>, just leave the defaults alone.

C08o.prkiua: Adding extra information linking to the setup and information pages of dcload-ip

2025-07-28T01:45:31Z

Adding extra information linking to the setup and information pages of dcload-ip

← Older revision		Revision as of 01:45, 28 July 2025
Line 162:		Line 162:
	'''TODO''': ''Give a tutorial on compiling dcload/dc-tool, setting up a serial, USB, or IP debug link, and running 2ndmix demo on real hardware.''		'''TODO''': ''Give a tutorial on compiling dcload/dc-tool, setting up a serial, USB, or IP debug link, and running 2ndmix demo on real hardware.''

	~~Download~~ and burn the [[:File:Dcload-2023-06-22.zip\|latest ~~versions~~ of dcload-ip or dcload-serial]] -- the IP version includes improved DHCP support, so there is no longer a need to configure things beforehand.		On your development machine, setup [[dcload-ip]]:
			* [[Using dcload-ip with Linux]]
			* [[Using dcload-ip with Windows Subsystem for Linux]]

			For the Dreamcast, download and burn the [[:File:Dcload-2023-06-22.zip\|latest version of dcload-ip or dcload-serial]] to a CD-R -- the IP version includes improved DHCP support, so there is no longer a need to configure things beforehand.

	Run one of the examples from the <code>kos/examples/dreamcast</code> directory with one of the following commands:		Run one of the examples from the <code>kos/examples/dreamcast</code> directory with one of the following commands:

Darc: /* Cloning the KallistiOS git repository */

2025-07-11T22:57:10Z

Cloning the KallistiOS git repository

← Older revision		Revision as of 22:57, 11 July 2025
Line 93:		Line 93:
	sudo chown -R $(id -u):$(id -g) /opt/toolchains/dc		sudo chown -R $(id -u):$(id -g) /opt/toolchains/dc
	===Cloning the KallistiOS git repository===		===Cloning the KallistiOS git repository===
	Next, clone the git repository for the latest '''2.1.1''' stable version of KallistiOS:		Next, clone the git repository for the latest '''2.2.0''' stable version of KallistiOS:
	git clone https://github.com/KallistiOS/KallistiOS.git -b v2.1.x /opt/toolchains/dc/kos		git clone https://github.com/KallistiOS/KallistiOS.git -b v2.2.0 /opt/toolchains/dc/kos

	Alternatively, you may clone the latest unstable version, which contains the latest changes, but may also contain bugs or issues:		Alternatively, you may clone the latest unstable version, which contains the latest changes, but may also contain bugs or issues:

Darc: /* Setting up the environment settings */

2025-06-23T03:48:40Z

Setting up the environment settings

← Older revision		Revision as of 03:48, 23 June 2025
Line 127:		Line 127:
	For most users, the default settings will suffice. However, advanced users may edit the environ.sh to your liking if you'd like to change compile flags or alter paths. If you'd like to have multiple KOS versions installed or multiple toolchain versions installed, you can set up different environ.sh files corresponding to these different configurations by altering the paths.		For most users, the default settings will suffice. However, advanced users may edit the environ.sh to your liking if you'd like to change compile flags or alter paths. If you'd like to have multiple KOS versions installed or multiple toolchain versions installed, you can set up different environ.sh files corresponding to these different configurations by altering the paths.

	You will need to run the following command to apply the KOS environment settings to your currently running shell. Run the following now, '''and''' ''whenever'' you open a new shell to work on Dreamcast projects:		You will need to run the following command to apply the KOS environment settings to your currently running shell. Run the following command now, '''and''' ''whenever'' you open a new shell to work on Dreamcast projects:
	. /opt/toolchains/dc/kos/environ.sh		. /opt/toolchains/dc/kos/environ.sh

Darc at 03:48, 23 June 2025

2025-06-23T03:48:16Z

← Older revision		Revision as of 03:48, 23 June 2025
Line 125:		Line 125:
	Copy the pre-made environment script into place:		Copy the pre-made environment script into place:
	cp doc/environ.sh.sample environ.sh		cp doc/environ.sh.sample environ.sh
	For most users, the default settings will suffice. However, advanced users may edit the environ.sh to your liking if you'd like to change compile flags or alter paths. If you'd like to have multiple KOS versions installed or multiple toolchain versions installed, you can set up different environ.sh files corresponding to these different configurations by altering the paths~~. Run the source command on the desired environ.sh file to select that configuration prior to compiling your project~~.		For most users, the default settings will suffice. However, advanced users may edit the environ.sh to your liking if you'd like to change compile flags or alter paths. If you'd like to have multiple KOS versions installed or multiple toolchain versions installed, you can set up different environ.sh files corresponding to these different configurations by altering the paths.

	You will need to run the ~~source~~ command to apply the KOS environment settings to your currently running shell. Run the following now, '''and''' ''whenever'' you open a new shell to work on Dreamcast projects:		You will need to run the following command to apply the KOS environment settings to your currently running shell. Run the following now, '''and''' ''whenever'' you open a new shell to work on Dreamcast projects:
	~~source~~ /opt/toolchains/dc/kos/environ.sh		. /opt/toolchains/dc/kos/environ.sh

	===Building KOS===		===Building KOS===