tibia-client/README.md

70 lines
3.5 KiB
Markdown
Raw Normal View History

2017-11-04 15:33:51 +01:00
[![Build Status](https://secure.travis-ci.org/edubart/otclient.svg?branch=master)](http://travis-ci.org/edubart/otclient) [![Join the chat at https://gitter.im/edubart/otclient](https://img.shields.io/badge/GITTER-join%20chat-green.svg)](https://gitter.im/edubart/otclient?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\
2012-07-09 17:26:03 +02:00
### What is otclient?
2011-11-15 21:07:00 +01:00
2012-07-06 01:37:32 +02:00
Otclient is an alternative Tibia client for usage with otserv. It aims to be complete and flexible,
2011-11-16 06:54:45 +01:00
for that it uses LUA scripting for all game interface functionality and configurations files with a syntax
2012-07-06 01:37:32 +02:00
similar to CSS for the client interface design. Otclient works with a modular system, this means
2011-11-15 21:07:00 +01:00
that each functionality is a separated module, giving the possibility to users modify and customize
anything easily. Users can also create new mods and extend game interface for their own purposes.
2017-11-04 15:33:51 +01:00
Otclient is written in C++11 and heavily scripted in lua.
For a server to connect to, you can build your own with the [forgottenserver](https://github.com/otland/forgottenserver)
or connect to one listed on [otservlist](https://otservlist.org/).
2012-04-27 11:15:49 +02:00
2013-11-13 18:17:38 +01:00
### Where do I download?
2017-11-04 15:33:51 +01:00
Compiled for Windows can be found here (but can be outdated):
2014-07-30 16:43:46 +02:00
* [Windows Builds](http://otland.net/threads/otclient-builds-windows.217977/)
**NOTE:** You will need to download spr/dat files on your own and place them in `data/things/VERSION/` (i.e: `data/things/1098/Tibia.spr`)
2013-11-13 18:17:38 +01:00
### Features
2012-04-27 11:15:49 +02:00
Beyond of it's flexibility with scripts, otclient comes with tons of other features that make possible
2012-04-27 11:59:32 +02:00
the creation of new client side stuff in otserv that was not possible before. These include,
2012-09-04 05:52:35 +02:00
sound system, graphics effects with shaders, modules/addons system, animated textures,
styleable user interface, transparency, multi language, in game lua terminal, an OpenGL 1.1/2.0 ES engine that make possible
2012-09-04 05:52:35 +02:00
to port to mobile platforms. Otclient is also flexible enough to
2012-04-27 11:59:32 +02:00
create tibia tools like map editors just using scripts, because it wasn't designed to be just a
client, instead otclient was designed to be a combination of a framework and tibia APIs.
2011-11-15 21:07:00 +01:00
### Compiling
2011-11-14 16:01:09 +01:00
2011-11-15 21:07:00 +01:00
In short, if you need to compile OTClient, follow these tutorials:
2012-09-04 05:52:35 +02:00
* [Compiling on Windows](https://github.com/edubart/otclient/wiki/Compiling-on-Windows)
* [Compiling on Linux](https://github.com/edubart/otclient/wiki/Compiling-on-Linux)
2014-12-25 15:10:03 +01:00
* [Compiling on OS X](https://github.com/edubart/otclient/wiki/Compiling-on-Mac-OS-X)
2011-11-14 16:01:09 +01:00
2018-03-21 05:54:10 +01:00
### Build and run with Docker
To build and run the client without copile by hand:
```
./build.sh
./run.sh
```
The build step should be run just when something on implementation changes.
2013-12-04 17:00:09 +01:00
### Need help?
2011-11-16 00:47:32 +01:00
2012-10-05 01:33:10 +02:00
Try to ask questions in [otland](http://otland.net/f494/), now we have a board for the project there,
2017-11-04 15:33:51 +01:00
or talk with us at the gitter chat.
2011-11-16 00:47:32 +01:00
### Bugs
2011-11-15 21:07:00 +01:00
2012-07-09 17:26:03 +02:00
Have found a bug? Please create an issue in our [bug tracker](https://github.com/edubart/otclient/issues)
2011-11-15 21:07:00 +01:00
### Contributing
2011-11-14 16:01:09 +01:00
2012-09-27 10:09:13 +02:00
We encourage you to contribute to otclient! You can make pull requests of any improvement in our github page, alternatively, see [Contributing Wiki Page](https://github.com/edubart/otclient/wiki/Contributing).
2012-04-27 10:41:15 +02:00
### Contact
2017-11-04 15:33:51 +01:00
Talk directly with us at the gitter chat [![Join the chat at https://gitter.im/edubart/otclient](https://img.shields.io/badge/GITTER-join%20chat-green.svg)](https://gitter.im/edubart/otclient?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge).
### License
2011-11-15 21:07:00 +01:00
2012-07-09 17:26:03 +02:00
Otclient is made available under the MIT License, thus this means that you are free
2012-04-27 10:41:15 +02:00
to do whatever you want, commercial, non-commercial, closed or open.