tcod-go

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 10 Open GitHub ↗

A wrapper of the tcod library to the Go language

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# tcod-go

[![PkgGoDev](https://pkg.go.dev/badge/github.com/Joakker/tcod-go)](https://pkg.go.dev/github.com/Joakker/tcod-go)
[![Go Report Card](https://goreportcard.com/badge/github.com/Joakker/tcod-go)](https://goreportcard.com/report/github.com/Joakker/tcod-go)
[![Build Status](https://travis-ci.com/Joakker/tcod-go.svg?branch=main)](https://travis-ci.com/Joakker/tcod-go)
[![codecov](https://codecov.io/gh/Joakker/tcod-go/branch/main/graph/badge.svg?token=5UIST15TBZ)](https://codecov.io/gh/Joakker/tcod-go)

[![forthebadge](https://forthebadge.com/images/badges/gluten-free.svg)](https://forthebadge.com)

tcod-go is a wrapper of the libtcod library to the Go language.

## Installation

* You must have the [libtcod](https://www.github.com/libtcod/libtcod) library already
installed. This can be done by following the instructions in that repo.
* You must also have the [SDL2](https://www.libsdl.org/download-2.0.php) development
files installed. You can get them from your package manager or directly from the
website, but if you are compiling libtcod from source, you should already have them.
* Finally, you also need `pkg-config` to find the above packages.

Assuming you have the `go` executable in your `PATH` and you have
set up the `GOPATH` environment variable, simply run:

```sh
go get -v "github.com/Joakker/tcod-go"
```

and go should do everything else for you.

Unlike the C library, this binding provides a default font image, so you don't need
to provide your own.

## Minimal Program

Copy this into your text editor of choice and `go run` it

```go
package main

import (
    "log"

"github.com/Joakker/tcod-go"
    "github.com/Joakker/tcod-go/tinput"
)

func main() {
    root, err := tcod.InitRoot(80, 50, "The adventures of Go", false, tcod.RenderSDL2)

if err != nil {
        log.Fatal(err)
    }

i := tinput.NewInput()

for !tcod.WindowClosed() {
        i.Check()
        root.Clear()
            root.PrintFrame(0, 0, 80, 50, false, "The adventures of Go")
        tcod.Flush()
    }
}
```

You should get something more or less like this:

![example](https://raw.githubusercontent.com/Joakker/tcod-go/main/images/example.png)

In the future there should be a complete tutorial in this repo's wiki.

## Contributing

Pull requests are not only welcome but encouraged. I started working on this
project very recently, so there is still a lot to be done, and even more I may
be overlooking.

## License

See [here](LICENSE)

tcod-go

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README