Skip to content

Commit 2a7f25f

Browse files
gtnardygtnardy
committed
Updated Latest
1 parent 9d5486c commit 2a7f25f

File tree

11 files changed

+398
-36
lines changed

11 files changed

+398
-36
lines changed

‎docusaurus.config.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ module.exports = {
189189
label: 'bleeding-edge 🩸',
190190
},
191191
latest: {
192-
label: 'latest - a1.98.x ⚖️',
192+
label: 'latest - a1.104.x ⚖️',
193193
}
194194
},
195195
},

‎src/api‎

Submodule api updated 52 files

‎versioned_docs/version-latest/assets-modding/creating-assets/setting-up-ue.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ On Windows, the download of Unreal Engine must be done from inside [Epic Games L
2828
1. Open Epic Games Launcher.
2929
2. Access **Unreal Engine** tab.
3030
3. Open **Library** tab.
31-
4. Press **`+`** and select the correct **Unreal Engine** version (currently nanos world is on **`5.5.X`**).
31+
4. Press **`+`** and select the correct **Unreal Engine** version (currently nanos world is on **`5.7.X`**).
3232
5. Press `Install` and a Popup will appear.
3333
6. Select an installation folder and press `Install`.
3434

‎versioned_docs/version-latest/core-concepts/packages/compatibility-versions.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,16 @@ The Compatibility Mode is a feature that aims to keep old and unmaintained packa
3636
To use the following features, you must update your Package's `compatibility_version` setting in the Package.toml to at least that version (exact that version or bigger).
3737

3838

39+
### Version `1.103`
40+
41+
42+
#### [TextRender](/scripting-reference/classes/text-render.mdx)
43+
44+
`TextRender` was renamed to [Text3D](/scripting-reference/classes/text-3d.mdx). And a new entity `TextRender` was created. To use the new TextRender entity, you must update your `compatibility_version` to at least `1.103`.
45+
46+
In compatibility mode (i.e. setting it to `1.102` or below) `TextRender` will still point to the old `TextRender` class (i.e. to the new `Text3D` class).
47+
48+
3949
### Version `1.65`
4050

4151

‎versioned_docs/version-latest/core-concepts/server-manual/server-docker.md‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
title: Docker Installation
3+
description: How to use Docker to setup a nanos world server
4+
sidebar_position: 5
5+
tags: [hosting]
6+
---
7+
8+
How to use Docker to setup a nanos world server.
9+
10+
11+
:::caution Community Resource
12+
13+
The Docker setup is maintained by the community. For more details, visit the open source GitHub repository: [nanos-world-server Docker](https://github.com/olivatooo/nanos-world-server).
14+
15+
:::
16+
17+
18+
You can run nanos world server in a containerized environment using [Docker](https://www.docker.com/). This method works on any system that supports Docker (Linux, Windows, macOS).
19+
20+
## Prerequisites
21+
22+
* Docker (version 20.10 or higher)
23+
* Docker Compose (version 2.0 or higher)
24+
* At least 100MB of free disk space
25+
26+
## Quick Start with Docker Compose
27+
28+
#### 1. Create a `docker-compose.yml` file:
29+
30+
```yaml
31+
services:
32+
nanos-world-server:
33+
image: olivatooo/nanos-world-server:latest
34+
restart: unless-stopped
35+
# Uncomment to always have the latest version
36+
# pull_policy: always
37+
ports:
38+
- "7777:7777/udp"
39+
- "7777:7777/tcp"
40+
volumes:
41+
- ./Packages:/app/Packages
42+
- ./Assets:/app/Assets
43+
# Uncomment and modify to pass parameters to the server
44+
# command: ["--port", "7777", "--map", "MyMap"]
45+
```
46+
47+
#### 2. Start the server:
48+
49+
```shell
50+
docker-compose up -d
51+
```
52+
53+
#### 3. View logs:
54+
55+
```shell
56+
docker-compose logs -f
57+
```
58+
59+
#### 4. Stop the server:
60+
61+
```shell
62+
docker-compose down
63+
```
64+
65+
## Using Docker CLI
66+
67+
Alternatively, you can run the server directly with Docker:
68+
69+
```shell
70+
docker run olivatooo/nanos-world-server
71+
```
72+
73+
## Configuration
74+
75+
You can pass server parameters by modifying the `command` section in `docker-compose.yml`:
76+
77+
```yaml
78+
command: ["--max-players", "32", "--announce"]
79+
```
80+
81+
## Persistent Data
82+
83+
The Docker configuration mounts a volume to `/app` inside the container. This allows you to:
84+
- Persist server configuration files
85+
- Add custom packages and assets
86+
- Access server logs
87+
- Maintain saved data between container restarts
88+
89+
## Updating the Server
90+
91+
To update to the latest version:
92+
93+
```shell
94+
docker-compose pull
95+
docker-compose up -d
96+
```

‎versioned_docs/version-latest/core-concepts/server-manual/server-installation.mdx‎

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ The Windows server needs the latest [**Microsoft Visual C++ Redistributable**](h
2929

3030
:::
3131

32-
On Windows, you have **three** options for downloading nanos world server:
32+
On **Windows**, you have *four* options for downloading nanos world server:
3333

34-
1. Use the executable (*.exe*) already located at `nanos-world/Server/NanosWorldServer.exe` (if you downloaded the base game).
35-
2. Or download **nanos world™ Dedicated Server** tool from Steam Client.
36-
3. Use [SteamCMD](#downloading-using-steamcmd).
34+
1. Use the executable (*.exe*) already located at the game's folder `nanos-world/Server/NanosWorldServer.exe` (recommended).
35+
2. Download `nanos world™ Dedicated Server` tool from Steam Client.
36+
3. Download through [SteamCMD](#downloading-with-steamcmd).
37+
4. Using [Docker](server-docker) (maintained by the community).
3738

3839

3940
## Linux
@@ -48,11 +49,21 @@ The following Distros are granted to be supported out of the box:
4849
- `Ubuntu 22.04`
4950
- `Debian 12`
5051

51-
You can see a community created page with instructions on how to install the server on other distros and versions [here](server-linux-arm).
52+
You can see a community created page with instructions on how to install the server on other distros and versions [here](server-linux-arm). Alternatively, for other distributions or an easier setup, consider using the community maintained [**Docker**](server-docker), which handles all dependencies automatically.
5253

5354
:::
5455

55-
On Linux, the only way to download the server is through [SteamCMD](https://developer.valvesoftware.com/wiki/SteamCMD#Downloading_SteamCMD). If you are on Ubuntu/Debian, you can easily install SteamCMD like that:
56+
On **Linux**, you have *two* options for downloading nanos world server:
57+
58+
1. Download through [SteamCMD](#installing-steamcmd-on-linux) (officially supported).
59+
2. Using [Docker](server-docker) (maintained by the community).
60+
61+
**Note**: on Linux, you must start the server using the Shell Script `./NanosWorldServer.sh`, which will configure proper paths and needed dynamic libraries which need to be loaded!
62+
63+
64+
### Installing SteamCMD on Linux
65+
66+
If you are on Ubuntu/Debian, you can easily install **SteamCMD** like that:
5667

5768
<Tabs groupId="operating-systems"
5869
values={[
@@ -91,12 +102,10 @@ See the SteamCMD [official installation instructions](https://developer.valvesof
91102

92103
:::
93104

94-
**Note**: on Linux, you must start the server using the Shell Script `./NanosWorldServer.sh`, which will configure proper paths and needed dynamic libraries which need to be loaded!
95-
96105

97-
## Downloading Using SteamCMD
106+
## Downloading with SteamCMD
98107

99-
To download the server through SteamCMD (a command line version of Steam) please [download it](https://developer.valvesoftware.com/wiki/SteamCMD#Downloading_SteamCMD) before proceeding.
108+
To download the server through **SteamCMD** (a command line version of Steam) please [download it](https://developer.valvesoftware.com/wiki/SteamCMD#Downloading_SteamCMD) from the Steam official website before proceeding.
100109

101110
### Manual Installation
102111

‎versioned_docs/version-latest/core-concepts/server-manual/server-linux-arm.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Linux & ARM Server installation
33
description: Special cases for some Linux os & ARM platform
4-
sidebar_position: 5
4+
sidebar_position: 6
55
tags: [hosting]
66
---
77

‎versioned_docs/version-latest/getting-started/tutorials-and-examples/name-tags.md‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,9 @@ function AddNametag(player, character)
2222
-- Spawns the Nametag (TextRender),
2323
local nametag = TextRender(
2424
Vector(), -- Any Location
25-
Rotator(), -- Any Rotation
2625
player:GetName(), -- Player Name
27-
Vector(0.5, 0.5, 0.5), -- 50% Scale
28-
Color(1, 1, 1), -- White
29-
FontType.Roboto, -- Roboto Font
30-
TextRenderAlignCamera.AlignCameraRotation -- Follow Camera Rotation
26+
30, -- Text Size
27+
Color.WHITE -- White Color
3128
)
3229

3330
-- Attaches it to the character and saves it to the player's values

‎versioned_docs/version-latest/scripting-reference/classes/text-3d.mdx‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: 🆒 Text3D
3+
description: Class to create 3D Text with advanced options
4+
sidebar_position: 0
5+
tags: [class]
6+
---
7+
8+
<HeaderDeclaration type="Class" name="Text3D" image="/img/docs/text-3d.webp" />
9+
10+
:::warning
11+
12+
**Text3D** is experimental and may have some limitations. It generates meshes dynamically in runtime, thus it is more performance heavy. Consider using <Classes.TextRender /> if you don't need the extra features.
13+
14+
:::
15+
16+
17+
## 🎒 Examples
18+
19+
```lua showLineNumbers
20+
local my_text_3d = Text3D(
21+
Vector(-100, 200, 300),
22+
Rotator(),
23+
"My Awesome Text",
24+
Vector(1, 1, 1), -- Scale
25+
Color(1, 0, 0), -- Red Color
26+
FontType.OpenSans,
27+
Text3DAlignCamera.FaceCamera
28+
)
29+
```
30+
31+
:::info
32+
33+
If you desire your **Text3D** to be visible through walls, replace it's material with the nanos Default TranslucentDepth one!
34+
35+
`SetMaterial("nanos-world::M_Default_Translucent_Unlit_Depth")`.
36+
37+
You can also tweak it's color and other properties using the Material methods.
38+
39+
:::
40+
41+
42+
## 🛠 Constructors
43+
44+
<ConstructorDeclaration type="Class" name="Text3D" />
45+
46+
47+
## 🗿 Static Functions
48+
49+
<StaticFunctionsDeclaration type="Class" name="Text3D" />
50+
51+
52+
## 🦠 Functions
53+
54+
<FunctionsDeclaration type="Class" name="Text3D" />
55+
56+
57+
## 🚀 Events
58+
59+
<EventsDeclaration type="Class" name="Text3D" />

‎versioned_docs/version-latest/scripting-reference/classes/text-render.mdx‎

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,11 @@ local my_text_render = TextRender(
1515
Vector(-100, 200, 300),
1616
Rotator(),
1717
"My Awesome Text",
18-
Vector(1, 1, 1), -- Scale
19-
Color(1, 0, 0), -- Red Color
20-
FontType.OpenSans,
21-
TextRenderAlignCamera.FaceCamera
18+
40, -- Text Size
19+
Color.RED
2220
)
2321
```
2422

25-
:::info
26-
27-
If you desire your **TextRender** to be visible through walls, replace it's material with the nanos Default TranslucentDepth one!
28-
29-
`SetMaterial("nanos-world::M_Default_Translucent_Unlit_Depth")`.
30-
31-
You can also tweak it's color and other properties using the Material methods.
32-
33-
:::
34-
3523
<ReferenceLink href="getting-started/tutorials-and-examples/name-tags">Nametags</ReferenceLink>
3624

3725

0 commit comments

Comments
 (0)