GITBOOK-90: change request with no subject merged in GitBook

Author: Force67

SUMMARY.md

@@ -47,6 +47,7 @@
       * [First time launch](guides/client-setup/using-vortex-mod-manager-vmm/playing-skyrim-together-reborn/first-time-launch.md)
       * [Connecting to a server](guides/client-setup/using-vortex-mod-manager-vmm/playing-skyrim-together-reborn/connecting-to-a-server.md)
 * [Server setup](guides/server-guide/README.md)
+  * [Page 1](guides/server-guide/page-1.md)
   * [ReadMe first](guides/server-guide/readme-first.md)
   * [Terminology](guides/server-guide/terminology.md)
   * [Overview](guides/server-guide/overview.md)
@@ -98,6 +99,11 @@
   * [The STRUI doesn't appear when I press RIGHT CTRL or F2](guides/troubleshooting/the-strui-doesnt-appear-when-i-press-right-ctrl-or-f2.md)
   * [The server list is not appearing](guides/troubleshooting/the-server-list-is-not-appearing.md)
   * [My game opens to a black screen for 2-10 seconds and then closes](guides/troubleshooting/black-screen-and-then-close.md)
+* [Scripting](guides/scripting/README.md)
+  * [Core Math functions](guides/scripting/core-math-functions.md)
+  * [Player functions](guides/scripting/player-functions.md)
+  * [GameServer](guides/scripting/gameserver.md)
+  * [Components](guides/scripting/components.md)
 
 ## General information
 

guides/scripting/README.md

@@ -0,0 +1,18 @@
+# Scripting
+
+The ST server provides a set of scripting functions that you can use to customize and extend its functionality. To get started with scripting, create a subfolder in the server's "/resources/" directory with the name of your resource. Within that folder, create a "something.manifest" file that includes the following components:
+
+```
+[Resource]
+name = "Example Resource"
+version = 1.0.0
+apiset = 1.0.0
+description = "Official skyrim together example resource"
+keywords = ["example", "resource"]
+license = "MIT"
+repository = ""
+homepage = "https://skyrim-together.com/"
+entrypoint = "main.lua"
+```
+
+Once you have created the manifest file, you can place your script file in the same folder. It's important to note that the main script file must have the same name as the "entrypoint" property in the script manifest. With these files in place, your script will be loaded by the ST server and its functionality will be available for use.

guides/scripting/components.md

@@ -0,0 +1,26 @@
+# Components
+
+The Server achitecture uses components, since it is based on an ECS (Entity Component System) architecture.
+
+In simple terms, imagine a video game world with many characters, items, and environmental objects. Each of these objects can have different attributes and behaviors, such as appearance, movement, health, and interactions with other objects. In a traditional programming approach, managing all these objects and their interactions can become complex and difficult.
+
+Now, lets focus on components: Components are the attributes or properties of an entity. For example, a character entity may have components like position, health, and inventory. Components are designed to be small and reusable, which means they can be easily combined and shared between different entities.
+
+Currently only the movementcomponent is exposed:
+
+To get the `MovementComponent` instance for an entity, use the following Lua code:
+
+```lua
+local entity = ... -- Replace this with the target entity
+local movementComponent = GetMovementComponent(entity)
+```
+
+**Interact with the MovementComponent** After obtaining the movement component, you can access its properties using the dot (.) notation. For example:
+
+```lua
+local position = movementComponent.Position
+local rotation = movementComponent.Rotation
+local direction = movementComponent.Direction
+local sent = movementComponent.Sent
+```
+

guides/scripting/core-math-functions.md

@@ -0,0 +1,121 @@
+# Core Math functions
+
+### Table of Contents
+
+1. Creating Vectors and Matrices
+2. Accessing Vector Components
+3. Vector and Matrix Operations
+4. Binding Core Math Functions
+
+### Creating Vectors and Matrices
+
+#### Creating `vec2` objects
+
+```lua
+local v1 = vec2()
+local v2 = vec2(1.0)
+local v3 = vec2(1.0, 2.0)
+```
+
+#### Creating `vec3` objects
+
+```lua
+local v1 = glm.vec3()
+local v2 = glm.vec3(1.0)
+local v3 = glm.vec3(1.0, 2.0, 3.0)
+```
+
+#### Creating `vec4` objects
+
+```lua
+local v1 = glm.vec4()
+local v2 = glm.vec4(1.0)
+local v3 = glm.vec4(1.0, 2.0, 3.0, 4.0)
+```
+
+#### Creating `mat3` objects
+
+```lua
+local m1 = glm.mat3()
+local m2 = glm.mat3(1.0)
+local m3 = glm.mat3(glm.mat4())
+local m4 = glm.mat3(1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0)
+```
+
+### Accessing Vector Components
+
+#### Accessing `vec2` components
+
+```lua
+local x = vec2.x
+local y = vec2.y
+```
+
+#### Accessing `vec3` components
+
+```lua
+local x = vec3.x
+local y = vec3.y
+local z = vec3.z
+```
+
+#### Accessing `vec4` components
+
+```lua
+local x = vec4.x
+local y = vec4.y
+local z = vec4.z
+local w = vec4.w
+```
+
+### Vector and Matrix Operations
+
+#### Addition
+
+```lua
+local result = vecA + vecB
+local result = vecA + scalar
+local result = scalar + vecA
+```
+
+#### Subtraction
+
+```lua
+local result = vecA - vecB
+local result = vecA - scalar
+local result = scalar - vecA
+```
+
+#### Multiplication
+
+```lua
+local result = vecA * vecB
+local result = vecA * scalar
+local result = scalar * vecA
+local result = matA * vecA
+```
+
+#### Division
+
+```lua
+local result = vecA / vecB
+local result = vecA / scalar
+local result = scalar / vecA
+```
+
+#### Constants
+
+```lua
+local pi = glm.pi
+local half_pi = glm.half_pi
+local quarter_pi = glm.quarter_pi
+local two_pi = glm.two_pi
+```
+
+#### Functions
+
+```lua
+local sqrt_result = glm.sqrt(x)
+local pow_result = glm.pow(x, y)
+local exp_result = glm.exp(x
+```

guides/scripting/gameserver.md

@@ -0,0 +1,26 @@
+# GameServer
+
+GameServer is a singleton instance. To fetch use, use the following lua:
+
+```lua
+local gameServer = GameServer:get()
+```
+
+**Interact with the GameServer** After obtaining the game server instance, you can call methods from the `GameServer` class using the dot (.) notation. For example:
+
+```lua
+gameServer:Kill(playerId)
+gameServer:Kick(playerId)
+local serverTick = gameServer:GetTick()
+```
+
+**Send a chat message** To send a chat message from the server to a specific player, use the `SendChatMessage` method:
+
+```lua
+local connectionId = 1 -- Replace this with the target player's connection ID
+local message = "Hello from the server!"
+gameServer:SendChatMessage(connectionId, message)
+```
+
+Note that the message will be automatically sanitized to remove any HTML tags.
+

guides/scripting/player-functions.md

@@ -0,0 +1,48 @@
+# Player functions
+
+
+
+**Access Player properties and methods** After fetching a player instance, you can access its properties and methods using the dot (.) notation. For example, to get the player's username, use:
+
+```lua
+local username = newPlayer:GetUsername()
+```
+
+Similarly, you can call other methods available in the `Player` class, such as:
+
+```lua
+local id = newPlayer:GetId()
+local character = newPlayer:GetCharacter()
+local level = newPlayer:GetLevel()
+```
+
+To set properties, use the same dot notation:
+
+```lua
+newPlayer:SetUsername("NewUsername")
+newPlayer:SetLevel(5)
+```
+
+**Interact with the PlayerManager** The `PlayerManager` allows you to interact with multiple players. To get the global instance of the `PlayerManager`, use:
+
+```lua
+local playerManager = PlayerManager:get()
+```
+
+Now you can call methods from the `PlayerManager` class:
+
+```lua
+local playerCount = playerManager:Count()
+local player = playerManager:GetByConnectionId(connId)
+local allPlayers = playerManager:GetAllPlayers()
+```
+
+**Iterate over all players** The `GetAllPlayers` function returns a table (Lua's version of an array) containing all players. To iterate over all players and perform actions, use a loop:
+
+```lua
+local allPlayers = playerManager:GetAllPlayers()
+for _, player in ipairs(allPlayers) do
+    local username = player:GetUsername()
+    print("Player username: " .. username)
+end
+```

guides/server-guide/page-1.md

@@ -0,0 +1,2 @@
+# Page 1
+