MegaZeux Development VMs - Revision history

Lachesis: /* Common */ Explicitly document build-base for Alpine.

2023-11-09T09:11:42Z

Common: Explicitly document build-base for Alpine.

← Older revision		Revision as of 09:11, 9 November 2023
Line 436:		Line 436:
	Install packages for the tools and dependencies required to build MegaZeux:		Install packages for the tools and dependencies required to build MegaZeux:
	<pre>		<pre>
			# Debian
	sudo apt install build-essential gdb git zlib1g-dev libpng-dev libogg-dev libvorbis-dev libsdl2-dev		sudo apt install build-essential gdb git zlib1g-dev libpng-dev libogg-dev libvorbis-dev libsdl2-dev
			</pre>
			<pre>
			# Alpine
			sudo apk add build-base gdb git zlib-dev libpng-dev libogg-dev libvorbis-dev sdl2-dev
	</pre>		</pre>
	</li>		</li>
Line 463:		Line 468:
	From the guest OS, clear the apt package cache:		From the guest OS, clear the apt package cache:
	<pre>		<pre>
			# Debian
	sudo apt clean		sudo apt clean
			</pre>
			<pre>
			# Alpine
			sudo apk cache clean
	</pre>		</pre>

Lachesis: /* Extra software */ Fixes for Alpine/i3

2023-11-09T08:52:07Z

Extra software: Fixes for Alpine/i3

← Older revision		Revision as of 08:52, 9 November 2023
Line 500:		Line 500:
	<pre>		<pre>
	# Console utilities.		# Console utilities.
	sudo apt install screen lm-sensors lynx		sudo apt install dialog screen lm-sensors lynx

	# Graphical environment and browser.		# Graphical environment and browser.
	sudo apt install xorg i3 i3lock i3status rofi		sudo apt install xorg i3 i3lock i3status rofi rxvt-unicode fonts-dejavu

	# Sway might work better on some setups (encountered on AML-S905X-CC v1).		# Sway might work better on some setups (encountered on AML-S905X-CC v1).
Line 509:		Line 509:

	# Extra tools for building libxmp and xmp-cli from source.		# Extra tools for building libxmp and xmp-cli from source.
	sudo apt install autoconf automake libtool pkg-config ~~cmake~~		sudo apt install autoconf automake libtool pkg-config

	# clang may be useful for its sanitizers and built-in fuzzer, but it is quite large.		# clang may be useful for its sanitizers and built-in fuzzer, but it is quite large.
Line 559:		Line 559:

	# Place the following line in your .xinitrc file:		# Place the following line in your .xinitrc file:
			# i3 only: xrdb -merge "$HOME"/.Xresources
	exec tdm --xstart		exec tdm --xstart
	</pre>		</pre>
Line 571:		Line 572:
	Alternatively, just use "startx" or "sway" manually. In the case of the former, .xinitrc needs to be preset:		Alternatively, just use "startx" or "sway" manually. In the case of the former, .xinitrc needs to be preset:
	<pre>		<pre>
			xrdb -merge "$HOME"/.Xresources
	exec i3		exec i3
	</pre>		</pre>

Lachesis: /* Setup */ Move .Xresources setup to the X11-only section.

2023-11-03T06:04:45Z

Setup: Move .Xresources setup to the X11-only section.

