How_to_Find_Chart_library.txt

How to Find the Library (.dll file) for Chart Parsing

Step 1 (The file path on Git): ChartParser\ChartParser\bin\Debug\netstandard2.0/ChartPaser.dll 

Step 2 (adding to visual studio): In your visual studio project for unity, then go to click on your project tab, which is
				  near the top of the screen.
				  
	- in the drop doen menu, click on "Add Reference" and a window will pop up called "Reference Manager"
	- Select the browse button and find the ChartPaser.dll file and select it
	- Then click the "Ok" button

Step 3 (Using the Library): In your code window put "using ChartParser;"

	- Then you create a "Song" object to hold the return of the paser function 
	  (var song = new Song();)
	- Create a string variable that will hold your filepath to the chart
	- Next you will write the following code to call the chart parser and to get your return values
	(Song = Parser.ChartReader(FilePath);)
	- Now the "Song" object will contain 4 elements:
	- Object 0: A object called "MetaDataInfo" containing variables about song name, offset, resolution,etc.
	- Object 1: A List of objects called "SyncTrackData" that contain "SyncTrack" objects
		-"SyncTrack" objects contain "int timeStamp", "int duration", "string identifier"
	- Object 2: A List of objects called "EventData" that contain Events objects
		-"Events" objects contain "int timeStamp", "string songPart", "string identifier"
	- Object 3:A object called "NoteTracksList" that contains lists of diffculties that contain Note objects
		-The lists are called Easy, Medium, Hard, and Expert
		- Note objects contain "int timeStamp", "int duration", "string type", "List<ButtonColor> chord"
		- List<ButtonColor> chord contains enums values of the notes to played in that chord
		  EX:"Chord = [ButtonColor.Red,Color.Green]" this means that the notes will be 
	             red and green togather. 
	- Also all enums are set equal to 1

Side Notes:
	   I'm pretty sure all variables listed above have there own get and set methods 
	   Make sure you have the right file path because I did not do any checks to see if its wrong (work in progress)