Skip to content
tslmyPublic
forked from foopod/sips

About

GBA Title Screen Jam 2023

Resources

Stars

1 star

Watchers

0 watching

Forks

 
 

Repository files navigation

Sips

codecov

A chill idle game for GBA.

image

image

Originally built by Jono Shields over WinterJam23, this fork has added the following changes:

  • UX
    • If you attempt to buy something you can't afford, the cursor will shake and play a sound.
    • The cursor will now skip already-purchased items.
    • The menu now slides in & out from the top.
    • Press L+R together to enter/exit "highlight" mode. A customer will be selected, and his/her current state will be printed at the bottom of the screen. Pressing L/R will cycle the cursor around all customer on screen.
  • NPC behavior
    • People may simply pass by, not coming in for a drink.
    • People may loiter on the street for a short while.
    • People now walk (or loiter) at random positions in the vertical (y-axis) direction.
  • Dev-only
    • Adopted Google C++ Style, automatically enforced via pre-commit hooks.
    • Replaced vanilla make with CMake as the build system.
    • Added unit tests. (See "Testing" below.)

How to play

Press A to open wishlist. Move cursor up and down with the D pad. Press A again to purchase it, or press B to close the wishlist. With more items purchased, your cafe will be more popular (indicated by the bar gauge in the top-left corner).

Development

This repo uses pre-commit hooks. Ensure you have prek installed. After cloning the repo, run prek install in the repo's directory before your first commit. You only have to do this per clone.

To build the source code and test code in this repository, you'll need (macOS instructions in parenthesis):

  • CMake (Available via Homebrew.)
  • devkitARM (You'll need to install it using their own fork of Pacman.)
  • Git (Don't just download the codebase as zip; it won't compile, because we need submodules.)

  • just (For simplifying frequently-used commands.)

Clone with submodules:

git clone --recurse-submodules https://github.com/tslmy/sips.git

Build

To build the GBA ROM, run just build. This will create sips.gba in the project root, ready for use in a GBA emulator.

Testing

This project uses Catch2 for unit tests. This dependency is managed via Conan. Since Conan is written in Python and I use uvx to manage everything with Python, I use uvx to run conan without explicitly installing it, too.

Ensure you have these commands installed: just, uv. On macOS, just run brew install just uv.

Run just test to build and run tests.

WIP: Code coverage. I'm still trying to figure out how to make code coverage accurate.

  • The report is missing main.cpp.
  • .github/workflows/coverage.yml should use just test instead of duplicating the commands.

About

GBA Title Screen Jam 2023

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages