======BTT0 documentation======

=====Resources=====

====URLs====
https://www.vircon32.com/

https://github.com/vircon32/ComputerSoftware/releases/tag/devtools-v25.1.19

====API====
https://www.vircon32.com/api.html
=====Vircon32=====

====Obtain source of latest stable release of Vircon32 DevTools====

===environment configuration===
If you are installing Vircon32 on Windows you will need to make a new environment variable to be able to use the command line executables.
Search for Control Panel in the system settings and from there search for Environment Variables.
Select "Edit environment variables for your account".
Add a new variable titled "PATH" and when asked for a location use the location of your DevTools folder.

====Obtain source of latest stable release of Vircon32 emulator====

Due to us building Vircon32 from source the Emulator and DevTools will be included in the file we obtain.\\ 
You only need to worry about the build number which the newest is currently **v.25.1.6**

===URL===

You can obtain the file in question from the Vircon32/ComputerSoftware repository on GitHub
[[https://github.com/vircon32/ComputerSoftware/releases|Vircon32 Releases]]\\ 
For our usage you will want to grab the **Source code (tar.gz)** that is within the Assets toggle of any **v.25.1.6** release\\ 
Releases are posted in a way where the top most is the newest.

===environment configuration===

As with DevTools, there are a handful of dependencies you will want to install and most of which are listed on the **Read.me** that comes in the tar.gz file\\ 
One dependency that you will need and is not listed is **libgtk2.0-dev**\\ 

A slight deviation from the Readme is that due to us using a pi or Debian-based system you will want to swap out the MSYS for Unix in the command **cmake -G 'MSYS Makefiles' ..**\\ 

After the rest of the Readme is followed everything should be installed properly. It is then imperative you add Vircon32 to your path.\\ 
The installed location should be **/usr/local/Vircon32/**\\ 
Once added to your path you should be able to run the Vircon32 command anywhere to run the emulator.\\
To add it to your path add the line: <code>export PATH="/usr/local/Vircon32/Emulator/:/usr/local/Vircon32/DevTools:${PATH}"</code> to your ~/.bashrc file\\
=====Hello World=====
Bootstrap a fairly simple “Hello, World” example, modified sufficiently from any provided tutorial or demo code.

This is a link to the provided tutorials on the Vircon Github page:
https://github.com/vircon32/ConsoleSoftware/tree/main/Tutorials/RobotGame

Alternatively you can create a "Hello, World" program from the ground up using the video.h header file. 

The documentation needed for printing can be found [[https://www.vircon32.com/api/video.html#Printing%20text%20on%20screen|here]]
  * **TIP** If you want to see what exactly a function from a header file does you can find the source files at /usr/local/Vircon32/DevTools/include/

Indicate some potential changes/functions used here.

Some potential changes/functions could be:
  * Changing the position of the text( making it appear in the bottom right of the screen )\\
  * Changing the color of the text
  * Changing what the text says ( and / or make it a different language )
  * Changing the background color to one of the provided colors( make it green )\\
  * Implementing your own background( make it Jesse from Breaking Bad )\\
  * Making your own font( Turn a tree into the alphabet )\\
  * Adding sounds( like it saying "Mr.Worldwide" ) when booting up the demo
=====Cartridge Build Scripts=====
In the tutorials and demos there are corresponding build scripts that will take all the code and related resources, and run the appropriate development tools to create a Vircon32 cartridge file.

Part of your task is to author your own custom build script. Do not just use an existing script, and do not just lightly modify the provided scripts: craft your own, with descriptive comments, that suit your individual effort.

The script you make now does not have to be the only one you make; in fact you should improve the functionality of your build script when you find ways to, or run into inconveniences that can be mitigated