ggz-config(6)

💖 ggz-config — GGZ Gaming Zone configuration manager 💖

okay bestie, welcome to ggz-config(6), one of the GGZ Gaming Zone manual pages, and honestly? she's the mom friend of the whole client libraries package. she keeps everyone organized. she holds the group chat together. slay.

---

✨ SYNOPSIS ✨

Query Mode:

ggz-config [--configdir] [--gamedir] [--datadir] [--protocol]
[--version]

Install Mode:

ggz-config --install --modfile=FILENAME [--destdir] [--force]

Uninstall Mode:

ggz-config --remove --modfile=FILENAME

Repair Mode:

ggz-config --check

---

🌸 DESCRIPTION 🌸

so ggz-config is a central tool, and it's part of the client libraries package of the GGZ Gaming Zone. she does a few different jobs, and she does them well. 💅

her main character job is maintaining the ggz.modules configuration file — installing and removing game module info. that's the --install and --remove modes, no cap.

and secondarily, she can query the installation settings of the GGZ client libraries, which helps you out when you're configuring the build process of a client or a game module. very helpful. very supportive. we love her. 🫶

---

🎀 OPTIONS 🎀

Query Mode Options

• -c, --configdir — outputs the location of the GGZ client libraries configuration directory, then dips. this value is usually @ggzconfdir@, and it's where the file ggz.modules lives. 🗂️
• -g, --gamedir — outputs the location of the executable game modules, then exits. every game module in this directory is a game client that isn't installed into a standard PATH directory — mostly because they only run when a GGZ core client invokes them. and as a special lil module, the game client wrapper ggzwrap gets installed in here too. the gamedir is usually @ggzexecmoddir@. 👑
• -d, --datadir — outputs the location of the game module data directory, then exits. this is where games go looking for their graphics and level data. it'll likely resolve to @ggzdatadir@. 🎨
• -p, --protocol — queries GGZ_CS_PROTO_VERSION, aka the version of the core protocol between the GGZ server and any GGZ core clients. the vibe check, basically. 🔌
• -h, --help — outputs help information and exits. classic. 🆘
• -u, --usage — prints some ggz-config usage scenarios for quick reference. your cheat sheet fr fr. 📝
• -v, --version — outputs version information and exits. 💫

Install Mode Options

• --install — says "bestie, we are installing a game module description." that's the whole assignment. 📥
• --modfile=FILENAME — specifies the source module description file. FILENAME will often be named module.dsc, but honestly that's just a convention, not a rule. 🍓
• --force — overwrites an existing module entry with the same name, author and version instead of throwing an error back at you. dramatic? no. useful? yes. 💥
• -D, --destdir — specifies that the $DESTDIR environment variable contains a directory to prepend to the path for the GGZ module configuration file (ggz.modules). the only known purpose for this is creating binary packages of GGZ games. that's it. that's the job. 📦

Uninstall Mode Options

• --remove — says "bestie, we are removing a game module description." bye bye. 👋
• --modfile=FILENAME — specifies the source module description file. (yes, again. same flag, uninstall era.) 🗑️

---

🗃️ FILES 🗃️

• @ggzconfdir@/ggz.modules — the game module registry for all GGZ Gaming Zone core clients. the sacred text. the group chat archive. 📜

---

🌈 ENVIRONMENT VARIABLES 🌈

• DESTDIR — used during the install process, most commonly by the build sequence of binary packages such as rpm or dpkg. she's the backstage pass of the packaging world. 🎟️

---

💀 BUGS 💀

ngl, the program is currently unable to detect many problems that could arise with an invalid ggz.modules file. so like… be careful with that one. 🙈

and probably others, too, too numerous to mention. 😭

---

👑 AUTHORS 👑

The GGZ Development Team <ggz-dev@mail.ggzgamingzone.org> 💜

---

🦋 SEE ALSO 🦋

ggz.modules(5), ggz(7) — go read them too, iykyk. ✨

---

and that's the whole page bestie!! 🌸 this iconic little manual is version 0.0.14, brought to you with love by The GGZ Development Team, and it's filed under ggz-config(6) in the GGZ Gaming Zone section. stay configured, stay slaying, periodt. 💅🎀🫶