User Tools

Site Tools


haas:fall2023:discrete:projects:yol0

Corning Community College

CSCS2330 Discrete Structures

PROJECT: Your Own Logic (YOL0)

OBJECTIVE

Occasionally there is value reinventing certain wheels, either to establish specific use-case functionality better than the generic option, or to better understand how the generic option functions. This could well be a combination of the two.

Here we explore creating our own infrastructure for managing and displaying information: numbers.

TASK

Implement the needed functionality (functions as needed) in C that uses a custom texture file (providing the numbers) and handles displaying them to the screen.

EDIT

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

yol0

Creating a Matrix

NOTE: The following matrix is based on the following texture file: https://github.com/vircon32/ConsoleSoftware/blob/main/Games/BasicPlatformer/textures/TextureTextFont.png

Notice how the letters in the file are laid out in a grid pattern. This indicates that using a matrix is the best option and will make it way easier to create our custom font.

Start off by defining our texture and regions in our texture file.

// Texture in Cartridge
#define TextureTextFont 0
// Region definition
#define FirstRegionTextFont 1

In your main loop you will want to select the texture and instead of using define_region use define_region_matrix.

Vircon gives the following description of define_region_matrix “Defines a set of same-sized regions within the selected texture that are laid out as a rectangular matrix. Consecutive IDs will be defined from left to right, and top to bottom. All regions will have the same relative hotspot position.”

Here is the format for define_region_matrix:

define_region_matrix(RegionID, TopleftX, TopleftY, BottomrightX, BottomrightY, HotspotX, HotspotY, columns, rows);
//These will be for the first region as the others will be automaticly created in sequence.

For the specific texture font in this case this is what it should look like in your main:

    // Selecting texture in cartridge
    select_texture( TextureTextFont );
 
    // Creating matrix for texture file
    define_region_matrix( FirstRegionTextFont,  0,0,  21,31,  0,31,  16,8,  0 );

After calling select_texture() , all texture functions will apply to that texture from that moment. If you’re using multiple textures, you may need to call select_texture again depending on the order of things in your program to make sure the correct texture is being referenced.

scaling numbers

There are a few different functions in vircon32 that can help change the things you display to a better size. one of those being to scale the image on the x and y. This can be very helpful if the numbers or images you have are too big or small. To change the size of the image; you have to first set the drawing scale, you can think of this as the number you want to multiply the size of the image by. It takes two floats as inputs so you can change the size of the image to your preference. Then instead of using the draw_region_at(); function you would use the draw_region_zoomed_at(x,y); to draw your new bigger/smaller image on the screen.

  float scale = 3;
  set_drawing_scale(scale,scale);
  //select_texture();
  //select_region();
  draw_region_zoomed_at(x,y);

Custom Texture File

This is the png file that will contain the numbers you will be using to print to the screen. The numbers can be arranged depending on functionality you use to print the numbers to the screen, as well as how you would like to define the regions. One way to go about this is to have the numbers arranged in symmetrical tiles and define them using the “define_region_matrix” function. With this you can assign an int value to each tile/number and call that value to print your texture region to the screen.

Creating a custom font

Creating a custom font is a very similar process to creating a Vircon32 texture sheet, simply scaled up depending on how many characters are being included.

After drawing up the font sheet .png file with every character, use Vircon32's functions of #define and define_region_matrix() to establish sequential IDs for each character. To keep the program code neat, the code regarding the font definitions and functions will be stored in a header file.

Note: Since our font texture sheet is in a separate file from our main texture file for the game, our .xml file will need to be updated to account for both files. When using select_texture(), the number that gets input directly correlates to the order of the files in the .xml. (ie, 0 = first file, 1 = second file, etc. )

Drawing integers using a custom font

In order to draw a given integer in any base, we'll need to make a function. Our function will be given the parameters of the input number, the base to convert to, and X/Y positional data.

First, we'll need to declare some local variables. A check integer will be used to test how many digits long the output number will be, and a print integer will show which number to print out at any given position.

Second, run through a loop so that the check variable is at the same order of magnitude as the number while still being less than or equal to. Now we're ready to print out our converted number.

Lastly, we run a while loop until check is zero. print gets assigned to the number divided by the check. Then, the number gets assigned to the remainder of that division. print is used to get the texture region ID for the number digit in our custom font, and that character gets printed at the given location. Lastly the positional data is updated so that the digits aren't all in the same position.

Drawing strings using a custom font

Vircon32 stores string values as an array of integers containing the ASCII value for the given character. Since our font sheet uses a different ID system to the ASCII standard, they'll need to be converted. This involves a new function to return an int with the proper value. (it involves too many if statements)

The main while loop for printing out strings is roughly the same as our function for printing integers. Once the proper texture region ID is selected, it prints out and the positional data is adjusted.

 

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:

104:yol0:final tally of results (104/104)
*:yol0:functionality present and operational [26/26]
*:yol0:code assembles with no warnings or errors [26/26]
*:yol0:all game and build related files submitted [26/26]
*:yol0:some significant project incorporates this [26/26]

The discrete version of yol0 will focus on a C version of this process.

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))
      • 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/discrete/projects/yol0.txt · Last modified: 2023/10/05 09:27 by 127.0.0.1