Skip to content

Commit 648298d

Browse files
committed
Added Documentation/ folder with built-in documentation
1 parent 6fd3bfa commit 648298d

File tree

332 files changed

+5746
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

332 files changed

+5746
-0
lines changed

Documentation/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
public/

Documentation/.hugo_build.lock

Whitespace-only changes.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
+++
2+
date = '{{ .Date }}'
3+
draft = true
4+
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
5+
+++

Documentation/content/docs/Home.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<a href="Home"><img src="https://user-images.githubusercontent.com/33324216/94347436-2116a980-0002-11eb-8d9d-1e9a314eab6d.png" width=256/></a>
2+
3+
### Welcome to the Overload wiki!
4+
5+
The goal of this documentation is to help you getting started with Overload, experimenting, and building your very own games with Overload.
6+
7+
So let's dive in!
8+
- [<img src="https://img.icons8.com/fluent/48/000000/book.png" width=16/> Tutorials](Tutorials)
9+
- [<img src="https://img.icons8.com/fluent/48/000000/code.png" width=16/> Scripting API](Scripting-API)
10+
- [<img src="https://img.icons8.com/fluent/48/000000/package.png" width=16/> Sample Projects](Sample-Projects)
11+
12+
If you need any help with Overload, feel free to join our [Discord](https://discord.gg/wqe775s) server!
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
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.
2+
3+
## [🎭 Showroom](https://github.com/Overload-Technologies/Showroom)
4+
5+
![image](https://github.com/user-attachments/assets/f4cd7fca-d410-4fbf-90d1-e23b8ffcf61d)
6+
7+
A comprehensive demonstration project that showcases Overload Engine's core features and capabilities.
8+
9+
### Project files (recommended)
10+
- [For Overload latest](https://github.com/Overload-Technologies/Showroom)
11+
- [For Overload v1.6](https://github.com/Overload-Technologies/Showroom/tree/made-for-overload-v1.6)
12+
- [For Overload v1.5](https://github.com/Overload-Technologies/Showroom/tree/made-for-overload-v1.5)
13+
- [For Overload v1.4](https://github.com/Overload-Technologies/Showroom/tree/made-for-overload-v1.4)
14+
- [All Tags](https://github.com/Overload-Technologies/Showroom/tags)
15+
16+
### Playable builds (less frequently updated)
17+
- [Latest](https://github.com/Overload-Technologies/Showroom/releases)
18+
19+
## [🚀 Cargo](https://github.com/Overload-Technologies/Cargo)
20+
21+
![image](https://github.com/user-attachments/assets/cb77cbe4-740f-42fb-a099-fb527cc0caca)
22+
23+
A short puzzle demo game that demonstrates gameplay mechanics built using Overload.
24+
25+
### Project files (recommended)
26+
- [For Overload latest](https://github.com/Overload-Technologies/Cargo)
27+
- [For Overload v1.6](https://github.com/Overload-Technologies/Cargo/tree/made-for-overload-v1.6)
28+
- [For Overload v1.5](https://github.com/Overload-Technologies/Cargo/tree/made-for-overload-v1.5)
29+
- [For Overload v1.4](https://github.com/Overload-Technologies/Cargo/tree/made-for-overload-v1.4)
30+
- [All Tags](https://github.com/Overload-Technologies/Cargo/tags)
31+
32+
### Playable builds (less frequently updated)
33+
- [Latest](https://github.com/Overload-Technologies/Cargo/releases)
34+
35+
## Using Sample Projects
36+
37+
### Version Compatibility
38+
39+
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.
40+
41+
### Finding the Right Version
42+
43+
Each sample project uses a structured tagging system to track version compatibility:
44+
45+
**Tag Format:** `made-for-overload-v{version}`
46+
47+
**Example:** For Overload v1.6, look for the `made-for-overload-v1.6` tag.
48+
49+
### Getting the Latest Updates
50+
51+
Tags mark major version upgrades, but projects may receive updates between versions. To find the most recent update for your Overload version:
52+
53+
1. Locate the tag for the **next** version (e.g., `made-for-overload-v1.5` if you're using v1.4)
54+
2. Navigate to the commit immediately before that tag
55+
3. This represents the latest update compatible with your version
56+
57+
**Example:** For the latest Overload v1.4 compatible version, find the `made-for-overload-v1.5` tag and use the previous commit.

Documentation/content/docs/_index.md

Whitespace-only changes.

Documentation/content/lua/_index.md

Whitespace-only changes.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
### Description
2+
Represents an ambient light with a box shape
3+
4+
- C++ related class: [`OvCore::ECS::Components::CAmbientBoxLight`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAmbientBoxLight.h)
5+
- Inherits from lua usertype: [`Light`](Light)
6+
7+
### Variables
8+
_This usertype has no variables_
9+
10+
### Constructors
11+
|Name|Input|Output|Description|
12+
|-|-|-|-|
13+
|new||`AmbientBoxLight`|Default Constructor|
14+
15+
### Functions
16+
|Name|Input|Output|Description|
17+
|-|-|-|-|
18+
|GetSize|`AmbientBoxLight`:&nbsp;instance<br>|`number`|Returns the size of the box|
19+
|SetSize|`AmbientBoxLight`:&nbsp;instance<br>`number`:&nbsp;size<br>||Defines the size of the box|
20+
21+
### Operators
22+
_This usertype has no operators_
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
### Description
2+
Represents an ambient light with a sphere shape
3+
4+
- C++ related class: [`OvCore::ECS::Components::CAmbientSphereLight`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAmbientSphereLight.h)
5+
- Inherits from lua usertype: [`Light`](Light)
6+
7+
### Variables
8+
_This usertype has no variables_
9+
10+
### Constructors
11+
|Name|Input|Output|Description|
12+
|-|-|-|-|
13+
|new||`AmbientSphereLight`|Default Constructor|
14+
15+
### Functions
16+
|Name|Input|Output|Description|
17+
|-|-|-|-|
18+
|GetRadius|`AmbientSphereLight`:&nbsp;instance<br>|`number`|Returns the radius of the sphere|
19+
|SetRadius|`AmbientSphereLight`:&nbsp;instance<br>`number`:&nbsp;radius<br>||Defines the radius of the sphere|
20+
21+
### Operators
22+
_This usertype has no operators_
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
### Description
2+
Represents an audio listener. The distance between audio sources and audio listener will affect the sound
3+
attenuation of spatialized sounds
4+
5+
- C++ related class: [`OvCore::ECS::Components::CAudioListener`](https://github.com/adriengivry/Overload/blob/develop/Sources/Overload/OvCore/include/OvCore/ECS/Components/CAudioListener.h)
6+
- Inherits from lua usertype: [`Component`](Component)
7+
8+
### Variables
9+
_This usertype has no variables_
10+
11+
### Constructors
12+
|Name|Input|Output|Description|
13+
|-|-|-|-|
14+
|new||`AudioListener`|Default Constructor|
15+
16+
### Functions
17+
_This usertype has no functions_
18+
19+
### Operators
20+
_This usertype has no operators_

0 commit comments

Comments
 (0)