User Tools

Site Tools


Sidebar

projects

pct0 (bonus; due 20230823)
wcp1 (due 20230823)
abc0 (due 20230830)
btt0 (due 20230830)
pct1 (bonus; due 20230830)
pct2 (due 20230830)
wcp2 (due 20230830)
mpg0 (due 20230906)
pct3 (bonus; due 20230906)
wcp3 (due 20230906)
pct4 (due 20230913)
ttb0 (due 20230913)
wcp4 (due 20230913)
pct5 (bonus; due 20230920)
ttb1 (due 20230920)
wcp5 (due 20230920)
dap0 (due 20230927)
gfo0 (due 20230927)
pct6 (due 20230927)
wcp6 (due 20230927)
cgf0 (due 20231004)
pct7 (bonus; due 20231004)
wcp7 (due 20231004)
bwp1 (bonus; due 20231018)
cgf1 (due 20231018)
pct8 (due 20231018)
wcp8 (due 20231018)
cgf2 (due 20231025)
pct9 (bonus; due 20231025)
wcp9 (due 20231025)
cgf3 (due 20231101)
gfo1 (due 20231101)
pctA (due 20231101)
wcpA (due 20231101)
pctB (bonus; due 20231108)
waq0 (due 20231108)
wcpB (due 20231108)
pctC (due 20231115)
waq1 (due 20231115)
wcpC (due 20231115)
bwp2 (bonus; due 20231129)
pctD (bonus; due 20231129)
wcpD (bonus; due 20231129)
gfo2 (due 20231206)
pctE (bonus; due 20231206)
wcpE (bonus; due 20231206)
EoCE (due 20231214)
haas:fall2023:data:projects:btt0

Corning Community College

CSCS2320 Data Structures

PROJECT: Building The Thing (BTT0)

OBJECTIVE

Obtain the latest stable release of Vircon32, in source code form, and build it and the associated DevTools in your development system. Collaboratively document the build process.

EDIT

You will want to go here to edit and fill in the various sections of the document:

BTT0 documentation

Tasks

Obtain source of latest release of Vircon32 (emulator and DevTools)

To obtain the latest source of Vircon32 for both the emulator and DevTools, navigate to the Vircon32 homepage. On the left navigation menu you will want to click Emulator and click Emulator for PC

Scroll to the bottom of the new page under the Assets toggle you will see Source code.

For Unix based systems including Pi you will want to download the (tar.gz) version.

Another option to get the source code of different repositories onto your pi is to clone it from the Vircon32 github page. Once on the page, click on the repository you want to clone and copy its url. On your pi terminal go to the location you want to put the repository in and clone it from github using “git clone url_of_repository”. For this project you will want the computer software repository to make the emulator and dev tools from them. The documents and console software repositories can also include helpful information.

Extract files, read instructions, install needed dependencies

Open your terminal, navigate to where your file was saved (Most likely Downloads) and proceed to extract it.

You will now have a directory of the same name as that archived file, cd into it and read the Readme.md

Following the Readme, install the needed dependencies and create the appropriate directories.

To begin you will want to start with either the DevelopmentTools or Emulator

cd into one of those two directories and perform

mkdir build

It may be helpful to have the Readme available while you're in the build directory. Start by installing cmake if it's not already installed. Perform step 2 in the Readme as indicated. To install cmake or any other dependencies you may need for Vircon32, use:

sudo apt install [package]

You should receive an error saying MSYS Makefiles doesn't exist and you'll be given a list of options to use. For Linux/Pi users, use the Unix Makefiles and repeat.

You'll now get an error about not having a file called CMakeLists.txt Find that file and copy it into builds, although as long as CMakeLists.txt is in the same directory as the builds directory (DesktopEmulator/build or DevelopmentTools/build), it should work fine.

Keep trying to run command #3 in the Readme, it'll likely need further dependencies before it can get through without experiencing an error. The dependencies needed are listed at the bottom of the Readme. Use the following command to search for the necessary libraries, those library names should be all lowercase when searched.

aptitude search [package]

You'll likely be given a bunch of packages when running this command, look for the ones that resemble lib[package]-dev. Install it using the command format given above. You are (or will be) a developer in this class, you'll need these packages installed moving forward. When you test out command #3 from the Readme again, you'll know it worked if you don't get the error for that specific dependency.

When searching for libraries, you may get the following error:

E: Unable to locate package

In this case first check your spelling and make sure it is correct. If the issue persists, try running with the command sudo apt update to make the current system is up to date.

Prepare and build (for system/OS)

Replicate section per system/OS you are building for

Now that you have the Vircon32 emulator and Dev-tools, its time to modify the PATH of your system so that you can use the various command line tools that they offer, such as assemble or compile, anywhere on your system. First you need to locate where they are in your system, and make sure to note down the file path.

Linux-

To save the path of your emulator and dev-tools in a Linux environment you need to use this command.

  pi@raspberry:~$ export PATH="/path-to-dev-tools:$PATH"
  pi@raspberry:~$ export PATH="/path-to-emulator:$PATH"

