Guild-Server

command module
v0.0.0-...-1ee08a6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 30, 2025 License: GPL-3.0 Imports: 10 Imported by: 0

README

Guild Server

REST api for tracking skyblock player data.

which skyblock data is getting tracked?

  • Dungeons
    • Class xp
    • Catacombs xp
    • Floor completions - splint in master mode and non master mode
    • Secrets count
  • Diana
    • Mythological Creatures kills
    • Borrows - splint in treasure and combat burrows

End points

There is 2 types of end points, public and non public

Public
GET /api/users

This returns all users in the system

Response

Name Type
id string
active_profile_UUID string
FetchData bool
GET /api/user
Name Type
id string
Name Type
user User
diana_data DianaData
dungeons_data DungeonsData
GET /api/guildevent

This takes a guild event id as a parameter and returns a specific information about that event.

Name Type
id string

Response:

Name Type
event_id string
start_time string (ISO 8601 Date-Time)
duration int
type string("dungeons" or "diana")
users_ids []string
event_data GuildEventData
GET /api/guildevents

This returns a list of the table:

Name Type
id string
Users []string
start_time string (ISO 8601 Date-Time)
duration int
type string("dungeons" or "diana")
is_hidden bool
This returns all guild events in the system
Non Public
POST /api/users

Property:

Name Type Required
uuid string true

Response:

Name Type
message string
user id string
POST /api/guildevent

Property:

Name Type Required
users []string true
duration int true
type string("dungeons" or "diana") true
start_time string (ISO 8601 Date-Time) false
is_hidden bool false

Response:

Name Type
message string
guild id string

TODO

  • Fix bugs
  • Add hidden guild events
  • Add trackers
    • dungeons chest tracker
      • Track rare drops from dungeons chests
    • nw tracker
      • maybe getting NW using soopy api
    • Farming tracker
      • Visitor
      • Farming collection
      • Farming xp
      • Pest?
      • Contest Medals?
    • Mining tracker
      • Mining xp
      • Powder
      • Collection
      • Worm Be
      • Nucleus
    • Slayer tracker
      • Slayer xp
      • Boss kills
    • Xp Tracker
    • Be tracker

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
src
app

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL