Versions in this module Expand all Collapse all v0 v0.3.0 Sep 27, 2026 Changes in this version + type APIError struct + Envelope *ErrorEnvelope + Method string + Path string + ResponseBody any + StatusCode int + func (e *APIError) Error() string + type AlertRequest struct + Message string + type AlertResponse struct + Success bool + type BanIPRequest struct + Reason string + UserId string + type BanIPResponse struct + IP string + Kicked int + Success bool + UserId string + type BanRequest struct + IP bool + Reason string + type BanResponse struct + BannedIP string + IP bool + Kicked int + Success bool + UserId string + type BanlistData struct + BannedMessage string + IPEntries []BanlistIPEntry + UserEntries []BanlistUserEntry + Version int + type BanlistIPEntry struct + Active bool + BannedBy BanlistIssuer + IP string + UnbannedBy *BanlistIssuer + type BanlistIssuer struct + IP string + NameValue string + Reason string + Timestamp BanlistTimestamp + Type string + type BanlistResponse struct + Banlist BanlistData + type BanlistTimestamp struct + Day int + Hour int + Min int + Month int + Msec int + Sec int + UTC int64 + Year int + type BanlistUserEntry struct + Active bool + BannedBy BanlistIssuer + UnbannedBy *BanlistIssuer + UserId string + type BroadcastRequest struct + Message string + Sender string + type BroadcastResponse struct + Success bool + type Client struct + func NewClient(baseURL, bearerToken string, opts ...Option) (*Client, error) + func (c *Client) Alert(ctx context.Context, message string) (*AlertResponse, error) + func (c *Client) Ban(ctx context.Context, playerIdentifier, reason string, ip bool) (*BanResponse, error) + func (c *Client) BanIP(ctx context.Context, ip string, request *BanIPRequest) (*BanIPResponse, error) + func (c *Client) Broadcast(ctx context.Context, message, sender string) (*BroadcastResponse, error) + func (c *Client) Close() error + func (c *Client) DeleteBase(ctx context.Context, baseCampIdentifier string) (*DeleteBaseResponse, error) + func (c *Client) ForgetTech(ctx context.Context, playerIdentifier string, technology ...TechnologyInput) (*ForgetTechResponse, error) + func (c *Client) GetBanlist(ctx context.Context, filters map[string]string) (*BanlistResponse, error) + func (c *Client) GetGuild(ctx context.Context, guildID string) (*GuildDetail, error) + func (c *Client) GetGuilds(ctx context.Context) (*GuildsResponse, error) + func (c *Client) GetItems(ctx context.Context, playerIdentifier string) (*PlayerItemsResponse, error) + func (c *Client) GetPals(ctx context.Context, playerIdentifier string) (*PlayerPalsResponse, error) + func (c *Client) GetPlayer(ctx context.Context, playerIdentifier string) (*PlayerInfo, error) + func (c *Client) GetPlayers(ctx context.Context) (*PlayersResponse, error) + func (c *Client) GetProgression(ctx context.Context, playerIdentifier string) (*PlayerProgressionResponse, error) + func (c *Client) GetTechs(ctx context.Context, playerIdentifier string) (*PlayerTechsResponse, error) + func (c *Client) GetVersion(ctx context.Context) (*VersionInfo, error) + func (c *Client) GiveItems(ctx context.Context, playerIdentifier string, items ...ItemInput) (*GrantResult, error) + func (c *Client) GivePalEggs(ctx context.Context, playerIdentifier string, palEggs ...PalEggInput) (*GrantResult, error) + func (c *Client) GivePalTemplates(ctx context.Context, playerIdentifier string, templates ...string) (*GrantResult, error) + func (c *Client) GivePals(ctx context.Context, playerIdentifier string, pals ...PalInput) (*GrantResult, error) + func (c *Client) GiveProgression(ctx context.Context, playerIdentifier string, request *GiveProgressionRequest, ...) (*GrantResult, error) + func (c *Client) GiveRecipeMaterials(ctx context.Context, playerIdentifier string, product any, quantity int) (*GrantResult, error) + func (c *Client) Kick(ctx context.Context, playerIdentifier, reason string) (*KickResponse, error) + func (c *Client) LearnTech(ctx context.Context, playerIdentifier string, technology ...TechnologyInput) (*LearnTechResponse, error) + func (c *Client) ReloadConfig(ctx context.Context) (*ReloadConfigResponse, error) + func (c *Client) SendPlayerMessage(ctx context.Context, request *SendPlayerMessageRequest) (*SendPlayerMessageResponse, error) + func (c *Client) SummonNPC(ctx context.Context, request *SummonNPCRequest) (*SummonNPCResponse, error) + func (c *Client) SummonPal(ctx context.Context, request *SummonPalRequest) (*SummonPalResponse, error) + func (c *Client) Unban(ctx context.Context, userID, reason string) (*UnbanResponse, error) + func (c *Client) UnbanIP(ctx context.Context, ip string, request *UnbanIPRequest) (*UnbanIPResponse, error) + type Coordinates struct + X float64 + Y float64 + Z float64 + type DeleteBaseCamp struct + ID string + Summary string + type DeleteBaseDeleted struct + BaseCampPals int + Buildings int + DefenseModels int + DropItems int + ItemCount int + ItemStacks int + OtherMapObjects int + PalBox bool + StorageContainers int + type DeleteBaseResponse struct + Archive string + BaseCamp DeleteBaseCamp + Deleted DeleteBaseDeleted + type ErrorDetail struct + Code string + Details any + Message string + type ErrorEnvelope struct + Error ErrorDetail + type ForgetTechResponse struct + Forgotten ForgottenTechs + ForgottenCount int + Skipped []string + type ForgottenTechs struct + All bool + IDs []string + func (f *ForgottenTechs) UnmarshalJSON(data []byte) error + type GiveItem struct + Count int + ItemID string + type GivePal struct + Level int + PalID string + type GivePalEgg struct + EggID string + Level int + PalID string + PalTemplate string + type GiveProgressionRequest struct + AncientTechnologyPoints int + EXP int + Relics map[string]int + TechnologyPoints int + type GrantResult struct + Granted GrantValues + Totals GrantTotals + type GrantTotals struct + AncientTechnologyPoints int + Relics map[string]int + TechnologyPoints int + type GrantValues struct + AncientTechnologyPoints int + EXP int + Items int + PalEggs int + PalTemplates int + Pals int + Relics map[string]int + TechnologyPoints int + type GuildAdmin struct + ID string + Name string + type GuildCampDetail struct + Buildings string + ID string + Level int + MapPos Coordinates + Pals map[string]GuildCampPal + State string + WorldPos Coordinates + type GuildCampPal struct + ActiveSkills []string + Friendship int + Gender string + Imported bool + LearntSkills []string + Level int + Nickname string + NpcID string + PalID string + Passives []string + PhysicalHealth string + San float64 + Shiny bool + SkinID string + WorkerSick string + type GuildCampSummary struct + ID string + MapPos Coordinates + WorldPos Coordinates + type GuildDetail struct + Admin GuildAdmin + CampCount int + Camps []GuildCampDetail + Expeditions GuildExpeditions + Items GuildStorage + Laboratory GuildLaboratory + Level int + MemberCount int + Members []GuildMember + Name string + type GuildExpeditions struct + Finished int + Missions map[string]bool + type GuildLaboratory struct + CurrentResearch string + Researches map[string]ResearchProgress + type GuildMember struct + PlayerName string + PlayerUID string + Status string + type GuildResponse struct + Guild GuildDetail + type GuildSlot struct + Count int + ItemID string + type GuildStorage struct + ContainerID string + Current int + Max int + Slots map[string]GuildSlot + func (g *GuildStorage) UnmarshalJSON(data []byte) error + type GuildSummary struct + Admin GuildAdmin + CampCount int + Camps []GuildCampSummary + Level int + MemberCount int + Members []string + Name string + type GuildsMeta struct + GuildCount int + type GuildsResponse struct + Guilds map[string]GuildSummary + Meta GuildsMeta + type InventorySection struct + Available bool + ContainerID string + FreeSlots int + MaxSlots int + Slots map[string]InventorySlot + UsedSlots int + type InventorySlot struct + Count int + ItemID string + type ItemInput any + type KickRequest struct + Reason string + type KickResponse struct + Success bool + UserId string + type LearnTechResponse struct + Skipped []string + Unlocked []string + UnlockedCount int + type Option func(*Client) + func WithDisplayAddress(displayAddress string) Option + func WithHTTPClient(httpClient *http.Client) Option + func WithOrigin(origin string) Option + func WithRecipeResolver(resolver RecipeResolver) Option + func WithTimeout(timeout time.Duration) Option + type PalEggInput any + type PalIVs struct + AttackMelee float64 + AttackShot float64 + Defense float64 + Health float64 + type PalInput any + type PalInstance struct + ActiveSkills []string + BaseCampSlotIndex int + CondensedPals int + CraftSpeed int + DisableWorkPreferences []string + Exp int + ExtraWorkSuitabilities map[string]int + FriendshipPoints int + Gender string + HP float64 + Hunger float64 + IVs PalIVs + ImportedCharacter bool + LearntSkills []string + Level int + MP float64 + MaxHunger float64 + Nickname string + Page int + PalID string + PalSouls PalSouls + PartnerSkillLevel int + Passives []string + PhysicalHealth string + SAN float64 + SP float64 + Shield float64 + Shiny bool + SkinId string + Slot int + Support int + TeamSlotIndex int + UniqueNPCID string + UnusedStatusPoints int + WorkerSick string + type PalSouls struct + Attack int + CraftSpeed int + Defense int + Health int + type PalsData struct + BaseCamps []PlayerBaseCamp + Palbox map[string]PalInstance + Team map[string]PalInstance + type PlayerBaseCamp struct + ID string + Level int + MapPos Coordinates + Pals map[string]PalInstance + State string + WorldPos Coordinates + type PlayerInfo struct + GuildName string + GuildUUID string + IP string + MapLocation Coordinates + Name string + PlayerUID string + Status string + UserId string + WorldLocation Coordinates + type PlayerInventory struct + Armor InventorySection + DropSlot InventorySection + Food InventorySection + Items InventorySection + KeyItems InventorySection + Weapons InventorySection + type PlayerItemsMeta struct + Player string + PlayerUID string + type PlayerItemsResponse struct + Inventory PlayerInventory + Meta PlayerItemsMeta + type PlayerPalsMeta struct + BaseCampCount int + PalboxCount int + Player string + PlayerUID string + TeamCount int + type PlayerPalsResponse struct + Meta PlayerPalsMeta + Pals PalsData + type PlayerProgressionData struct + Activities ProgressionActivities + Bosses ProgressionBosses + Captures ProgressionCaptures + Currencies ProgressionCurrencies + Player ProgressionPlayer + type PlayerProgressionMeta struct + Player string + PlayerUID string + type PlayerProgressionResponse struct + Meta PlayerProgressionMeta + Progression PlayerProgressionData + type PlayerResponse struct + Player PlayerInfo + type PlayerTechsData struct + Unlocked []string + type PlayerTechsMeta struct + LockedCount int + Player string + PlayerUID string + TotalCount int + UnlockedCount int + type PlayerTechsResponse struct + Meta PlayerTechsMeta + Techs PlayerTechsData + type PlayersMeta struct + OnlineCount int + PlayerCount int + type PlayersResponse struct + Meta PlayersMeta + Players []PlayerInfo + type ProgressionActivities struct + ArenaSoloClearCounts map[string]int + CampConqueredCount int + CraftItemCounts map[string]int + FirstFishingComplete bool + FishingCounts map[string]int + FixedDungeonClearCount int + FoundTreasureCount int + NPCTalkCounts map[string]int + NormalDungeonClearCount int + OilrigClearCount int + PalRankUpCounts map[string]int + type ProgressionBosses struct + NormalBossDefeatFlags map[string]bool + PredatorDefeatCount int + RaidBossDefeatCounts map[string]int + TotalBossDefeatCount int + TowerBossDefeatCounts map[string]int + type ProgressionCaptures struct + PalButcherCounts map[string]int + PalCaptureBonusCounts map[string]int + PalCaptureCounts map[string]int + TribeCaptureCount int + type ProgressionCurrencies struct + AncientTechnologyPoints int + Relics map[string]int + TechnologyPoints int + type ProgressionPlayer struct + Exp int + Level int + UnusedStatusPoints int + type RESTClient interface + Alert func(ctx context.Context, message string) (*AlertResponse, error) + Ban func(ctx context.Context, playerIdentifier, reason string, ip bool) (*BanResponse, error) + BanIP func(ctx context.Context, ip string, request *BanIPRequest) (*BanIPResponse, error) + Broadcast func(ctx context.Context, message, sender string) (*BroadcastResponse, error) + Close func() error + DeleteBase func(ctx context.Context, baseCampIdentifier string) (*DeleteBaseResponse, error) + ForgetTech func(ctx context.Context, playerIdentifier string, technology ...TechnologyInput) (*ForgetTechResponse, error) + GetBanlist func(ctx context.Context, filters map[string]string) (*BanlistResponse, error) + GetGuild func(ctx context.Context, guildID string) (*GuildDetail, error) + GetGuilds func(ctx context.Context) (*GuildsResponse, error) + GetItems func(ctx context.Context, playerIdentifier string) (*PlayerItemsResponse, error) + GetPals func(ctx context.Context, playerIdentifier string) (*PlayerPalsResponse, error) + GetPlayer func(ctx context.Context, playerIdentifier string) (*PlayerInfo, error) + GetPlayers func(ctx context.Context) (*PlayersResponse, error) + GetProgression func(ctx context.Context, playerIdentifier string) (*PlayerProgressionResponse, error) + GetTechs func(ctx context.Context, playerIdentifier string) (*PlayerTechsResponse, error) + GetVersion func(ctx context.Context) (*VersionInfo, error) + GiveItems func(ctx context.Context, playerIdentifier string, items ...ItemInput) (*GrantResult, error) + GivePalEggs func(ctx context.Context, playerIdentifier string, palEggs ...PalEggInput) (*GrantResult, error) + GivePalTemplates func(ctx context.Context, playerIdentifier string, templates ...string) (*GrantResult, error) + GivePals func(ctx context.Context, playerIdentifier string, pals ...PalInput) (*GrantResult, error) + GiveProgression func(ctx context.Context, playerIdentifier string, request *GiveProgressionRequest, ...) (*GrantResult, error) + GiveRecipeMaterials func(ctx context.Context, playerIdentifier string, product any, quantity int) (*GrantResult, error) + Kick func(ctx context.Context, playerIdentifier, reason string) (*KickResponse, error) + LearnTech func(ctx context.Context, playerIdentifier string, technology ...TechnologyInput) (*LearnTechResponse, error) + ReloadConfig func(ctx context.Context) (*ReloadConfigResponse, error) + SendPlayerMessage func(ctx context.Context, request *SendPlayerMessageRequest) (*SendPlayerMessageResponse, error) + SummonNPC func(ctx context.Context, request *SummonNPCRequest) (*SummonNPCResponse, error) + SummonPal func(ctx context.Context, request *SummonPalRequest) (*SummonPalResponse, error) + Unban func(ctx context.Context, userID, reason string) (*UnbanResponse, error) + UnbanIP func(ctx context.Context, ip string, request *UnbanIPRequest) (*UnbanIPResponse, error) + type RecipeResolver func(product string) (map[string]int, error) + type ReloadConfigResponse struct + Success bool + type ResearchProgress struct + Percentage float64 + RequiredWorkAmount float64 + WorkAmount float64 + type SendPlayerMessageRequest struct + Message string + SendType string + Sender string + UserID string + UserIDs []string + type SendPlayerMessageResponse struct + SentCount int + Success bool + type SummonNPCRequest struct + DisableAI bool + Level int + NPCID string + Uncapturable bool + X float64 + Y float64 + Z float64 + type SummonNPCResponse struct + Summoned SummonedNPC + type SummonPalRequest struct + DisableAI bool + DisableDamageMeter bool + DisableStatuses []string + Level int + PalID string + PalTemplate string + Uncapturable bool + X float64 + Y float64 + Z float64 + type SummonPalResponse struct + Summoned SummonedPal + type SummonedNPC struct + DisableAI bool + Level int + NPCID string + Type string + Uncapturable bool + X float64 + Y float64 + Z float64 + type SummonedPal struct + DamageMeter bool + DisableAI bool + Level int + PalID string + PalTemplate string + Type string + Uncapturable bool + X float64 + Y float64 + Z float64 + type TechnologyInput any + type UnbanIPRequest struct + Reason string + type UnbanIPResponse struct + IP string + Success bool + type UnbanRequest struct + Reason string + type UnbanResponse struct + Success bool + UserId string + type VersionInfo struct + Beta bool + Build int + Major int + Minor int + Patch int + Version string + VersionLong string + type VersionResponse struct + Version VersionInfo
Go to main page