User Tools

Site Tools


Sidebar

projects

wcp1 (due 20240828)
btt0 (due 20240904)
wcp2 (due 20240904)
pct0 (bonus; due 20240905)
pct1 (bonus; due 20240905)
pct2 (due 20240905)
abc0 (due 20240906)
msi0 (due 20240911)
pct3 (bonus; due 20240911)
wcp3 (due 20240911)
msi1 (due 20240918)
pct4 (due 20240918)
wcp4 (due 20240918)
msi2 (due 20240926)
pct5 (bonus; due 20240926)
wcp5 (due 20240926)
gfo0 (due 20241002)
msi3 (due 20241002)
pct6 (due 20241002)
wcp6 (due 20241002)
cgf0 (due 20241009)
pct7 (bonus; due 20241009)
wcp7 (due 20241009)
bwp1 (bonus; due 20241016)
cgf1 (due 20241016)
pct8 (due 20241016)
wcp8 (due 20241016)
cgf2 (due 20241023)
pct9 (bonus; due 20241023)
wcp9 (due 20241023)
gfo1 (due 20241030)
mag0 (due 20241030)
pctA (due 20241030)
wcpA (due 20241030)
mag1 (due 20241106)
pctB (bonus; due 20241106)
wcpB (due 20241106)
mag2 (due 20241113)
pctC (due 20241113)
wcpC (due 20241113)
pctD (bonus; due 20241120)
wcpD (bonus; due 20241120)
bwp2 (bonus; due 20241204)
gfo2 (due 20241204)
pctE (bonus; due 20241204)
wcpE (bonus; due 20241204)
EoCE (due 20241216)
haas:fall2024: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

If you have a question, put the clarification in this document.

Resources

URLs

To get the Vircon32 DevTools go to https://github.com/vircon32/ComputerSoftware and download the provided tools. This can be found on the right side of the screen under a section called “Releases.” This page is where you can find the appropriate package for your system. Once downloaded read the provided Readme.md for the instructions on how to install Vircon32. A nice way to check if you installed Vircon32 correctly is to try putting “Vircon32” in the command line. If it opens Vircon32 it worked.

API

Here is the link to Vircon32's API page: http://www.vircon32.com/api.html

This page serves as a comprehensive reference of all the functions available in Vircon32’s C compiler. You will find this page useful since the C compiler for Vircon32 is different from standard C.

Vircon32

Obtain source of latest stable release of Vircon32 DevTools & Emulator
For Linux users
  • Obtain the source.tar.gz file for latest edition of Vircon32/ComputerSoftware/ from the Releases
  • Navigate to the location of your now downloaded .tar.gz file and extract using
    tar xvcf [file].tar.gz
For Windows users
  • Obtain the source.zip file for latest edition of Vircon32/ComputerSoftware/ from the Releases
  • Navigate to the location of your now downloaded .zip file and extract
System independent
  • You should now have a directory you can navigate into called ComputerSoftware/
  • Navigate inside and check for two directories call DesktopEmulator/ and DevelopmentTools/

Vircon32 installation

At the base of the ComputerSoftware/ directory there should be a file named Readme.md, you will refer to this heavily

Following the Readme, install all dependencies

These steps will be done the same in both the DesktopEmulator/ directory and the DevelopmentTools/ directory

Again following the Readme

  • Create a build/ directory off of the DesktopEmulator/ and DevelopmentTools/ directories and enter it
  • For Linux systems & Pi rather than MSYS Makefiles you will want Unix Makefiles
  • Follow the remaining commands in the Readme to the end
  • Keep track of where the Emulator and the DevTools are installed and add those paths to your ~/.bashrc
  • Don't forget to run source ~/.bashrc or close/reopen your terminal

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:

Some potential changes/functions could be:

  • Changing the position of the text
  • Changing the color of the text
  • Changing what the text says
  • Changing the background color to one of the provided colors
  • Implementing your own background
  • Making your own font
  • Adding sounds
Implementing your own Background

A Vircon32 image file:

  • has a max size of 640×360 pixels
  • will also only take “.png” files
  • needs the “video.h” library

You can implement libraries in your “.c” file with

#include "library name"

But to be able to use it in the “.c” file you need to define it in the “.sh” and “.xml” files.

Open your “.sh” file and for images do:

png2vircon FileName.png -o obj/FIleName.vtex || abort_build

And then open your “.xml” file and for images do:

 <textures>
  <texture path="obj/Start.vtex" />
 </textures>

Back in your “.c” file we have to define the Texture and it Region:

#define TextureFileName  0
#define RegionFileName   0

The value corresponds to where it sits in your “.xml” file. If FileName is the first texture being made then the value is 0. If it's the second texture then the value = 1, etc…

This is also the same for audio files, so your first audio file's value would correspond to 0.

Region can be 0 for backgrounds.

You then have to define it in the “.c” file again:

select_texture( TextureFileName );
select_region( RegionFileName );
define_region_topleft( 0,0, 639,359 );

Then to call it use:

select_texture( TextureFileName );
select_region( RegionFileName );
draw_region_at( 0,0 );

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.

 

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:

26:btt0:final tally of results (26/26)
*:btt0:submitted modified demo code for project by duedate [6/6]
*:btt0:submitted custom build scripts and supporting resources [6/6]
*:btt0:submitted code builds without warning or error [6/6]
*:btt0:committed project related changes to semester repo [8/8]

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 1024 bytes (absolute value of data content change))
      • 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/fall2024/data/projects/btt0.txt · Last modified: 2024/07/31 13:52 by 127.0.0.1