What is OTClient?
- 🚀 Features
The Mobile Project- 🔨 Compiling
- 🐳 Docker
- 🩺 Need Help?
- 📑 Bugs
- ❤️ Roadmap
- 💯 Support Protocol
- ©️ License
- ❤️ Contributors
OTClient is an alternative Tibia client for usage with OTServ. It aims to be complete and flexible:
- LUA scripting for all game interface functionality
- CSS-like syntax for UI design
- Modular system: each functionality is a separate module, allowing easy customization
- Users can create new mods and extend the interface
- Written in C++20 and heavily scripted in LUA
For a server to connect to, you can build your own with theforgottenserver or canary.
Note
Based on edubart/otclient • Rev: 2.760
Beyond its flexibility with scripts, OTClient comes with many features that enable client-side innovation in OTServ: sound system, graphics effects with shaders, modules/addons, animated textures, styleable UI, transparency, multi-language, in-game LUA terminal, and an OpenGL 2.0 ES engine that allows porting to mobile platforms. It is also flexible enough to create Tibia tools like map editors using scripts—OTClient is a framework + Tibia APIs.
🖼️ Draw Render (optimization showcase)
460783937-d8a36c7e-b5ba-46ac-a881-a42f76a9eb01.mp4
📦 Asynchronous Texture Loading
-
Description: with this the spr file is not cached, consequently, less RAM is consumed.
-
Video:
Asynchronous.texture.loading.mp4
🧵 Multi-threading
Main Thread
- Sound
- Particles
- Load Textures (files)
- Windows Events (keyboard, mouse, ...)
- Draw texture
Thread 2
- Connection
- Events (g_dispatcher)
- Collect information on what will be drawn on the Map
Thread 3
- Collect information on what will be drawn in the UI
Image:
🧹 Garbage Collection
Description (1):
Garbage Collection is the feature responsible for automatically managing memory by identifying and releasing objects that are no longer in use. This allows the client to maintain efficient memory usage, avoid unnecessary data accumulation, and improve overall stability.
Description (2):
Garbage collector is used to check what is no longer being used and remove it from memory. (lua, texture, drawpool, thingtype)
🧭 Texture Atlas System
(coming with engine improvements and draw-call reduction)
- C++20 ( v17 , Unity build and Manifest Mode (vcpkg.json) ) build in x32 and x64
- Walking System Improvements
- Supports sequenced packages and compression
- Asserts load (Tibia 13)
🧩 UIWidgets Improvements
-
Description: Improvements in the UI algorithm; better performance in add/remove/reposition widgets. Visible in the battle module.
-
Video:
460149646-4eee68e4-7572-4232-b762-65f4d50219ee.mp4
🔁 Auto Reload Module
Activate: g_modules.enableAutoReload() (init.lua)
Video:
2022-11-17_17-45-35-1.1.mp4
✨ Attached Effects System (aura, wings…)
- Compatible with .APNG
- ThingCategoryEffect
- ThingCategoryCreature
- ThingExternalTexture: images in PNG | APNG
- Wiki: https://github.com/mehah/otclient/wiki/Tutorial-Attached-Effects
- Example Code: effects.lua • test code
- Specific lookType settings: outfit_618.lua
[!TIP] You can adjust offsets per looktype using ThingConfig when a default offset doesn’t align perfectly for a given sprite.
 |
 |
 |
| ThingCategory Attached Effect | Texture (PNG) Attached Effect | Particule |
🧭 Module Controller System
A safer way to create modules, without the need to unbind keys, disconnect events, or destroy widgets.
Example: (modules/game_minimap/minimap.lua)
🖼️ Anti-Aliasing Mode Options
- Note: Smooth Retro will consume a little more GPU.
GIF:
🧩 Creature Information by UIWidget
- Enable: setup.otml
- Style: modules/game_creatureinformation
- Note: There is a performance degradation vs direct Draw Pool, about ~20%, tested with 60 monsters attacking each other.
Video:
Video_Sem_Titulo_Feito_Com_O_Clipchamp1.mp4
🧱 Tile Widget
Wiki: https://github.com/mehah/otclient/wiki/Tutorial-Attached-Effects
 |
 |
 |
| Title Attached Effect | Title Widget | Title Particule |
🧩 Support HTML/CSS Syntax
htmlcss.mp4
OTClient_-_Redemption_LIVE_RELOAD_ENABLED_2025-09-20_17-08-56.mp4
Video_Sem_Titulo_Feito_Com_O_Clipchamp1.mp4
349623570-3fa1803a-2759-4b2f-890e-05f987f43260.mp4
Module examples:
🎥 Latency-adaptive camera
Basically the camera adapts to the server latency to always remain smooth and avoid stuttering while walking.
If the ping gets high, the camera moves slower to keep up with the server's response time; if the ping drops, the camera moves faster. (Depends on character speed.)
🧭 Support Negative Offset (.dat)
- Compatible with ObjectBuilderV0.5.5
- Enable:
g_game.enableFeature(GameNegativeOffset)
Video:
offsets.mp4
- Floor Shadowing
- Highlight Mouse Target (press Shift to select any object)
- Floor View Mode (Normal, Fade, Locked, Always, Always with transparency)
- Floating Effects Option
- Refactored Walk System
- Support for more mouse buttons (e.g., 4 and 5)
- Support DirectX
- Hud Scale
- Client 7.6 ~ 12.85 ~ 12.92, 13.00 ~ 15.22 support (protobuf)
- Market rewritten (compatible with TFS and Canary)
- Async Texture Loading (engine-level feature)
- Supports sequenced packages and compression
If you are interested in compiling this project, visit the Wiki.
| Protocol / version | Description | Required Feature | Compatibility |
|---|---|---|---|
| Gunzodus (15.11 ~ 15.22) | Gunz | ✅ |
OTClient is made available under the MIT License — you are free to use it for commercial, non-commercial, closed or open projects.
See: MIT License
If you are interested in supporting the project, donate here:
PayPal