GBSPLAYRC(5)

📦
version 0.0.102 · 6 versions
, in ubuntu resolute, ubuntu stonking

💖 GBSPLAYRC(5) — the gameboy sound player config file, bestie edition 💖

okay so this is the manual for gbsplayrc(5), aka the config file for the Gameboy sound player. Yeah. That one. The one you keep opening and closing without reading. Sit down, bestie, we're doing this together. 🎀

🌸 NAME 🌸

gbsplayrc — the Gameboy sound player configuration file. That's it. That's the name. Gorgeous. Iconic. No notes.

✨ DESCRIPTION ✨

This manpage is here to describe the configuration file format of gbsplay(1). So if you've ever stared at a gbsplayrc wondering "what is any of this", welcome, you're in the right place, and also same. 🫶

📝 SYNTAX 📝

A configuration file is a text file. That's it! A humble little text file. And inside it, you can put options for gbsplay(1), plus comments because you deserve to leave yourself little notes.

  • Comments start with a hash mark (#) and they just keep going until the end of the line. No take-backs, no closing tag, the whole rest of the line is vibes and commentary. 💅
  • Whitespace is ignored. Including empty lines. Blank lines are free, bestie, use them liberally, aesthetic spacing is a love language.
  • To set an option: write the option name, then an equal sign (=), then the value. Like:
option_name = value

That's the whole ritual. No semicolons, no braces, no drama. Periodt. 👑

🔍 Option value types 🔍

So options don't all want the same kind of value, right? Here's the menu of what a value can be:

Boolean

An integer number in decimal. 0 means false. Literally anything else means true. That's the whole rule. Zero is a hater, everything else is a yes. ✅

Endian

A string that picks your endianness:

  • native — native endian. Your machine's own vibe. 🏠
  • little — little endian.
  • big — big endian.
For backwards compatibility you can also use just the first character of each option: n, l, or b. Short and sweet, she's efficient. 💅

Filter type

A string that picks your output high-pass filter:

  • dmg — Gameboy Classic. The OG. The blueprint. 🎮
  • cgb — Gameboy Color. She's got range. 🌈
  • off — no filter. Raw. Unfiltered. Unbothered.

Integer

An integer number in decimal. That's it. A number. In decimal. We're not doing hex today, bestie. 🔢

Loop mode

A string that picks your loop mode:

  • none — no looping. One and done.
  • range — loop over selected subsongs.
  • single — loop a single subsong. Just the one. Main character behavior.
Peep the LOOP MODES section in gbsplay(1) for the deets. 👀

Play mode

A string that picks your play mode:

  • linear — play subsongs in linear order. Orderly. Predictable. Respectable.
  • random — play subsongs in random order, where every subsong can be played multiple times. Chaos. Repeated chaos. 🎲
  • shuffle — play subsongs in random order, where every subsong is played only once. Chaos, but make it fair. 🎲✨

Plugin

The name of an output plugin. And because we're helpful girlies: run gbsplay -o list to get a list of all available output plugins. Go look. We'll wait. 🦋

🔥 OPTIONS 🔥

Here's the good part. Every single one. No skips, no skimming, we're thorough in this house.

  • endian = Endian — Sets the output endianness. Which way do the bytes go? This decides. 🧭
  • fadeout = Integer — Sets the fadeout time, in seconds. Instead of cutting the subsong off hard (brutal, honestly, rude), you get a soft fadeout. Gentle. Considerate. Slay. 🌅
  • filter_type = Filter type — Sets the output high-pass filter. Pick your flavor from the Filter type list above. 🎛️
  • loop = Boolean — When enabled, sets the loop mode to "range". When disabled, sets it to "none". Deprecated in favor of the loop_mode option, so ngl, she's a legacy queen — still valid, but loop_mode is the moment. ⚠️
  • loop_mode = Loop mode — Sets the desired loop mode. The new girl. The one you should actually be using. 💅
  • output_plugin = Plugin — Sets the sound output plugin. Where does the sound go? Here's your answer. 🔊
  • play_mode = Play mode — Sets the desired play mode. Linear, random, or shuffle. Choose your adventure. 🎧
  • rate = Integer — Sets the samplerate in Hz. Numbers. Audio numbers. Beautiful. 📈
  • refresh_delay = Integer — Sets the refresh delay in milliseconds. Larger values will lower CPU usage, but heads up: things like subsong changes, fadeouts, reactions to keypresses, and the on-screen display will be delayed. So it's a trade-off, bestie. Cheap on the CPU, slow on the vibes. 😭
  • silence_timeout = Integer — Sets the silence timeout in seconds. When a subsong contains silence for the given time, the player will skip to the next subsong. Silence detected, moving on. 🤫
  • subsong_gap = Integer — Sets the subsong gap in seconds. Before playing the next subsong after the subsong timeout, subsong_gap seconds of silence will be played. A little breather. A pause for the cause. 🌬️
  • subsong_timeout = Integer — Sets the subsong timeout in seconds. When a subsong has been played for the given time, the player will skip to the next subsong. And plot twist: a timeout of 0 seconds disables automatic subsong changes. Zero means never, periodt. 🛑
  • verbosity = Integer — Sets the verbosity level (default: 3). A value of 0 means no messages on stdout. Silence. Total silence. If you want a quiet terminal, you know what to do. 🤐

📂 FILES 📂

  • /etc/gbsplayrc — Default location of the global configuration file. The one that belongs to everyone. 🏛️
  • ~/.gbsplayrc — The user configuration file. Yours. Personal. Customized. This is your moment. 🫶

💀 BUGS 💀

If you encounter bugs — and bestie, sometimes you will — please report them via https://github.com/mmitch/gbsplay/issues. Do not suffer in silence. Do not gaslight yourself into thinking it's a feature. Go tell the devs. They want to know. 📣

🌟 EXAMPLE 🌟

A simple configuration file might look like this:

# select NAS output plugin and play subsongs for at most 5 minutes
output_plugin = nas
subsong_timeout = 300

Look at her. Two lines, one comment, and she's doing the absolute most. Setting the output_plugin to nas and capping subsongs at subsong_timeout = 300 seconds (that's 5 minutes, iykyk). Iconic. Simple. Effective. 🌈

👑 AUTHORS 👑

gbsplay was written by Tobias Diedrich <ranma+gbsplay@tdiedrich.de> — with contributions from others, see README.md. Shoutout to everyone who touched this codebase, fr fr. 🙌

gbsplay is licensed under GNU GPL v1 or, at your option, any later version. Read the license, love the license, respect the license. 📜

🦋 SEE ALSO 🦋

Go read those too, bestie. They're the whole ecosystem. 🌸

and that's the page!! you made it to the end, so proud of you 💖 this was the gbsplayrc(5) manpage from the gbsplay project, version 0.0.102, written by Tobias Diedrich, dated back in the day — go forth and configure your Gameboy sound player like the main character you are 🎀✨💅

📦 where this page comes from