Code Monkey home page Code Monkey logo

serenturhal / twapi Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jxsl13/twapi

0.0 0.0 0.0 245 KB

the twapi package is a framework to interact with Teeworlds servers and masterservers. It is slowly being developed to allow working with demos and maps as well as simulating a teeworlds client. Currently interacting with a server's external console(econ) and acting like the server browser(fetching server infos) is supported.

License: MIT License

Go 99.82% Makefile 0.18%

twapi's Introduction

Teeworlds API written in Go

Test Go Report GoDoc License: MIT codecov Total alerts codebeat badge Sourcegraph deepsource

Currently this supports only the server browser api. It is possible to retrieve data from the masterservers as well as the server information from the game servers.

In order to download the latest released version, execute:

go get github.com/jxsl13/twapi@latest

In order to download the latest development version, execute:

go get github.com/jxsl13/twapi@master

Stable packages

  • browser
  • compression
  • config
  • econ

Unstable packages

  • network
  • protocol

Example - High Level Abstraction(Open for optimizing suggestions)

package main

import (
    "fmt"
    "github.com/jxsl13/twapi/browser"
)

func main() {
    // fetch all server infos (that respond within 16 seconds)
    // if no servers responded, this list will be empty.
    infos := browser.ServerInfos()
    for _, info := range infos {
        fmt.Println(info)
    }

    // fetches the specified server's players, server name, etc.
    // if no answer is received within 16 seconds, this function returns
    // an error
    info, err := browser.GetServerInfo("89.163.148.121", 8305)
    if err != nil {
        fmt.Println(err)
    } else {
        fmt.Println(info)
    }
}

Example - Slightly Higher Level Abstraction - Retrieve Serverlist

package main

import (
    "fmt"
    "net"
    "time"

    "github.com/jxsl13/twapi/browser"
)

func main() {
    addr, err := net.ResolveUDPAddr("udp", "master1.teeworlds.com:8283")
    if err != nil {
        fmt.Println(err)
        return
    }

    conn, err := net.DialUDP("udp", nil, addr)

    if err != nil {
        fmt.Println(err)
        return
    }
    defer conn.Close()

    err = browser.RequestToken(conn)
    if err != nil {
        fmt.Println(err)
        return
    }

    conn.SetDeadline(time.Now().Add(5 * time.Second))

    buffer := [1500]byte{}
    bufSlice := buffer[:]

    read, err := conn.Read(bufSlice)
    if err != nil {
        fmt.Println(err)
        return
    }
    bufSlice = bufSlice[:read]
    fmt.Printf("read: %d bytes from %s\n", read, conn.RemoteAddr().String())

    // create toke from response
    token, err := browser.ParseToken(bufSlice)
    if err != nil {
        fmt.Println(err)
        return
    }
    // reset slice
    bufSlice = bufSlice[:1500]

    err = browser.Request("serverlist", token, conn)
    if err != nil {
        fmt.Println(err)
        return
    }

    // timeout after 5 secods
    // should not return an error
    conn.SetDeadline(time.Now().Add(5 * time.Second))

    // wait for response or time out
    read, err = conn.Read(bufSlice)
    bufSlice = bufSlice[:read]
    fmt.Printf("read: %d bytes from %s\n", read, conn.RemoteAddr().String())

    serverList, err := browser.ParseServerList(bufSlice)
    if err != nil {
        fmt.Println(err)
        return
    }

    for _, server := range serverList {
        fmt.Printf("Server: %s\n", server.String())
    }

}

Example - Low Level - Retrieve Serverlist

package main

import (
    "fmt"
    "net"
    "time"

    "github.com/jxsl13/twapi/browser"
)

func main() {
    addr, err := net.ResolveUDPAddr("udp", "master1.teeworlds.com:8283")
    if err != nil {
        fmt.Println(err)
        return
    }

    conn, err := net.DialUDP("udp", nil, addr)

    if err != nil {
        fmt.Println(err)
        return
    }
    defer conn.Close()

    // token request packet
    tokenReq := browser.NewTokenRequestPacket()

    // send request
    written, err := conn.Write(tokenReq)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Printf("written: %d bytes to %s\n", written, conn.RemoteAddr().String())

    conn.SetDeadline(time.Now().Add(5 * time.Second))

    buffer := [1500]byte{}
    bufSlice := buffer[:]

    read, err := conn.Read(bufSlice)
    if err != nil {
        fmt.Println(err)
        return
    }
    bufSlice = bufSlice[:read]
    fmt.Printf("read: %d bytes from %s\n", read, conn.RemoteAddr().String())

    // create toke from response
    token, err := browser.ParseToken(bufSlice)
    if err != nil {
        fmt.Println(err)
        return
    }
    // reset slice
    bufSlice = bufSlice[:1500]

    // create a new request from token
    serverListReq, err := browser.NewServerListRequestPacket(token)

    // Send server list request
    written, err = conn.Write(serverListReq)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Printf("written: %d bytes to %s\n", written, conn.RemoteAddr().String())

    // timeout after 5 secods
    // should not return an error
    conn.SetDeadline(time.Now().Add(5 * time.Second))

    // wait for response or time out
    read, err = conn.Read(bufSlice)
    bufSlice = bufSlice[:read]
    fmt.Printf("read: %d bytes from %s\n", read, conn.RemoteAddr().String())

    serverList, err := browser.ParseServerList(bufSlice)
    if err != nil {
        fmt.Println(err)
        return
    }

    for _, server := range serverList {
        fmt.Printf("Server: %s\n", server.String())
    }
}

twapi's People

Contributors

jxsl13 avatar deepsourcebot avatar dependabot[bot] avatar rejacobson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.