README
¶
go-tibia: Tibia tools in Go
Just a toy project to see how far Go's built in crypto primitives can take me, with some experimentation on how decent the Go interface abstractions, and how useful Go's WASM support is.
Copyright © 2017-2024 Ivan Vucica. See the LICENSE for licensing information.
gotserv: OTServ in Go
Main binary: badc0de.net/pkg/go-tibia/cmd/gotserv
So far implemented: stub login protocol, stub gameworld protocol which presents a map, some moving code. Other players can be seen, but updates from them won't propagate yet.
A debug webserver can be enabled, which reuses some of the gotweb code to paint a live representation of a portion of the map upon request.
gotweb
Main binary: badc0de.net/pkg/go-tibia/cmd/gotweb
Displays an index of items and creatures. Serves pic file's and spr file's individual components. Serves the requested sub-portion of the loaded map, composited with lighting.
Serves gotwebfe via a service worker, ensuring service worker is served with up-to-date cache keys so new files get fetched as needed.
gotwebfe
Main binary: badc0de.net/pkg/go-tibia/cmd/gotwebfe
Code intended to be compiled into WASM and run in-browser. Loads spr, pic, dat, items.xml and otbm files, and can render the map using the compositor.
Portion of the implementation is in HTML and CSS files in datafiles/html.
It's currently a PWA: it'll cache spr, pic, dat etc offline.
itemprint
Main binary: badc0de.net/pkg/go-tibia/cmd/itemprint
Draws pic, spr and even items as composited using spr+dat files into terminal. It can use various methods: kitty's image drawing, iTerm2's png image drawing, true-color colored characters, 256-color colored characters, dumb 'intensity' ascii 'art'. The images get shrunk as needed.
wikiloader
Main binary: badc0de.net/pkg/go-tibia/cmd/wikiloader
Demonstration tool showing how the wiki dump data can be loaded. Interesting because it looks like item IDs are valid 8.54 client IDs, so a server or a web UI could load the data from the dump (or, more specifically, a subset of it) to enrich OpenTibia information further. Similarly, NPC, creature and outfit data could be enriched.
Libraries
There's:
- a spr reader
- a dat reader
- an otb reader
- an items.otb reader built on top of the otb reader
- an .otbm reader built on top of the otb reader
- a base network constructs library
- a login server
- a gameworld server
- a compositor for the map, a toy compositor painting a map into an
image.Image, including lighting- a browser DOM compositor for the map, a toy compositor assembling a map out of DOM objects using
syscall/js(i.e. for WASM environment); the actual approach (a single<img>, or many<img>representing tiles, or many<img>s representing items on tiles) is an implementation
- a browser DOM compositor for the map, a toy compositor assembling a map out of DOM objects using
- an abstract representation of 'things' such as items, creatures, etc, as an abstraction of items from items.otb, or .dat dataset, or otherwise
- includes a toy, experimental compositor for items and creatures into
image.Image - also can load "all" files from "default paths"
- includes a toy, experimental compositor for items and creatures into
- an .xml loader, currently loading only OpenTibia's outfits.xml
- a secret constants package, currently containing only OpenTibia encryption "secret" constants
- a web handlers collection, used to share some URL path handlers between
gotwebfeandgotserv
Some helpers:
- path handler dealing with finding the files in the filesystem and setting up flags as needed
- image printer used in
itemprintbinary and in some tests
Documentation
¶
Overview ¶
Package tibia contains no code.
Refer to its subpackages for useful documentation and code.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gotserv
gotserv is a binary setting up and serving a login and a gameworld server on ports 7171 and 7172.
|
gotserv is a binary setting up and serving a login and a gameworld server on ports 7171 and 7172. |
|
wikiloader
Binary wikiloader reads an XML-formatted dump of tibiawiki, obtainable from its `Special:Statistics` page.
|
Binary wikiloader reads an XML-formatted dump of tibiawiki, obtainable from its `Special:Statistics` page. |
|
Package compositor paints a part of the map into an image.Image using the provided map data source and a things pack.
|
Package compositor paints a part of the map into an image.Image using the provided map data source and a things pack. |
|
Package dat implements a parser for Tibia dataset files (Tibia.dat), describing items, creatures, etc.
|
Package dat implements a parser for Tibia dataset files (Tibia.dat), describing items, creatures, etc. |
|
Package gameworld provides a gameworld protocol server.
|
Package gameworld provides a gameworld protocol server. |
|
Package imageprint prints images on terminal.
|
Package imageprint prints images on terminal. |
|
Package login provides a login protocol server.
|
Package login provides a login protocol server. |
|
Package net implements network communication primitives for the login and gameworld protocol.
|
Package net implements network communication primitives for the login and gameworld protocol. |
|
Package otb reads in the 'OpenTibia Binary' format.
|
Package otb reads in the 'OpenTibia Binary' format. |
|
items
Package itemsotb reads in an items.otb file.
|
Package itemsotb reads in an items.otb file. |
|
map
Package otbm implements an OTBM map file format reader and a gameworld map data source.
|
Package otbm implements an OTBM map file format reader and a gameworld map data source. |
|
Package secrets provides RSA secrets for the game, currently just OpenTibia server secret.
|
Package secrets provides RSA secrets for the game, currently just OpenTibia server secret. |
|
Package spr implements a reader for individual sprites in a Tibia.spr files.
|
Package spr implements a reader for individual sprites in a Tibia.spr files. |
|
Package things implements a registry for items, creatures etc.
|
Package things implements a registry for items, creatures etc. |
|
full
Package full is unstable; it serves as a helper to populate things.Things hackily.
|
Package full is unstable; it serves as a helper to populate things.Things hackily. |
|
Package xmls is unstable.
|
Package xmls is unstable. |