phaneron/Kelsidavis-WoWee
1
0
Fork 0
mirror of https://github.com/Kelsidavis/WoWee.git synced 2026-05-11 11:33:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

feat(pipeline): WGCH global chat channel catalog (124th open format)

Browse source 
Novel replacement for vanilla ChatChannels.dbc + the per-server
zone-default chat-join behavior. Each WGCH entry binds one chat
channel to its access policy: PublicJoin, InviteOnly,
AutoJoinOnZone (with zoneDefaultMapId), or Moderated. Entries
also carry channelKind (Global/RealmZone/Faction/Custom),
passwordRequired, levelMin, maxMembers cap, topic-mod-only flag,
and an icon RGBA color.

Three presets:
  --gen-gch        4 standard server channels (LookingForGroup,
                   World, Trade auto-join Stormwind, General)
  --gen-gch-rp     4 RP channels (RP_OOC public, RP_IC moderated
                   200-cap, RP_Forum invite-only 50-cap, RP_Events
                   password-protected)
  --gen-gch-admin  3 moderator-only channels (GMTraffic, AuditLog,
                   Backstage — all password-gated)

Validator catches: id+name required, channelKind/accessKind
range, duplicate channelIds, duplicate channel names (which
would route /join ambiguously), AutoJoinOnZone with
zoneDefaultMapId=0 (auto-join trigger would never fire). Warns
on dead zoneDefaultMapId set with non-AutoJoin kind.

Format count 123 -> 124. CLI flag count 1290 -> 1317.
This commit is contained in:
Kelsi 2026-05-10 03:23:39 -07:00
parent cef571bb45
commit c7d85fc598
10 changed files with 734 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

133
include/pipeline/wowee_global_channels.hpp Normal file
View file

@ -0,0 +1,133 @@
#pragma once
#include <cstdint>
#include <string>
#include <vector>
namespace wowee {
namespace pipeline {
// Wowee Open Global Chat Channel catalog (.wgch) —
// novel replacement for the implicit chat-channel
// configuration vanilla WoW carried in
// ChatChannels.dbc + the per-server zone-default chat
// joins. Each entry binds one server-wide or
// zone-scoped chat channel (LookingForGroup, World,
// Trade, GeneralChat, RP-OOC) to its access policy
// (public-join / invite-only / auto-join on zone
// entry / moderated), level gate, member cap, and
// password requirement.
//
// Cross-references with previously-added formats:
// WCHN: WGCH supersedes WCHN's narrower chat-channel
// catalog where access-policy semantics matter.
// WMS: zoneDefaultMapId references the WMS map
// catalog (for AutoJoin channels that auto-
// enroll players entering a specific zone).
//
// Binary layout (little-endian):
// magic[4] = "WGCH"
// version (uint32) = current 1
// nameLen + name (catalog label)
// entryCount (uint32)
// entries (each):
// channelId (uint32)
// nameLen + name (channel display name)
// descLen + description
// channelKind (uint8) — Global / RealmZone /
// Faction / Custom
// accessKind (uint8) — PublicJoin /
// InviteOnly /
// AutoJoinOnZone /
// Moderated
// passwordRequired (uint8) — 0/1 bool
// levelMin (uint8)
// maxMembers (uint16) — 0 = unlimited
// topicSetByMods (uint8) — 0/1 bool — false
// means anyone can /topic
// pad0 (uint8)
// zoneDefaultMapId (uint32) — for AutoJoinOnZone
// kind; 0 if not auto-
// joined per-zone
// iconColorRGBA (uint32)
struct WoweeGlobalChannels {
enum ChannelKind : uint8_t {
Global = 0, // server-wide
RealmZone = 1, // realm-wide zone-default
Faction = 2, // single-faction
Custom = 3, // player-created
};
enum AccessKind : uint8_t {
PublicJoin = 0, // /join chan
InviteOnly = 1, // requires owner invite
AutoJoinOnZone = 2, // auto-enroll on
// zoneDefaultMapId entry
Moderated = 3, // joinable but only mods
// can speak
};
struct Entry {
uint32_t channelId = 0;
std::string name;
std::string description;
uint8_t channelKind = Global;
uint8_t accessKind = PublicJoin;
uint8_t passwordRequired = 0;
uint8_t levelMin = 0;
uint16_t maxMembers = 0;
uint8_t topicSetByMods = 1;
uint8_t pad0 = 0;
uint32_t zoneDefaultMapId = 0;
uint32_t iconColorRGBA = 0xFFFFFFFFu;
};
std::string name;
std::vector<Entry> entries;
bool isValid() const { return !entries.empty(); }
const Entry* findById(uint32_t channelId) const;
// Returns all channels of one kind. Used by the
// chat-window UI to populate per-kind tabs (Global
// tab, Custom tab, etc.).
std::vector<const Entry*> findByKind(uint8_t channelKind) const;
// Returns AutoJoinOnZone channels that should
// enroll a player entering the given mapId. Used
// by the zone-load handler.
std::vector<const Entry*> findAutoJoinForZone(uint32_t mapId) const;
};
class WoweeGlobalChannelsLoader {
public:
static bool save(const WoweeGlobalChannels& cat,
const std::string& basePath);
static WoweeGlobalChannels load(const std::string& basePath);
static bool exists(const std::string& basePath);
// Preset emitters used by --gen-gch* variants.
//
// makeStandardChannels — 4 vanilla server-wide
// channels (LookingFor-
// Group / World / Trade
// on auto-join Stormwind /
// General).
// makeRoleplay — 4 RP server channels
// (RP-OOC / RP-IC moderated
// / RP-Forum invite-only /
// RP-Events).
// makeAdminChannels — 3 moderator-only channels
// (GMTraffic invite /
// AuditLog moderated /
// Backstage invite — all
// level 0 require GM flag
// via accessKind).
static WoweeGlobalChannels makeStandardChannels(const std::string& catalogName);
static WoweeGlobalChannels makeRoleplay(const std::string& catalogName);
static WoweeGlobalChannels makeAdminChannels(const std::string& catalogName);
};
} // namespace pipeline
} // namespace wowee