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.
|
2012-07-06 01:37:32 +02:00
|
|
|
Otclient is written in C++2011, the upcoming C++ standard and heavily scripted in lua.
|
2012-04-27 11:15:49 +02:00
|
|
|
|
2012-07-05 22:03:41 +02: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,
|
|
|
|
|
sound system, graphics effects with shaders, particle engines, modules/addons system, animated textures,
|
2012-04-27 18:23:51 +02:00
|
|
|
styleable user interface, transparency, multi language, in game lua terminal, an OpenGL 1.1/2.0 ES engine that make possible to
|
2012-07-10 19:36:18 +02:00
|
|
|
run on mobile platforms like Android/iPhone/iPad and much more. 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
|
|
|
|
2012-07-05 22:03:41 +02:00
|
|
|
### Download
|
2012-04-27 10:41:15 +02:00
|
|
|
|
|
|
|
|
Daily snapshots of otclient master branch compiled for Windows and protocol 860 is available
|
2012-07-09 17:26:03 +02:00
|
|
|
in the [downloads section](https://github.com/edubart/otclient/downloads) of the project's github page.
|
2012-04-27 10:41:15 +02:00
|
|
|
For any other platform or protocol you will need to compile the source code. Currently Linux/Windows
|
2012-07-09 17:26:03 +02:00
|
|
|
platforms and protocols 8.6x are supported.
|
2012-04-27 10:41:15 +02:00
|
|
|
|
2012-07-05 22:03:41 +02: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-07-09 17:26:03 +02:00
|
|
|
* [Compiling on Windows](http://otclient.info/tutorials/compiling_on_windows.html)
|
|
|
|
|
* [Compiling on Linux](http://otclient.info/tutorials/compiling_on_linux.html)
|
2011-11-14 16:01:09 +01:00
|
|
|
|
2012-07-05 22:03:41 +02:00
|
|
|
### Need help?
|
2011-11-16 00:47:32 +01:00
|
|
|
|
2012-07-05 22:03:41 +02:00
|
|
|
Checkout our website at <http://otclient.info> for tutorials and more information.
|
2011-11-16 00:47:32 +01:00
|
|
|
If you have any questions or are looking for more information, please feel free to ask on our official
|
2012-07-09 17:26:03 +02:00
|
|
|
forum at <http://forum.otclient.info> or talk with us at #otclient irc.freenode.net
|
2011-11-16 00:47:32 +01:00
|
|
|
|
2012-07-05 22:03:41 +02: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
|
|
|
|
2012-07-05 22:03:41 +02:00
|
|
|
### Contributing
|
2011-11-14 16:01:09 +01:00
|
|
|
|
2012-07-09 17:26:03 +02:00
|
|
|
We encourage you to contribute to otclient! Please check out
|
2012-07-05 22:03:41 +02:00
|
|
|
[our website](http://otclient.info/) for guidelines about how to proceed. Join us!
|
2011-11-14 16:01:09 +01:00
|
|
|
|
2012-04-27 10:41:15 +02:00
|
|
|
We are currently needing help in the following areas:
|
|
|
|
|
* Designing new UI themes or improving the current one
|
|
|
|
|
* Translating the client to other languages
|
2012-07-09 17:26:03 +02:00
|
|
|
* Documenting and creating tutorials
|
|
|
|
|
* Scripting new modules or improving the current ones
|
2012-04-27 11:15:49 +02:00
|
|
|
* Porting otclient to other otserv protocols (8.54, 8.7, 9.x, etc)
|
2012-04-27 10:41:15 +02:00
|
|
|
* Spreading otclient project over the web and bring it to new possible contributors
|
2012-04-27 11:15:49 +02:00
|
|
|
* Testing the client itself to report bugs and missing features in our bug tracker
|
2012-04-27 10:41:15 +02:00
|
|
|
|
2012-07-05 22:03:41 +02:00
|
|
|
### Contact
|
2012-03-16 14:28:29 +01:00
|
|
|
|
2012-07-09 17:26:03 +02:00
|
|
|
You have 3 options, use the [forum](http://forum.otclient.info/), talk directly with us at #otclient irc.freenode.net
|
2012-07-05 22:03:41 +02:00
|
|
|
or send an email directly to the project leader edub4rt@gmail.com
|
2012-03-16 14:28:29 +01:00
|
|
|
|
2012-07-05 22:03:41 +02:00
|
|
|
### 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.
|
|
|
|
|
|
|
|
|
|
|
2012-07-05 22:03:41 +02:00
|
|
|
### Donate
|
2011-11-15 21:07:00 +01:00
|
|
|
|
2012-07-09 17:26:03 +02:00
|
|
|
Otclient needs your support, if you really like and use it, please donate. Anyone can donate
|
2012-04-27 18:23:51 +02:00
|
|
|
by clicking the Donate button in otclient website. We might prioritize features
|
2012-04-27 10:41:15 +02:00
|
|
|
requests from who donate, in this case you can send an email to the project leader.
|
