info.yaml

--- 
# TinyTapeout project information
project:
  wokwi_id:    0        # If using wokwi, set this to your project's ID

# If using an HDL, set wokwi_id as 0 and uncomment and list your source files here. 
# Source files must be in ./src and you must list each source file separately
  source_files:        
    - tt_um_santacrc_tamagotchi.v
    - stats.v
    - random.v
    - uart.v
  top_module:  "tt_um_santacrc_tamagotchi"      # put the name of your top module here, make it unique by prepending your github username

# How many tiles your design occupies? A single tile is about 167x108 uM.
# Before changing this, please reach out to us on discord to discuss your design.
  tiles: "1x1"    # Valid values: 1x1, 1x2, 2x2, 4x2 or 8x2

# Keep a track of the submission yaml
yaml_version: 4

# As everyone will have access to all designs, try to make it easy for someone new to your design to know what
# it does and how to operate it. This info will be automatically collected and used to make a datasheet for the chip.
#
# Here is a great example: https://github.com/davidsiaw/tt02-davidsiaw-stackcalc/blob/38c5647f83aad2aec675d566aa3d67b98f0aac81/info.yaml
documentation: 
  author:       "Fabian Alvarez"
  title:        "Tamagotchi"
  language:     "Verilog"
  description:  "Simple Console Tamagotchi"

# Longer description of how the project works. You can use standard markdown format.
  how_it_works: |
      Connect rx and tx to a serial terminal. The game will start automatically, if the tamagotchi dies, press the reset button to start again.
      feed all the stats to keep the tamagotchi alive (food, sleep, happiness, hygiene, social), when the tamagotchi are sleeping, you cannot interact with it.
      Controls:
      - E: feed
      - S: sleep
      - P: play
      - B: clean
      - T: talk
      - W: wake up


# Instructions on how someone could test your project, include things like what buttons do what and how to set the clock if needed
  how_to_test:  |
      Use a 27MHz clock. Connect rx and tx to a serial terminal. The game will start automatically, if the tamagotchi dies, press the reset button to start again.

# A description of what the inputs do (e.g. red button, SPI CLK, SPI MOSI, etc).
  inputs:               
    - rx
    - none
    - none
    - none
    - none
    - none
    - none
    - none
# A description of what the outputs do (e.g. status LED, SPI MISO, etc)
  outputs:
    - tx
    - none
    - none
    - none
    - none
    - none
    - none
    - none
# A description of what the bidirectional I/O pins do (e.g. I2C SDA, I2C SCL, etc)
  bidirectional:
    - none
    - none
    - none
    - none
    - none
    - none
    - none
    - none

# The following fields are optional
  tag:          "CMD, Tamagotchi, Game"      # comma separated list of tags: test, encryption, experiment, clock, animation, utility, industrial, pwm, fpga, alu, microprocessor, risc, riscv, sensor, signal generator, fft, filter, music, bcd, sound, serial, timer, random number generator, calculator, decoder, counter, puzzle, multiplier, game, oscillator,
  external_hw:  ""      # Describe any external hardware needed
  discord:      ""      # Your discord handle, used for communication and automatically assigning tapeout role after a submission
  doc_link:     ""      # URL to longer form documentation, eg the README.md in your repository
  clock_hz:     27000000       # Clock frequency in Hz (if required)
  picture:      ""      # relative path to a picture in your repository