Unfinished mkdocs support

Author: sapphyrus

build/gitbook/development/README.md

@@ -1,4 +1,4 @@
-# development
+# Development
 
 To get started with lua scripting, you'll need a suitable text editor. We suggest [VS Code](https://code.visualstudio.com/) or [Sublime Text](https://www.sublimetext.com/), but in theory [Notepad++](https://notepad-plus-plus.org/download/) or even the built-in Microsoft Notepad will probably work just fine. After choosing an editor, head over to
 

build/gitbook/development/examples/auto_buy.md

@@ -1,4 +1,4 @@
-# Talk shit
+# Auto buy
 
 This script adds an "Auto buy AWP" checkbox to the misc tab, useful for spread HvH when AWP purchases are limited.
 

build/mkdocs/docs/README.md

@@ -0,0 +1,5 @@
+# Overview
+
+This website documents the configuration options, usage and LUA API of [gamesense.pub](https://gamesense.pub).
+
+The first category is targeted at end users that aren't interested in learning the gamesense LUA API. The other categories are meant for new and experienced developers and the majority of users shouldn't have to care about them.

build/mkdocs/docs/SUMMARY.md

@@ -0,0 +1,9 @@
+# development
+
+To get started with lua scripting, you'll need a suitable text editor. We suggest [VS Code](https://code.visualstudio.com/) or [Sublime Text](https://www.sublimetext.com/), but in theory [Notepad++](https://notepad-plus-plus.org/download/) or even the built-in Microsoft Notepad will probably work just fine. After choosing an editor, head over to
+
+If you're unfamiliar with the Lua programming language, [Lua in 5 minutes](https://learnxinyminutes.com/docs/lua/) is a great guide to get started.
+
+## Things to keep in mind:
+
+- By default, all loaded lua scripts share the same environment. This means that if 2 scripts use a global variable with the same name, they will conflict with each other and cause all kinds of issues. To prevent this, always remember to make your variables, functions, etc **local**

build/mkdocs/docs/development/README.md

@@ -0,0 +1,22 @@
+# Compiling lua scripts
+
+**Compiling scripts can give a slight performance boost, although you should be fine without it.**
+
+{% hint style="success" %}
+[**Download from MEGA**](https://mega.nz/#!JpFAhYjb!35AbAx8sGdmVAI3o-EVHtGA_-Y1WqReo7WWUWHOdYo4)
+{% endhint %}
+
+1. Download the archive and extract it anywhere
+2. Copy the script you want to compile into the extracted folder
+3. Open command prompt, navigate to that folder
+
+After you successfully extracted it, type the following command:
+
+{% code-tabs %}
+{% code-tabs-item title="compile.cmd" %}
+```text
+luajit.exe -b script.lua compiled.ljbc
+```
+{% endcode-tabs-item %}
+{% endcode-tabs %}
+

build/mkdocs/docs/development/compiling.md

@@ -0,0 +1,5 @@
+# Editors
+
+Your editor setup is very important to avoid common issues and be productive. The editors mentioned here are very extensible and can be improved a lot to make lua scripting more enjoyable, people have even made extensions for them just for the gamesense API.
+
+This section shows how to best configure your editor for writing scripts for gamesense lua scripting

build/mkdocs/docs/development/editors/README.md

@@ -0,0 +1,16 @@
+# GameSense API Snippets
+*Credits to Nexxed*
+
+1. Open Atom and go to "File" -> "Snippets..." to open the snippets.cson file.
+2. [Download](https://gamesense.pub/forums/viewtopic.php?id=12394) and/or paste the contents of the Atom snippets into the snippets.cson file.
+3. Save the file and restart Atom for the changes to take effect.
+
+Note: This requires you to install the [language-lua](https://atom.io/packages/language-lua) package for the editor.
+
+These snippets have descriptions (VSCode & Atom only) for most API functions as well as arguments and are currently up-to-date with the current API.
+
+Thread: https://gamesense.pub/forums/viewtopic.php?id=12394
+
+# Suggested extensions
+
+- [language-lua](https://atom.io/packages/language-lua)

build/mkdocs/docs/development/editors/atom.md

@@ -0,0 +1,16 @@
+# GameSense API Snippets
+*Credits to Nexxed*
+
+1. Open Sublime and go to "Preferences" -> "Browse Packages" while in the editor.
+2. [Download](https://gamesense.pub/forums/viewtopic.php?id=12394), rename and drag the gamesense.sublime-completions file into the packages folder.
+3. Profit!
+
+These snippets have descriptions (VSCode & Atom only) for most API functions as well as arguments and are currently up-to-date with the current API.
+
+Thread: https://gamesense.pub/forums/viewtopic.php?id=12394
+
+# Suggested extensions
+
+- [LuaExtended](https://packagecontrol.io/packages/LuaExtended)
+- [SublimeLinter](https://packagecontrol.io/packages/SublimeLinter)
+- [SublimeLinter-luacheck](https://packagecontrol.io/packages/SublimeLinter-luacheck)

build/mkdocs/docs/development/editors/sublime.md

@@ -0,0 +1,16 @@
+# GameSense API Snippets
+*Credits to Nexxed*
+
+1. Go to the [VSCode Marketplace page of the GameSense Lua API Snippets](https://marketplace.visualstudio.com/items?itemName=Nexxed.gamesense-lua) and click the green install button.
+2. Follow the instructions.
+3. Profit!
+
+These snippets have descriptions (VSCode & Atom only) for most API functions as well as arguments and are currently up-to-date with the current API.
+
+Thread: https://gamesense.pub/forums/viewtopic.php?id=12394
+
+# Suggested extensions
+
+- [LuaExtended](https://packagecontrol.io/packages/LuaExtended)
+- [SublimeLinter](https://packagecontrol.io/packages/SublimeLinter)
+- [SublimeLinter-luacheck](https://packagecontrol.io/packages/SublimeLinter-luacheck)

build/mkdocs/docs/development/editors/vscode.md

@@ -0,0 +1,222 @@
+---
+description: List of events that you can listen to using client.set_event_callback
+---
+# Events
+
+### List of events:
+
+#### paint
+
+Fired every time the game renders a frame while being connected to a server. Can be used to draw to the screen using the renderer.* functions
+
+
+{% page-ref page="/developers/globals/renderer" %}
+
+
+#### run_command
+
+Fired every time the game runs a command (usually 64 times a second, equal to tickrate) while you're alive. This is the best event for processing data that only changes when the game receives an update from the server, like information about other players.
+
+Key | Description
+--- | -----------
+ **chokedcommands** | Amount of commands that the client has choked
+ **command_number** | Current command number
+
+
+
+#### setup_command
+
+Fired every time the game prepares a move command that's sent to the server. This is ran before cheat features like antiaim and can be used to modify user input (view angles, pressed keys, movement) how it's seen by the cheat. For example, setting `in_use = 1` will disable antiaim the same way pressing use key ingame does. This is the preferred method of setting user input and should be used instead of `client.exec` whenever possible
+
+Key | Description
+--- | -----------
+ **chokedcommands** | Amount of commands that the client has choked
+ **command_number** | Current command number
+ **pitch** | Pitch view angle
+ **yaw** | Yaw view angle
+ **forwardmove** | Forward / backward speed (-450 to 450)
+ **sidemove** | Left / right speed (-450 to 450)
+ **move_yaw** | Yaw angle that's used for movement. If not set, view yaw is used
+ **allow_send_packet** | Set to false to make the cheat choke the current command (when possible)
+ **in_attack** | IN_ATTACK Button
+ **in_jump** | IN_JUMP Button
+ **in_duck** | IN_DUCK Button
+ **in_forward** | IN_FORWARD Button
+ **in_back** | IN_BACK Button
+ **in_use** | IN_USE Button
+ **in_cancel** | IN_CANCEL Button
+ **in_left** | IN_LEFT Button
+ **in_right** | IN_RIGHT Button
+ **in_moveleft** | IN_MOVELEFT Button
+ **in_moveright** | IN_MOVERIGHT Button
+ **in_attack2** | IN_ATTACK2 Button
+ **in_run** | IN_RUN Button
+ **in_reload** | IN_RELOAD Button
+ **in_alt1** | IN_ALT1 Button
+ **in_alt2** | IN_ALT2 Button
+ **in_score** | IN_SCORE Button
+ **in_speed** | IN_SPEED Button
+ **in_walk** | IN_WALK Button
+ **in_zoom** | IN_ZOOM Button
+ **in_weapon1** | IN_WEAPON1 Button
+ **in_weapon2** | IN_WEAPON2 Button
+ **in_bullrush** | IN_BULLRUSH Button
+ **in_grenade1** | IN_GRENADE1 Button
+ **in_grenade2** | IN_GRENADE2 Button
+ **in_attack3** | IN_ATTACK3 Button
+ **weaponselect** | 
+ **weaponsubtype** | 
+
+
+
+#### console_input
+
+Fired every time the user types something in the game console and presses enter. Return false from the event handler to make the game not process the input
+
+|| Property
+------ | --------
+ 1 | console input text
+
+
+**Examples:**
+
+{% code-tabs %}
+{% code-tabs-item %}
+```lua
+client.set_event_callback("console_input", function(text)
+	client.log("entered: '", text, "'")
+end)
+```
+{% endcode-tabs-item %}
+{% endcode-tabs %}
+
+#### net_update_start
+
+Fired before the game processes entity updates from the server. (`FrameStageNotify FRAME_NET_UPDATE_START`) Be careful when using this event to modify entity data, some things have to be restored manually as not even a full update will update them
+
+
+
+#### net_update_end
+
+Fired after an entity update packet is received from the server. (`FrameStageNotify FRAME_NET_UPDATE_END`)
+
+
+
+#### predict_command
+
+Fired when the game prediction is ran
+
+Key | Description
+--- | -----------
+ **command_number** | Command number of the predicted command
+
+
+
+#### aim_fire
+
+Fired when the rage aimbot shoots at a player
+
+Key | Description
+--- | -----------
+ **id** | Shot ID, this can be used to find the corresponding aim_hit / aim_miss event
+ **target** | Target player entindex
+ **hit_chance** | Chance the shot will hit, depends on spread
+ **hitgroup** | Targeted hit group, this is not the same thing as a hitbox
+ **damage** | Predicted damage the shot will do
+ **backtrack** | Amount of ticks the player was backtracked
+ **boosted** | True if accuracy boost was used to increase the accuracy of the shot
+ **high_priority** | True if the shot was at a high priority record, like on shot backtrack
+ **interpolated** | Player was interpolated
+ **extrapolated** | Player was extrapolated
+ **teleported** | Target player was teleporting (breaking lag compensation)
+ **tick** | Tick the shot was fired at. This can be used to draw the hitboxes using client.draw_hitboxes
+ **x** | X world coordinate of the aim point
+ **y** | X world coordinate of the aim point
+ **z** | Z world coordinate of the aim point
+
+
+**Examples:**
+
+{% code-tabs %}
+{% code-tabs-item %}
+```lua
+local function time_to_ticks(t)
+	return floor(0.5 + (t / globals.tickinterval()))
+end
+
+local hitgroup_names = {'generic', 'head', 'chest', 'stomach', 'left arm', 'right arm', 'left leg', 'right leg', 'neck', '?', 'gear'}
+
+local function aim_fire(e)
+	local flags = {
+		e.teleported and 'T' or '',
+		e.interpolated and 'I' or '',
+		e.extrapolated and 'E' or '',
+		e.boosted and 'B' or '',
+		e.high_priority and 'H' or ''
+	}
+	local group = hitgroup_names[e.hitgroup + 1] or '?'
+	print(string.format('Fired at %s (%s) for %d dmg (chance=%d%%, bt=%2d, flags=%s)', entity.get_player_name(e.target), group, e.damage, math.floor(e.hit_chance + 0.5), time_to_ticks(e.backtrack), table.concat(flags)))
+end
+client.set_event_callback('aim_fire', aim_fire)
+```
+{% endcode-tabs-item %}
+{% endcode-tabs %}
+
+#### aim_hit
+
+Fired when the rage aimbot hit a shot at a player
+
+Key | Description
+--- | -----------
+ **id** | Shot ID, the corresponding aim_fire event has the same ID
+ **target** | Target player entindex
+ **hit_chance** | Actual hit chance the shot had
+ **hitgroup** | Hit group that was hit. This is not the same thing as a hitbox
+ **damage** | Actual damage the shot did
+
+
+**Examples:**
+
+{% code-tabs %}
+{% code-tabs-item %}
+```lua
+local hitgroup_names = {'generic', 'head', 'chest', 'stomach', 'left arm', 'right arm', 'left leg', 'right leg', 'neck', '?', 'gear'}
+
+local function aim_hit(e)
+	local group = hitgroup_names[e.hitgroup + 1] or '?'
+	print(string.format('Hit %s in the %s for %d damage (%d health remaining)', entity.get_player_name(e.target), group, e.damage, entity.get_prop(e.target, 'm_iHealth')))
+end
+client.set_event_callback('aim_hit', aim_hit)
+```
+{% endcode-tabs-item %}
+{% endcode-tabs %}
+
+#### aim_miss
+
+Fired when the rage aimbot missed a shot at a player
+
+Key | Description
+--- | -----------
+ **id** | Shot ID, the corresponding aim_fire event has the same ID
+ **target** | Target player entindex
+ **hit_chance** | Actual hit chance the shot had
+ **hitgroup** | Hit group that was missed. This is not the same thing as a hitbox
+ **reason** | Reason the shot was missed. This can be 'spread', 'prediction error', 'death' or '?' (unknown / resolver)
+
+
+**Examples:**
+
+{% code-tabs %}
+{% code-tabs-item %}
+```lua
+local hitgroup_names = {'generic', 'head', 'chest', 'stomach', 'left arm', 'right arm', 'left leg', 'right leg', 'neck', '?', 'gear'}
+
+local function aim_miss(e)
+	local group = hitgroup_names[e.hitgroup + 1] or '?'
+	print(string.format('Missed %s (%s) due to %s', entity.get_player_name(e.target), group, e.reason))
+end
+client.set_event_callback('aim_miss', aim_miss)
+```
+{% endcode-tabs-item %}
+{% endcode-tabs %}
+

build/mkdocs/docs/development/events.md

@@ -0,0 +1,3 @@
+# Examples
+
+These example show how to use certain parts of the gamesense API and highlight best practices.

build/mkdocs/docs/development/examples/README.md

@@ -0,0 +1,18 @@
+# Talk shit
+
+This script adds an "Auto buy AWP" checkbox to the misc tab, useful for spread HvH when AWP purchases are limited.
+
+```lua
+local ui_get, console_cmd = ui.get, client.exec
+
+local auto_buy_awp = ui.new_checkbox("MISC", "Miscellaneous", "Auto buy AWP")
+
+local function on_round_prestart(e)
+	if ui_get(auto_buy_awp) then
+		console_cmd("buy awp;")
+	end
+end
+client.set_event_callback("round_prestart", on_round_prestart)
+```
+
+Originally written by admin

build/mkdocs/docs/development/examples/auto_buy.md

@@ -0,0 +1,44 @@
+# Create interface
+
+This script is an example for "client.create_interface".
+With this function you can access classes or functions provided by the game itself.
+
+{% code-tabs %}
+{% code-tabs-item title="create_interface.lua" %}
+```lua
+local ffi = require 'ffi'
+
+ffi.cdef[[
+    typedef unsigned char wchar_t;
+
+    typedef bool (__thiscall *IsButtonDown_t)(void*, int);
+]]
+local interface_ptr = ffi.typeof('void***')
+
+local raw_inputsystem = client.create_interface('inputsystem.dll', 'InputSystemVersion001')
+
+-- cast the lightuserdata to a type that we can dereference
+local inputsystem = ffi.cast(interface_ptr, raw_inputsystem) -- void***
+
+-- dereference the interface pointer to get its vtable
+local inputsystem_vtbl = inputsystem[0] -- void**
+
+-- vtable is an array of functions, the 15th is IsButtonDown
+local raw_IsButtonDown = inputsystem_vtbl[15] -- void*
+
+-- cast the function pointer to a callable type
+local is_button_pressed = ffi.cast('IsButtonDown_t', raw_IsButtonDown)
+
+local function run_command(cmd)
+    if is_button_pressed(inputsystem, 36) then -- ButtonCode_t for Z
+        print('Z is pressed')
+    end
+    return false
+end
+
+client.set_event_callback('run_command', run_command)
+```
+{% endcode-tabs-item %}
+{% endcode-tabs %}
+
+Originally written by admin