Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gorcon/telnet

TELNET Implementation for 7 Days to Die in Go.
https://github.com/gorcon/telnet

7-days-to-die 7daystodie 7dtd go golang telnet telnet-client

Last synced: 3 months ago
JSON representation

TELNET Implementation for 7 Days to Die in Go.

Awesome Lists containing this project

README

        

# Telnet
[![GitHub Build](https://github.com/gorcon/telnet/workflows/build/badge.svg)](https://github.com/gorcon/telnet/actions)
[![Coverage](https://gocover.io/_badge/github.com/gorcon/telnet?0 "coverage")](https://gocover.io/github.com/gorcon/telnet)
[![Go Report Card](https://goreportcard.com/badge/github.com/gorcon/telnet)](https://goreportcard.com/report/github.com/gorcon/telnet)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/github.com/gorcon/telnet)

7 Days to Die remote access to game [Command Console](https://7daystodie.gamepedia.com/Command_Console). This is not full [TELNET](https://en.wikipedia.org/wiki/Telnet) protocol implementation.

## Supported Games

* [7 Days to Die](https://store.steampowered.com/app/251570)

Open pull request if you have successfully used a package with another game with telnet support and add it to the list.

## Install

```text
go get github.com/gorcon/telnet
```

See [Changelog](CHANGELOG.md) for release details.

## Usage

### Execute single command

```go
package main

import (
"log"
"fmt"

"github.com/gorcon/telnet"
)

func main() {
conn, err := telnet.Dial("127.0.0.1:8081", "password")
if err != nil {
log.Fatal(err)
}
defer conn.Close()

response, err := conn.Execute("help")
if err != nil {
log.Fatal(err)
}

fmt.Println(response)
}
```

### Interactive CLI mode

```go
package main

import (
"log"
"os"

"github.com/gorcon/telnet"
)

func main() {
err := telnet.DialInteractive(os.Stdin, os.Stdout, "127.0.0.1:8081", "")
if err != nil {
log.Println(err)
}
}
```

## Requirements

Go 1.15 or higher

## Contribute

Contributions are more than welcome!

If you think that you have found a bug, create an issue and publish the minimum amount of code triggering the bug so
it can be reproduced.

If you want to fix the bug then you can create a pull request. If possible, write a test that will cover this bug.

## License

MIT License, see [LICENSE](LICENSE)