File	Date	Author	Commit
.settings	6 days ago	ken	[8a0290] Initial commit
lib	6 days ago	ken	[8a0290] Initial commit
src	6 hours ago	ken	[ce7631] playlist moved to the left
.gitignore	6 days ago	ken	[412839] Remove eclipse generated files
README	6 days ago	ken	[8a0290] Initial commit
README_SERVER	6 days ago	ken	[8a0290] Initial commit
RELEASE_HOWTO	6 days ago	ken	[8a0290] Initial commit
RELEASE_NOTES	2 days ago	ken	[5f5615] release notes
TODO	6 days ago	ken	[8a0290] Initial commit
latest.properties	6 days ago	ken	[8a0290] Initial commit
pom.xml	6 days ago	ken	[b2ddeb] switched to git
rule-set.xml	6 days ago	ken	[8a0290] Initial commit

Read Me

JSIDPlay2 is a very compatible and cycle exact C64 emulator.
The project contains emulation core library functions, a console player and a javafx user interface.
It runs as well completely in a browser using web assembly and javascript (using TeaVM) in high performance using worker threads.
It runs as well on the server side to stream C64 content to the browser and adds a complete music recognition system.
Various demo pages (online and offline demos) are included and served by our server (e.g. c64jukebox.vue).

Java requirements:
==================
For building the project:
Use Java 17 or newer 

For runtime:
Use Java 17 or newer or as an alternative Oracle-Java8 64-bit (we are still bytecode compatible)

Build JSIDPlay2
===============
mvn -Djavafx.platform=linux clean install								; # Use "linux"/"linux-aarch64", "win" or "mac"/"mac-aarch64" for your platform
-> target/standalone	-	local PC version
-> target/deploy		-	website version

Deploy JSIDPlay2
================
mvn -Djavafx.platform=linux clean deploy
"builds and uploads target/deploy to web-server"

Build JSIDPlay2 and runs UI-tests
=================================
mvn -Djavafx.platform=linux clean install -P release			"You should disable screensaver to not interfere with the tests"

Set the following optional properties to deploy additional online features:
at command line: using -D (or in Eclipse Open Preferences/Run/Debug/StringSubstitution)

-Dgb64.mdbfile=<pathToGameBase64.mdb>
-Dhvsc.7z=<pathToHVSC.7z>
-Dcgsc.7z=<pathToCGSZ.7z>
-Dhvmec.zip=<pathToHVMEC.zip>
-Dupx.exe=<pathToUPX>

Launch JSIDPlay2:
=================
mvn exec:java -Dexec.mainClass=ui.JSidPlay2Main

Launch JSIDPlay2Server:
=======================
mvn exec:java -Dexec.mainClass=server.restful.JSIDPlay2Server
Then open in a browser http://127.0.0.1:8080

Work with Eclipse:
==================
From the command-line:
mvn -Djavafx.platform=linux clean install
mvn eclipse:eclipse
then in Eclipse: Right-Click on Project Maven/"Update Project"

Eclipse JavaFX support:
=======================
1. Install e(fx)clipse
2. To get a content assistant on javafx css files:
Right click on your project -> properties -> Java build path -> libraries -> add library -> javaFX SDK
3. To edit .fxml files with FXML Editor:
Right click on .fxml file: Open With -> Other... -> FXML Editor (Check "Use it for all '*.fxml' files") -> OK
4. To use JavaFX Preview view in Eclipse, change root tag in fxml file (uncomment the commented out alternative version)
Eventually uncomment line in C64VBox.java (see TODO marker), still not sure, why some of the layouts need that.

HardSID in VirtualBox:
======================
Use HardSID4U, HardSID Uno and HardSID UPlay - USB devices:
Connect HardSID device to your real computer.
Allow Windows to use USB hardware with Virtual box Toolbar icon in the bottom right side of the window.
On Linux host your user has to be a member of the group: vboxusers to let virtualbox access USB hardware.
Start JSIDPlay2 and switch from Emulation to HardSID4U.
Check console, that there are no error messages.

Hard-wire HardSID: connect mixed/out into the Microfone/in of your computer:
In Ubuntu Linux with Pulseaudio installed transport Microfone sound to speakers;
Open a terminal and type:
parec --latency-msec=1 | pacat --latency-msec=1
Lower your microphone volume level to prevent overdrive noise

as an alternative use:
pactl load-module module-loopback latency_msec=1
and disable with
pactl unload-module module-loopback

If volume control is not shown in Ubuntu, type:
"gsettings set com.canonical.indicator.sound visible true"
If microphone is greyed out, type:
"kmix"
and change "output device" to "Analog Stereo Duplex".

Grant access to Linux input devices (Joystick support):
=======================================================
sudo usermod -a -G input ken	- replace ken with your username	
Now reboot!

General tips:
=============

How to Create a HTTPS certificate and install easily for your Apache web-server:
https://certbot.eff.org
Renewal:
sudo certbot certonly --standalone -d haendel.ddns.net

For support of double click on the JAR to start JSIDPlay2:
Right click on jsidplay-<version>.jar
Open with...
Choose a different one...
/home/ken/Downloads/jdk1.8.0_211/bin/java -jar
X Remember file type assignment

How to find out available JavaFX style classes of a node in the scene graph?
	private void dump(Node n, int depth) {
		for (int i = 0; i < depth; i++)
			System.out.print("  ");
		System.out.println(n);
		if (n instanceof Parent)
			for (Node c : ((Parent) n).getChildrenUnmodifiable())
				dump(c, depth + 1);
	}


Heap Memory Analyzer - To find memory leaks you can use:
jmap -dump:format=b,file=heap.bin <JavaProcessId>
Install Eclipse MAT (Heap Memory Analyzer) (https://www.eclipse.org/mat/)
Increase max memory, if required to load huge heap dumps in file MemoryAnalyzer.ini:
-Xmx=5g
In MAT - Load heap dump: File/Open heap.bin

jvisualvm - Monitor JVM:
Java JMX - jvisualvm connection parameters for JSIDPlay2:
-Dcom.sun.management.jmxremote.port=9999
-Dcom.sun.management.jmxremote.ssl=false
-Dcom.sun.management.jmxremote.authenticate=false
-Dcom.sun.management.jmxremote.local.only=false
-Djava.rmi.server.hostname=<server-ip>

Remote Debugging:
-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=9999

Internal Testing the build (Java8 and newer):
=============================================
cd target/standalone
cp ../deploy/*.sh .
chmod +x *.sh
./jsidplay2-console.sh 
./jsidplay2-console.sh ~/Downloads/Turrican_2-The_Final_Fight.sid 
export PATH=/home/ken/Downloads/jdk1.8.0_211/bin:$PATH
export PATH=/home/khaendel/Downloads/jre1.8.0_321/bin:$PATH
./jsidplay2-java8.sh ~/Downloads/Turrican_2-The_Final_Fight.sid 
./jsidplay2.sh ~/Downloads/Turrican_2-The_Final_Fight.sid 
./sidblastertool.sh 
./recordingtool.sh 
cd ../deploy/
java -jar ./jsidplay2-4.13-libsidplay.jar ~/Downloads/Turrican_2-The_Final_Fight.sid 
unzip jsiddevice-4.13.zip
./jsiddevice-4.13/jsiddevice.sh
./jsiddevice-4.13/jsiddevice-console.sh