to see if the path was added correctly input the (echo “$PATH”) command, at this point your path should look something like this.

 /opt/Vircon32/Emulator:/usr/local/Devtools:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin

These paths are temporary and will not save after you exit the terminal so its ok to mess up at this stage. After you are sure that you got the correct file path, its time to add them to your system so that they don't erase after you close the terminal.

  pi@raspberry:~$ nano ~/.bashrc

At the bottom of this file add the two commands that you used to add the file paths, and boom you can now use the command line tools from the emulator and Devtools wherever you are on your system. 8-)

If you’re having trouble locating the files, you can check the install_manifest.txt file in the build directory to see where the files are stored.

Creating your hello.c, hello.xml, and make.sh file
  • Step 1: On your Pi or virtual machine, go into your local Lab46 repo and cd either into your Data or Discrete directory.
  • Once in the directory, do
    mkdir btt0

    and cd into it.

  • Once in btt0 directory, you'll need to create 3 files, hello.c, hello.xml, and make.sh.
  • Once created, go to
    https://github.com/vircon32/ConsoleSoftware/tree/main/Tutorials/RobotGame/Tutorial01A-HelloWorld
  • Copy the contents of each file from GitHub into their respective files in your btt0 directory.
  • Make sure to go into the make.sh file and adjust the names of files as we have changed them compared to what is listed on GitHub.

Its important at this stage to make the make.sh an executable, to do this type chmod +x make.sh, this adds the executable file permission to the file.

  pi@raspberry:~$ chmod +x make.sh

Its finally time to compile your first vircon32 game, to do this do ./make.sh and if no errors occur it should print out build successful.

There should now be a .v32 file in the bin directory. Load this into the emulator to run the program. The emulator is in the opt/Vircon32/Emulator file. Cartridges may take time to load.

After that you will want to make a file similar to hello.c,hello.xml, and make.sh . The file that you are going to submit is going to be a modified version of hello.c . So text on a page, but the amount,size,color,etc is up to you but the changes have to be significant.

 

SUBMISSION

To be successful in this project, the following criteria (or their equivalent) must be met:

  • Project must be submit on time, by the deadline.
    • Late submissions will lose 33% credit per day, with the submission window closing on the 3rd day following the deadline.
  • Executed programs must display in a manner similar to provided output
    • output formatted, where applicable, must match that of project requirements
  • Processing must be correct based on input given and output requested
  • Output, if applicable, must be correct based on values input
  • Code must be nicely and consistently indented
  • Code must be consistently written, to strive for readability from having a consistent style throughout
  • Code must be commented
    • Any “to be implemented” comments MUST be removed
      • these “to be implemented” comments, if still present at evaluation time, will result in points being deducted.
      • Sufficient comments explaining the point of provided logic MUST be present
  • No global variables (without instructor approval), no goto statements, no calling of main()!
  • Track/version the source code in your lab46 semester repository
  • Submit a copy of your source code to me using the submit tool by the deadline.

Submit Tool Usage

Let's say you have completed work on the project, and are ready to submit, you would do the following:

lab46:~/src/SEMESTER/DESIG/PROJECT$ submit DESIG PROJECT file1 file2 file3 ... fileN

You should get some sort of confirmation indicating successful submission if all went according to plan. If not, check for typos and or locational mismatches.

RUBRIC

I'll be evaluating the project based on the following criteria:

13:btt0:final tally of results (13/13)
*:btt0:submitted demo code for project by duedate [4/4]
*:btt0:contributed to project documentation [4/4]
*:btt0:committed project related changes to semester repo [5/5]

Pertaining to the collaborative authoring of project documentation

  • each class member is to participate in the contribution of relevant information and formatting of the documentation
    • minimal member contributions consist of:
      • near the class average edits (a value of at least four productive edits)
      • near the average class content change average (a value of at least 128 bytes (absolute value of data content change))
      • near the class content contribution average (a value of at least 1kiB)
      • no zero-sum commits (adding in one commit then later removing in its entirety for the sake of satisfying edit requirements)
    • adding and formatting data in an organized fashion, aiming to create an informative and readable document that anyone in the class can reference
    • content contributions will be factored into a documentation coefficient, a value multiplied against your actual project submission to influence the end result:
      • no contributions, co-efficient is 0.50
      • less than minimum contributions is 0.75
      • met minimum contribution threshold is 1.00

Additionally

  • Solutions not abiding by spirit of project will be subject to a 50% overall deduction
  • Solutions not utilizing descriptive why and how comments will be subject to a 25% overall deduction
  • Solutions not utilizing indentation to promote scope and clarity or otherwise maintaining consistency in code style and presentation will be subject to a 25% overall deduction
  • Solutions not organized and easy to read (assume a terminal at least 90 characters wide, 40 characters tall) are subject to a 25% overall deduction
haas/fall2023/data/projects/btt0.txt · Last modified: 2023/08/23 18:42 by wedge