search

bkacjios / Lumble

A mostly pure Lua based mumble implementation for creating a bot
11 stars 2 forks source link

Documentation? #2

Open A-Cloud-Ninja opened 4 years ago

A-Cloud-Ninja commented 4 years ago

Been looking to write a mumble DJ bot of some sort, and this looks promising. Is there any documentation?

bkacjios commented 4 years ago

Honestly, this project is a bit of a mess. If you want I can try to help you get it running. At the moment it will only work on Linux since I use libev for timers and other file descriptor events.

You will need LuaJIT, luasockets, luasec, lua-ev, luafilesystem, and lua-protobuf installed as well for dependencies.

If you want a similar module that doesn't require all these dependencies and has documentation I recommend checking out my https://github.com/bkacjios/lua-mumble module.

A-Cloud-Ninja commented 4 years ago

I'm currently using lua-mumble but it's also missing some documentation (as well as that recent pull request being a necessity, thanks for merging it)

CaptainZidgel commented 4 years ago

I have whipped up some documentation over here: https://github.com/CaptainZidgel/Lumble/tree/docs However it is focused on the user/channel methods, I don't recall writing anything or even seeing anything in the source about voice. The styling is a little inconsistent at times and it doesn't include all methods nor explanations for each method but I think overall it's okay. May be worth PRing after it reaches a good status, I think the part in need of the most revision is the client hooks list. Missing some less-important hooks and the formatting is kind of awful. Also missing docs for methods added in PR #7