CircuitPython Usage
To use the game, you need to add theĀ game program files to theĀ CIRCUITPY drive. The game consists of a handful of Python files, graphics, sounds, and fonts.
Thankfully, installing everything be done in one go. In the example below, click the Download Project Bundle button below to download the necessary libraries and game filesĀ in a zip file.
Connect your board to your computer via a known good data+power USB cable. The board should show up in your File Explorer/Finder (depending on your operating system) as a flash drive named CIRCUITPY.
Extract the contents of the zip file, copy the lib directory files to CIRCUITPY/lib. Copy the entire contents of the appropriate CircuitPython folder to your CIRCUITPY drive. The program should self start.
The settings.toml File
Included in the game files is a settings.toml file. If you already have a settings.toml file that you want to keep, be sure to skip that file and add the following line:
CIRCUITPY_PYSTACK_SIZE = 2400
This increases the depth of the CircuitPython Stack, which is necessary to run this large game.
Drive Structure
After copying the files, your drive should look like the listing below. It can contain other files as well, but must contain these at a minimum.
# SPDX-FileCopyrightText: 2025 Melissa LeBlanc-Williams
#
# SPDX-License-Identifier: MIT
import json
import time
import board
import supervisor
import audiobusio
from audio import Audio
import adafruit_pathlib as pathlib
import adafruit_fruitjam.Peripherals
from game import Game
from definitions import SECOND_LENGTH, TICKS_PER_SECOND
# Disable auto-reload to prevent the game from restarting
#import supervisor
#supervisor.runtime.autoreload = False
# Change this to use a different data file
DATA_FILE = "CHIPS.DAT"
SOUND_EFFECTS = {
"BUTTON_PUSHED": "sounds/pop2.wav",
"DOOR_OPENED": "sounds/door.wav",
"ITEM_COLLECTED": "sounds/blip2.wav",
"BOOTS_STOLEN": "sounds/strike.wav",
"WATER_SPLASH": "sounds/water2.wav",
"TELEPORT": "sounds/teleport.wav",
"CANT_MOVE": "sounds/oof3.wav",
"CHIP_LOSES": "sounds/bummer.wav",
"LEVEL_COMPLETE": "sounds/ditty1.wav",
"IC_COLLECTED": "sounds/click3.wav",
"BOMB_EXPLOSION": "sounds/hit3.wav",
"SOCKET_SOUND": "sounds/chimes.wav",
"TIME_LOW_TICK": "sounds/click1.wav",
"TIME_UP": "sounds/bell.wav"
}
# optional configuration file for speaker/headphone setting
launcher_config = {}
for directory in ("/", "/sd/", "/saves/"):
launcher_config_path = directory + "launcher.conf.json"
if pathlib.Path(launcher_config_path).exists():
with open(launcher_config_path, "r") as f:
launcher_config = launcher_config | json.load(f)
if "audio" not in launcher_config:
launcher_config["audio"] = {}
fjPeriphs = adafruit_fruitjam.Peripherals.Peripherals(
audio_output=launcher_config["audio"].get("output", "headphone"),
safe_volume_limit=launcher_config["audio"].get("volume_override_danger",.75),
sample_rate=44100,
bit_depth=16,
i2c=board.I2C()
)
if not hasattr(board, "I2S_BCLK") and \
hasattr(board, "D9") and hasattr(board, "D10") and hasattr(board, "D11"):
fjPeriphs.audio = audiobusio.I2SOut(board.D9, board.D10, board.D11)
# If volume was specified use it, otherwise use the fruitjam library default
if "volume" in launcher_config["audio"]:
fjPeriphs.volume = launcher_config["audio"]["volume"] # FruitJam vol 0.0-1.0
if fjPeriphs.audio is not None:
audio = Audio(fjPeriphs.audio, SOUND_EFFECTS)
else:
audio = None
adafruit_fruitjam.Peripherals.request_display_config(320, 240, 8)
game = Game(supervisor.runtime.display, DATA_FILE, audio)
tick_length = SECOND_LENGTH / 1000 / TICKS_PER_SECOND
while True:
start = time.monotonic()
game.tick()
while time.monotonic() - start < tick_length:
pass
Page last edited April 09, 2025
Text editor powered by tinymce.
