+
+
+
+
+
+ 
+
+### Welcome to the Overload documentation!
+
+The goal of this documentation is to help you getting started with Overload, experimenting, and building your very own games with Overload.
+
+If you need any help with Overload, feel free to join our [Discord](https://discord.gg/wqe775s) server!
\ No newline at end of file
diff --git a/Documentation/content/samples/Cargo.md b/Documentation/content/samples/Cargo.md
new file mode 100644
index 000000000..879fe07f6
--- /dev/null
+++ b/Documentation/content/samples/Cargo.md
@@ -0,0 +1,19 @@
++++
+title = "Cargo"
++++
+
+
+
+[
GitHub Repository](https://github.com/Overload-Technologies/Cargo)
+
+A short puzzle demo game that demonstrates gameplay mechanics built using Overload.
+
+### Project files (recommended)
+- [For Overload latest](https://github.com/Overload-Technologies/Cargo)
+- [For Overload v1.6](https://github.com/Overload-Technologies/Cargo/tree/made-for-overload-v1.6)
+- [For Overload v1.5](https://github.com/Overload-Technologies/Cargo/tree/made-for-overload-v1.5)
+- [For Overload v1.4](https://github.com/Overload-Technologies/Cargo/tree/made-for-overload-v1.4)
+- [All Tags](https://github.com/Overload-Technologies/Cargo/tags)
+
+### Playable builds (less frequently updated)
+- [Latest](https://github.com/Overload-Technologies/Cargo/releases)
diff --git a/Documentation/content/samples/Showroom.md b/Documentation/content/samples/Showroom.md
new file mode 100644
index 000000000..e10d61cb5
--- /dev/null
+++ b/Documentation/content/samples/Showroom.md
@@ -0,0 +1,19 @@
++++
+title = "Showroom"
++++
+
+
+
+[ GitHub Repository](https://github.com/Overload-Technologies/Showroom)
+
+A comprehensive demonstration project that showcases Overload Engine's core features and capabilities.
+
+### Project files (recommended)
+- [For Overload latest](https://github.com/Overload-Technologies/Showroom)
+- [For Overload v1.6](https://github.com/Overload-Technologies/Showroom/tree/made-for-overload-v1.6)
+- [For Overload v1.5](https://github.com/Overload-Technologies/Showroom/tree/made-for-overload-v1.5)
+- [For Overload v1.4](https://github.com/Overload-Technologies/Showroom/tree/made-for-overload-v1.4)
+- [All Tags](https://github.com/Overload-Technologies/Showroom/tags)
+
+### Playable builds (less frequently updated)
+- [Latest](https://github.com/Overload-Technologies/Showroom/releases)
diff --git a/Documentation/content/samples/_index.md b/Documentation/content/samples/_index.md
new file mode 100644
index 000000000..dccb6210f
--- /dev/null
+++ b/Documentation/content/samples/_index.md
@@ -0,0 +1,30 @@
++++
+title = "Sample Projects"
+weight = 2
++++
+
+Overload includes several sample projects designed to help you explore the engine's capabilities and get started with development. These projects demonstrate key features and serve as practical learning resources.
+
+## Using Sample Projects
+
+### Version Compatibility
+
+Before downloading or cloning any sample project, verify your Overload version to ensure compatibility. Sample projects are maintained for the [latest release](https://github.com/Overload-Technologies/Overload/releases), but previous versions remain accessible through Git tags.
+
+### Finding the Right Version
+
+Each sample project uses a structured tagging system to track version compatibility:
+
+**Tag Format:** `made-for-overload-v{version}`
+
+**Example:** For Overload v1.6, look for the `made-for-overload-v1.6` tag.
+
+### Getting the Latest Updates
+
+Tags mark major version upgrades, but projects may receive updates between versions. To find the most recent update for your Overload version:
+
+1. Locate the tag for the **next** version (e.g., `made-for-overload-v1.5` if you're using v1.4)
+2. Navigate to the commit immediately before that tag
+3. This represents the latest update compatible with your version
+
+**Example:** For the latest Overload v1.4 compatible version, find the `made-for-overload-v1.5` tag and use the previous commit.
\ No newline at end of file
diff --git a/Documentation/content/scripting/_index.md b/Documentation/content/scripting/_index.md
new file mode 100644
index 000000000..75e7dd0e1
--- /dev/null
+++ b/Documentation/content/scripting/_index.md
@@ -0,0 +1,4 @@
++++
+title = 'Lua Scripting'
+weight = 3
++++
\ No newline at end of file
diff --git a/Documentation/content/scripting/components/AmbientBoxLight.md b/Documentation/content/scripting/components/AmbientBoxLight.md
new file mode 100644
index 000000000..f6b2b1ac9
--- /dev/null
+++ b/Documentation/content/scripting/components/AmbientBoxLight.md
@@ -0,0 +1,26 @@
++++
+title = 'AmbientBoxLight'
++++
+
+### Description
+Represents an ambient light with a box shape
+
+- C++ related class: [`OvCore::ECS::Components::CAmbientBoxLight`](https://github.com/Overload-Technologies/Overload/tree/main/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAmbientBoxLight.h)
+- Inherits from lua usertype: [`Light`](../Light)
+
+### Variables
+_This usertype has no variables_
+
+### Constructors
+|Name|Input|Output|Description|
+|-|-|-|-|
+|new||`AmbientBoxLight`|Default Constructor|
+
+### Functions
+|Name|Input|Output|Description|
+|-|-|-|-|
+|GetSize|`AmbientBoxLight`: instance
+ {{- .Inner -}}
+
diff --git a/Documentation/themes/hugo-geekdoc/layouts/_default/_markup/render-heading.html b/Documentation/themes/hugo-geekdoc/layouts/_default/_markup/render-heading.html
new file mode 100644
index 000000000..3e7a270f3
--- /dev/null
+++ b/Documentation/themes/hugo-geekdoc/layouts/_default/_markup/render-heading.html
@@ -0,0 +1,27 @@
+{{- $showAnchor := (and (default true .Page.Params.geekdocAnchor) (default true .Page.Site.Params.geekdocAnchor)) -}}
+
+
+
+{{- if $showAnchor -}}
++diff --git a/Documentation/themes/hugo-geekdoc/layouts/shortcodes/icon.html b/Documentation/themes/hugo-geekdoc/layouts/shortcodes/icon.html new file mode 100644 index 000000000..080b144a2 --- /dev/null +++ b/Documentation/themes/hugo-geekdoc/layouts/shortcodes/icon.html @@ -0,0 +1,5 @@ +{{ $id := .Get 0 }} + +{{- with $id -}} + +{{- end -}} diff --git a/Documentation/themes/hugo-geekdoc/layouts/shortcodes/img.html b/Documentation/themes/hugo-geekdoc/layouts/shortcodes/img.html new file mode 100644 index 000000000..f0bbb6b00 --- /dev/null +++ b/Documentation/themes/hugo-geekdoc/layouts/shortcodes/img.html @@ -0,0 +1,65 @@ +{{- $source := ($.Page.Resources.ByType "image").GetMatch (printf "%s" (.Get "name")) }} +{{- $customAlt := .Get "alt" }} +{{- $customSize := .Get "size" | lower }} +{{- $lazyLoad := default (default true $.Site.Params.geekdocImageLazyLoading) (.Get "lazy") }} +{{- $data := newScratch }} + +{{- with $source }} + {{- $caption := default .Title $customAlt }} + {{- $isSVG := (eq .MediaType.SubType "svg") }} + {{- $origin := . }} + + {{- if $isSVG }} + {{- $data.SetInMap "size" "tiny" "320" }} + {{- $data.SetInMap "size" "small" "600" }} + {{- $data.SetInMap "size" "medium" "1200" }} + {{- $data.SetInMap "size" "large" "1800" }} + {{- else }} + {{- $data.SetInMap "size" "tiny" "320x"}} + {{- $data.SetInMap "size" "small" "600x" }} + {{- $data.SetInMap "size" "medium" "1200x" }} + {{- $data.SetInMap "size" "large" "1800x" }} + {{- end -}} + ++ {{- with $icon -}} + + {{ $title }} + {{- else -}} + + {{ $title }} + {{- end -}} ++{{ .Inner | $.Page.RenderString }}+
+ {{- .Inner -}}
+
diff --git a/Documentation/themes/hugo-geekdoc/layouts/shortcodes/progress.html b/Documentation/themes/hugo-geekdoc/layouts/shortcodes/progress.html
new file mode 100644
index 000000000..2142a0ff9
--- /dev/null
+++ b/Documentation/themes/hugo-geekdoc/layouts/shortcodes/progress.html
@@ -0,0 +1,24 @@
+{{- $value := default 0 (.Get "value") -}}
+{{- $type := default "main" (.Get "type") }}
+{{- $title := .Get "title" -}}
+{{- $icon := .Get "icon" -}}
+
+
+