https://github.com/hacksore/tsl
Teamspeak lib - A Lua framework for making client plugins
https://github.com/hacksore/tsl
Last synced: about 1 year ago
JSON representation
Teamspeak lib - A Lua framework for making client plugins
- Host: GitHub
- URL: https://github.com/hacksore/tsl
- Owner: Hacksore
- License: mit
- Created: 2016-05-31T14:49:54.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-09-12T01:52:01.000Z (almost 9 years ago)
- Last Synced: 2024-10-06T00:42:37.449Z (almost 2 years ago)
- Language: Lua
- Homepage:
- Size: 43.9 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TSL
This is a Lua framework for creating rohbust Teamspeak3 plugins. It provies many additions that are not part of the native Lua plugin.
# Features
* Easy command management
* Persistant Config (JSON)
* Many useful utility methods
* Data cache for all users
# Usage
Here is an example of creating a command
```lua
command.add("test", function(self, fromID, args)
local clientData = Users:getData(self.sid, fromID)
print(clientData.username .. " has uniqueID = " .. clientData.uniqueID)
end)
```
Here is an example of creating a hook
```lua
hook.add("ClientLoaded", "setupVars", function(self)
print("Client has loaded!")
end)
```
# Installation
Download the source by cloning or using the zip. Place the TSL-master folder inside your Teamspeak 3 lua_plugin folder which you can locate at the following directory
x64
`C:\Program Files\TeamSpeak 3 Client\plugins\lua_plugin`
x32
`C:\Program Files (x86)\TeamSpeak 3 Client\plugins\lua_plugin`
# Todo
* Convert table lib to lowercase method names
* Move event logic to hooks
* Create a barebone/skeleton branch that has no additions
* Make the command.add callback include clientData
* Multi OS support