Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Python1320 committed Apr 15, 2015
1 parent 6c1ce84 commit 0389e57
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# LuaDev
A simple library to help developers run lua code in-game.

###### Usage ######
- ```lua_send_sh``` <filename.lua>
- Run on server and all clients.
- ```lua_send_clients``` <filename.lua>
- Run on a single client
- ```lua_send_cl``` <client> <filename.lua>
- Run on a single client
- ```lua_send_sv``` <filename.lua>
- Run on server
- ```lua_send_self``` <filename.lua>
- lua_openscript_cl through luadev
- ```lua_run_client``` ```<part of name/steamid/userid> <code>```
- ```lua_run_clients``` <code>
- ```lua_run_sh``` <code>
- ```lua_run_sv``` <code>
- ```lua_run_self``` <code>

Extra commands exist (lua_send_ent for direct entity code ending), unfinished.

###### Lua functions ######

(Desc is the string to identify errors)

- ```luadev.RunOnServer``` (code,desc,extra)
- ```luadev.RunOnShared``` (code,desc,extra)
- ```luadev.Run``` (code,desc,extra)
- ```luadev.RunOnClients``` (code,desc,extra)
- ```luadev.RunOnClient``` (player,code,desc,extra)

Parameter ```extra``` is subject to change. It can essentially hold extra information to transfer with the code.

###### Notes ######
- There is no player autocomplete yet
- Embeds your steamid on errors. Does not prevent changing it though.
- Only checks if you are superadmin. Be careful who you let to use this. There is a hook for luadev access check for override.
- No GUI, use gcompute for example

###### Cvars ######
- ```luadev_verbose``` 0-9
- Console debug printing

###### Credits ######
- CapsAdmin
- Noiwex
- Python1320
- PotcFdk
- Morten
- Garry
- Meta Construct


###### Extras ######
- Sublime support
- https://github.com/Noiwex/Sublime-LuaDev
- GMod error console
- https://github.com/Metastruct/EPOE
- Easylua for code augmentation (outdated)
- https://github.com/CapsAdmin/fast_addons/blob/master/lua/helpers/easylua.lua

0 comments on commit 0389e57

Please sign in to comment.