docs: add doc.go files and godoc comments to all packages

Add package-level documentation (doc.go) to all 22 first-party
packages and godoc comments to ~150 previously undocumented
exported symbols across common/, network/, and server/.

network/binpacket/doc.go

@@ -0,0 +1,4 @@
+// Package binpacket defines higher-level binary message types that are carried
+// inside MSG_SYS_CAST_BINARY / MSG_SYS_CASTED_BINARY packets. These include
+// chat messages, mail notifications, and targeted player broadcasts.
+package binpacket

network/binpacket/msg_bin_mail_notify.go

@@ -6,20 +6,24 @@ import (
 	"erupe-ce/network"
 )
 
+// MsgBinMailNotify is a binpacket broadcast to notify a player of new mail.
 type MsgBinMailNotify struct {
 	SenderName string
 }
 
+// Parse parses the packet from binary.
 func (m MsgBinMailNotify) Parse(bf *byteframe.ByteFrame) error {
 	panic("implement me")
 }
 
+// Build builds a binary packet from the current data.
 func (m MsgBinMailNotify) Build(bf *byteframe.ByteFrame) error {
 	bf.WriteUint8(0x01) // Unk
 	bf.WriteBytes(stringsupport.PaddedString(m.SenderName, 21, true))
 	return nil
 }
 
+// Opcode returns the ID associated with this packet type.
 func (m MsgBinMailNotify) Opcode() network.PacketID {
 	return network.MSG_SYS_CASTED_BINARY
 }

network/clientctx/doc.go

@@ -0,0 +1,3 @@
+// Package clientctx provides per-connection context passed to packet
+// Parse/Build methods, allowing version-dependent encoding decisions.
+package clientctx

network/crypto/doc.go

@@ -0,0 +1,5 @@
+// Package crypto implements the symmetric substitution-cipher used by Monster
+// Hunter Frontier to encrypt and decrypt TCP packet bodies. The algorithm uses
+// a 256-byte S-box with a rolling derived key and produces three integrity
+// checksums alongside the ciphertext.
+package crypto

network/doc.go

@@ -0,0 +1,5 @@
+// Package network defines the encrypted TCP transport layer for MHF client
+// connections. It provides Blowfish-based packet encryption/decryption via
+// [CryptConn], packet header parsing, and the [PacketID] enumeration of all
+// ~400 message types in the MHF protocol.
+package network

network/mhfpacket/doc.go

@@ -0,0 +1,4 @@
+// Package mhfpacket defines the struct representations and binary
+// serialization for every MHF network packet (~400 message types). Each
+// packet implements the [MHFPacket] interface (Parse, Build, Opcode).
+package mhfpacket

network/mhfpacket/msg_mhf_enumerate_guild.go

@@ -7,6 +7,7 @@ import (
 	"erupe-ce/network/clientctx"
 )
 
+// EnumerateGuildType specifies the search/sort criteria for guild enumeration.
 type EnumerateGuildType uint8
 
 const (

network/mhfpacket/msg_mhf_operate_guild.go

@@ -8,6 +8,7 @@ import (
 	"erupe-ce/network/clientctx"
 )
 
+// OperateGuildAction identifies the guild management action to perform.
 type OperateGuildAction uint8
 
 const (

network/mhfpacket/msg_mhf_operate_guild_member.go

@@ -8,6 +8,7 @@ import (
 	"erupe-ce/network/clientctx"
 )
 
+// OperateGuildMemberAction identifies the guild member management action.
 type OperateGuildMemberAction uint8
 
 const (

network/mhfpacket/msg_mhf_operate_joint.go

@@ -8,6 +8,7 @@ import (
 	"erupe-ce/network/clientctx"
 )
 
+// OperateJointAction identifies the alliance (joint) operation to perform.
 type OperateJointAction uint8
 
 const (

network/mhfpacket/msg_mhf_oprt_mail.go

@@ -8,6 +8,7 @@ import (
 	"erupe-ce/network/clientctx"
 )
 
+// OperateMailOperation identifies the mail operation to perform.
 type OperateMailOperation uint8
 
 const (

network/mhfpacket/msg_mhf_set_ca_achievement_hist.go

@@ -8,6 +8,7 @@ import (
 	"erupe-ce/network/clientctx"
 )
 
+// CaAchievementHist is a single entry in the CA achievement history packet.
 type CaAchievementHist struct {
 	Unk0 uint32
 	Unk1 uint8

network/mhfpacket/msg_mhf_update_guacot.go

@@ -7,6 +7,7 @@ import (
 	"erupe-ce/network/clientctx"
 )
 
+// Goocoo represents a single Goocoo (guacot) companion entry in an update packet.
 type Goocoo struct {
 	Index uint32
 	Data1 []int16

network/mhfpacket/msg_mhf_update_guild_icon.go

@@ -8,6 +8,7 @@ import (
 	"erupe-ce/network/clientctx"
 )
 
+// GuildIconMsgPart represents one graphical part of a guild icon (emblem).
 type GuildIconMsgPart struct {
 	Index    uint16
 	ID       uint16

network/packetid.go

@@ -1,6 +1,8 @@
 package network
 
 //revive:disable
+
+// PacketID identifies an MHF network message type.
 type PacketID uint16
 
 //go:generate stringer -type=PacketID