← Older revision		Revision as of 06:04, 3 November 2023
Line 409:		Line 409:
	</li>		</li>
	<li>		<li>
	~~Set~~ up '''run.serial.sh''' script ~~and run.~~		If applicable, set up the '''run.serial.sh''' script (or '''run.sh''') and run it to start QEMU.
	~~</li>~~
	~~<li>~~
	~~Set up~~ '''~/.~~Xresources~~''' ~~from [https://www.digitalmzx.com/lachesis/.Xresources here]. This is required~~ to ~~make urxvt not look awful.~~
	~~<pre>~~
	~~cd ~~~
	~~wget https://www.digitalmzx.com/lachesis/~~.~~Xresources~~
	~~</pre>~~
	</li>		</li>
	<li>		<li>
Line 587:		Line 580:
	<pre>		<pre>
	sudo update-alternatives --config x-terminal-emulator		sudo update-alternatives --config x-terminal-emulator
			</pre>
			Set up '''~/.Xresources''' from [https://www.digitalmzx.com/lachesis/.Xresources here]. This is required to make urxvt not look awful.
			<pre>
			cd ~
			wget https://www.digitalmzx.com/lachesis/.Xresources
	</pre>		</pre>
	</li>		</li>
	<li>		<li>
	~~Set~~ up '''run.sh''' script and make sure the VM can start up with graphics and run MegaZeux with the software renderer. This may take some trial and error to get right, which is why QEMU options that have worked in the past are provided in the above tables.		If applicable, set up the '''run.sh''' script and make sure the VM can start up with graphics and run MegaZeux with the software renderer. This may take some trial and error to get right, which is why QEMU options that have worked in the past are provided in the above tables.
	</li>		</li>
	</ol>		</ol>

Lachesis: /* Linux/BSD (main architectures) */ Add amd64.

2023-11-03T01:18:04Z

Linux/BSD (main architectures): Add amd64.

@@ Line 7: / Line 7: @@
 == Linux/BSD (main architectures) ==
-These architectures usually correspond to existing or future MegaZeux ports and are fairly well-supported by Linux and/or BSD distributions. The x86_64 and i686 architectures are omitted because there is currently no point in maintaining development VMs for them.
+These architectures usually correspond to existing or future MegaZeux ports and are fairly well-supported by Linux and/or BSD distributions. Linux and BSD ports are omitted from the table for obvious reasons.
-Build times provided were observed using an i7-7700 running QEMU from a hypervisor guest, and are mainly intended to give a sense of scale. These may vary significantly depending on your machine and setup.
+Build times provided were observed using an i7-7700 running QEMU from a hypervisor guest, and are mainly intended to give a sense of scale. These may vary significantly depending on your machine and setup. For platforms where --enable-kvm is relevant, it was not used.
 The current head in <code>/megazeux</code> should be the most recent head a full build was tested with.
@@ Line 23: / Line 23: @@
 ! Image
 ! Links
 |-

Lachesis: /* Extra software */ Explicitly install dialog for tdm, since Debian doesn't have it by default.

2023-11-02T23:43:04Z

Extra software: Explicitly install dialog for tdm, since Debian doesn't have it by default.

← Older revision		Revision as of 23:43, 2 November 2023
Line 525:		Line 525:
	Set up tdm:		Set up tdm:
	<pre>		<pre>
			sudo apt install dialog
	git clone https://github.com/dopsi/console-tdm		git clone https://github.com/dopsi/console-tdm
	cd console-tdm		cd console-tdm

Lachesis: /* Extra software */ Fix tdm instructions for Debian, add Sway hardware cursors hack.

2023-11-02T23:40:51Z

Extra software: Fix tdm instructions for Debian, add Sway hardware cursors hack.

← Older revision		Revision as of 23:40, 2 November 2023
Line 536:		Line 536:
	tdmctl add sway /usr/bin/sway extra		tdmctl add sway /usr/bin/sway extra

	~~# Enable an automatic prompt when starting either of the first two VTs.~~		# Place the following in your .profile or .bashrc file:
	# Place the following ~~line~~ in your .profile or .bashrc file:		# Optional: Sway hardware cursors may not work in VirtualBox or QEMU.
	[ -n "$XDG_VTNR" ] && [ "$XDG_VTNR" -le 2 ] ~~&& exec~~ tdm --disable-long-names		export WLR_NO_HARDWARE_CURSORS=1
			# Enable tdm when starting either of the first two VTs.
			if [ -z "$DISPLAY" ] && [ -n "$XDG_VTNR" ] && [ "$XDG_VTNR" -le 2 ]; then
			tdm --disable-long-names \|\| true
			fi

	# Place the following line in your .xinitrc file:		# Place the following line in your .xinitrc file:
	exec tdm --~~start~~		exec tdm --xstart
	</pre>		</pre>
	</li>		</li>

Lachesis: /* Extra software */ Add display manager instructions.

2023-10-20T20:41:08Z

Extra software: Add display manager instructions.

@@ Line 507: / Line 507: @@
 sudo apt install zram-tools
 </pre>
 </li>
 <li>

Lachesis: /* Setup */ Split "extra packages" off from "common".

2023-10-20T05:06:24Z

Setup: Split "extra packages" off from "common".

@@ Line 421: / Line 421: @@
 </li>
 <li>
-Install packages:
+Install packages for the tools and dependencies required to build MegaZeux:
 <pre>
 sudo apt install build-essential gdb git zlib1g-dev libpng-dev libogg-dev libvorbis-dev libsdl2-dev
 </pre>
 </li>
@@ Line 457: / Line 434: @@
 </li>
 <li>
-Build MegaZeux:
+Build MegaZeux and run the tests. Debug builds are used to measure the times in the table above, as release builds can be quite slow to make in these VMs. Video is not required for any of these steps.
 <pre>
-./config.sh --platform unix-devel --enable-fps [any other flags here. release builds are NOT recommended.]
+./config.sh --platform unix-devel --enable-fps [any other flags here]
 time make [use -jX with -smp]
 time make unittest [use -jX with -smp]
@@ Line 466: / Line 443: @@
 </li>
 <li>
-Set up '''run.sh''' script and make sure the VM can start up with graphics and run MegaZeux with the software renderer. This may take some trial and error to get right, which is why the QEMU options are provided in the above tables.
+If the target supports video or needs extra packages, see "extra software".
 </li>
 <li>
@@ Line 500: / Line 477: @@
 XZ_OPT="-T0" tar -cJf vm-mzx-arch-debian-10.0.tar.xz arch/
 </pre>
 </li>
 </ol>

Lachesis: /* Common */ more optional packages.

2023-10-19T10:15:52Z

Common: more optional packages.

← Older revision		Revision as of 10:15, 19 October 2023
Line 428:		Line 428:
	# Graphical environment and browser.		# Graphical environment and browser.
	sudo apt install xorg i3 i3lock i3status rofi lynx		sudo apt install xorg i3 i3lock i3status rofi lynx

			# Sway might work better on some setups (encountered on AML-S905X-CC v1).
			sudo apt install sway xwayland i3status rofi lynx

	# Extra tools for building libxmp and xmp-cli from source.		# Extra tools for building libxmp and xmp-cli from source.
	sudo apt install autoconf automake libtool pkg-config cmake		sudo apt install autoconf automake libtool pkg-config cmake

			# clang may be useful for its sanitizers and built-in fuzzer, but it is quite large.
			sudo apt install clang clang-tools llvm

	# If this machine or VM is going to be shelled into:		# If this machine or VM is going to be shelled into:

Lachesis: /* Common */ Improve installed packages list, remove xdm, shorten .Xresources section.

2023-10-19T05:36:48Z

Common: Improve installed packages list, remove xdm, shorten .Xresources section.

@@ Line 392: / Line 392: @@
 </li>
 <li>
-Set up '''~/.Xresources.''' This is required to make urxvt not look awful.
+Set up '''~/.Xresources''' from [https://www.digitalmzx.com/lachesis/.Xresources here]. This is required to make urxvt not look awful.
 <pre>
-! "lumifoo" by gutterslob.
+cd ~
+wget https://www.digitalmzx.com/lachesis/.Xresources
 </pre>
 </li>
@@ Line 441: / Line 405: @@
 LC_COLLATE="C" \
 ls -la --color=always --group-directories-first "$@"
 </pre>
 </li>
@@ Line 446: / Line 423: @@
 Install packages:
 <pre>
-sudo apt install git p7zip-full build-essential gdb zlib1g-dev libpng-dev libogg-dev libvorbis-dev libsdl2-dev xorg i3 i3lock i3status rofi rxvt-unicode xdm lynx
+# Tools and dependencies required to build MegaZeux.
 </pre>
 Debian makes xterm default instead of urxvt, so fix that:
@@ Line 456: / Line 446: @@
 Set up MegaZeux repository:
 <pre>
-sudo mkdir /megazeux
+cd ~
-sudo chown mzx:mzx /megazeux
+git clone https://github.com/AliceLR/megazeux
 </pre>
 </li>