search

XboxUnity / AuroraScripts

Various LUA scripts for Aurora
33 stars 16 forks source link

Guide or better docs when? #17

Closed uptightsl closed 1 year ago

uptightsl commented 2 years ago

I've been trying to make a bad library for this for personal use, but I don't know much about actually making it work. I feel like a legit guide or something should be made!

Swizzy commented 2 years ago

Not sure a guide is needed tbh - there are plenty of guides explaining how LUA works and plenty of tutorials on how to write code.

Once you have those nailed, all you really should be needing is documentation explaining what functions are available and how they work.

uptightsl commented 2 years ago

well a list on what functions do would be great, as some functions are left in the dust. and a starter guide on how to made a script would be great, as i imagine some people start or try to start and dont get anywhere.

Swizzy commented 2 years ago

Ok, we can write a more detailed description of what each function does probably - but a starter guide i doubt we'll do as there are basic examples you can look at and need to understand LUA/general development to do stuff, which is beyond the scope of this imho.

uptightsl commented 1 year ago

I know it's a dead issue and whatnot but will better documentation ever be worked on? It would be nice to have more in-depth information on all the functions.

uptightsl commented 1 year ago

Also what version of Lua is used?

Swizzy commented 1 year ago

I know it's a dead issue and whatnot but will better documentation ever be worked on? It would be nice to have more in-depth information on all the functions.

Eventually, probably - but, most of us have alot of other things that we're doing, there are things in Aurora that's being worked on that has higher priority than improving this documentation. Feel free to add any documentation you think you can do, or get started on what you know etc.

Also what version of Lua is used?

It's LUA 5.3.3 with some additions added to it for the Aurora specific functionality (the functions described here)

uptightsl commented 1 year ago

I know it's a dead issue and whatnot but will better documentation ever be worked on? It would be nice to have more in-depth information on all the functions.

Eventually, probably - but, most of us have alot of other things that we're doing, there are things in Aurora that's being worked on that has higher priority than improving this documentation. Feel free to add any documentation you think you can do, or get started on what you know etc.

Also what version of Lua is used?

It's LUA 5.3.3 with some additions added to it for the Aurora specific functionality (the functions described here)

Understandable and will do. 👍

jrobiche commented 1 year ago

I began writing some personal documentation for the Lua libraries a while back and only work on it every so often. I have added what I have done so far to the luaLibraries branch of my xbox360-aurora-developer-documentation repository.

I don't think my repository could ever get merged into this repository though. The problem with my repository, aside from my documentation being far from complete, is that I am using it for more than just the Lua documentation. I plan on using it for general documentation relating to Aurora such as the Lua functions, Nova REST API, asset files, and so on. But my repository might become a useful reference once it is closer to being completed.