BizHawk/waterbox
nattthebear 2ee3125724 Refactor gpgx init method to use fewer arguments
Upcoming waterbox changes will likely limit the number of arguments a function can take to 6, which should be enough for anybody
2020-07-03 13:24:54 -04:00
..
emulibc Rewrite WaterboxHost in rust. (#2190) 2020-07-03 11:45:59 -04:00
gpgx Refactor gpgx init method to use fewer arguments 2020-07-03 13:24:54 -04:00
libco Rewrite WaterboxHost in rust. (#2190) 2020-07-03 11:45:59 -04:00
libcxx remove cgc (step 1) 2020-06-20 00:48:42 -04:00
libsnes milestone: vb and ngp compile 2020-05-25 12:49:30 -04:00
llvm-project@eaae6dfc54 Move llvm to submodule 2020-06-19 20:56:17 -04:00
musl@fc0fd09fa3 Rewrite WaterboxHost in rust. (#2190) 2020-07-03 11:45:59 -04:00
nyma rename pce and pce-fast to turbo and hyper 2020-06-20 20:12:46 -04:00
picodrive 32x - fix crash, fixes #1826 2020-05-21 10:04:12 -04:00
sameboy waterbox sgb sameboy - fix stereo audio 2020-06-06 07:55:21 -04:00
snes9x@172f73b711 snes9x - take advantage of new waterbox change tracking to fix special chip games 2020-06-03 19:25:58 -04:00
thunk linux: support gpgx 2020-06-06 18:25:59 -04:00
uzem milestone: vb and ngp compile 2020-05-25 12:49:30 -04:00
vb milestone: vb and ngp compile 2020-05-25 12:49:30 -04:00
waterboxhost Rewrite WaterboxHost in rust. (#2190) 2020-07-03 11:45:59 -04:00
.gitignore Revamp waterbox build environment and runtime. (#2027) 2020-05-20 15:34:24 -04:00
Notes on Debugging.md Rewrite WaterboxHost in rust. (#2190) 2020-07-03 11:45:59 -04:00
common.mak waterbox: minor makefile tweak 2020-06-03 17:57:31 -04:00
linkscript.T waterbox: fix linker script putting __eh_frame_hdr_start in the wrong place 2020-05-25 21:02:01 -04:00
readme.txt updated waterbox docs 2020-06-20 20:13:00 -04:00
waterbox-Makefile.all makefile to build all waterbox cores 2019-12-24 14:29:28 -05:00

readme.txt

This is the native side of the experimental "waterbox" project for bizhawk.
It consists of a modified musl libc, and build scripts to tie it all together.


1. Set up your platform.
	The prescribed possibilities are not exhaustive. Other platforms may work.
	Here are the supported alternatives:

	PREPARE A WIN10 WORKSTATION:
	Using the guidance at (https://docs.microsoft.com/en-us/windows/wsl/wsl2-kernel & https://docs.microsoft.com/en-us/windows/wsl/install-win10):
	1. Install WSL2 
	2. Install Ubuntu 20.04 LTS (https://www.microsoft.com/en-us/p/ubuntu-2004-lts/9n6svws3rx71)
	3. Clone the bizhawk repository. You can use it through /mnt or /home if you really like 
	4. Install build tools: sudo apt-get update && sudo apt-get install gcc g++ make cmake llvm
	4b. (Note for future work: ideally the llvm installed above would not be required)

	PREPARE A WIN10 VM:
	1. Make sure the VM has "yo dawg" virtualization enabled on the guest. For example in VMWare Workstation, "Virtualize Intel VT-X/EPT or AMD-V/RVI"
	2. Follow WIN10 Workstation preparation guide
	3. If you wish to clone bizhawk on your host system (slower but maybe more convenient), you can use a VMWare shared folder and: `sudo mount -t drvfs Z: /mnt/z -o rw,relatime,metadata,uid=1000,gid=1000` (WSL won't auto-mount the shared drive)

	PREPARE A LINUX WORKSTATION:
	1. TODO. This should work, but no one has tested it yet

2. Build libraries.
	cd musl
	./configure-for-waterbox
	make
	make install
	cd ../emulibc
	make
	cd ../libco
	make
	cd ../libcxx
	./do-everything.sh
	cd ..

3. Some additional preparation is required before all the cores can be built:
	cd nyma && ./build-and-install-zlib.sh

4. You are now ready to start building cores. Each supports `make` and `make install`, as well as `make debug` and `make install-debug` for local development.  From the root directory, the following should all be valid:
	cd gpgx && make install
	cd libsnes && make install
	cd nyma && make -f faust.mak install
	cd nyma && make -f ngp.mak install
	cd nyma && make -f turbo.mak install
	cd nyma && make -f hyper.mak install
	cd nyma && make -f pcfx.mak install
	cd nyma && make -f ss.mak install
	cd picodrive && make install
	cd sameboy && make install
	cd snes9x && make install
	cd uzem && make install
	cd vb && make install