Skip to content

Commit 89540bf

Browse files
committed
Improve docs
1 parent f4d5c0c commit 89540bf

File tree

6 files changed

+63
-1
lines changed

6 files changed

+63
-1
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.idea
2+
.vitepress/cache
3+
.vitepress/dist
4+
node_modules

.vitepress/config.mts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ export default defineConfig({
2323
{text: 'Introduction', link: '/introduction/introduction'},
2424
{text: 'Getting Started', link: '/introduction/getting-stated'},
2525
]
26+
},
27+
{
28+
text: 'General',
29+
items: [
30+
{text: 'Web Server', link: '/general/web-server'},
31+
{text: 'Web Editor', link: '/general/web-editor'},
32+
]
2633
}
2734
],
2835

src/general/web-editor.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# LostEngine Web Editor
6+
7+
## Introduction
8+
LostEngine has a built-in web editor to help you to manage your custom resources.
9+
10+
## How to use it
11+
In order to use the editor, you need to have enabled the `self_hosted` pack hosting method (see [Web Server](/general/web-server)),
12+
and use the `/le editor` command to get the write and read only link. The write link can do anything while the read only link
13+
can only view files but cannot create or edit them.
14+
15+
:::tip
16+
Sharing a read only link to the editor can help people that help you if you have a bug or a question.
17+
The read only link will always end with "_readonly", and links expire each time you restart your server.
18+
:::

src/general/web-server.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# LostEngine Integrated Web Server
6+
7+
## Introduction
8+
LostEngine has an integrated web server for sending the resource pack to players and for the [Web Editor](/general/web-editor).
9+
It can work two different ways. The first one, like every other plugins, creates a separate HTTP server on a second port,
10+
this is great if you have multiple ports available on your server, but it needs to be configured manually. The second option,
11+
will use your Minecraft server's TCP connection to create an HTTP server, this means that the same port as your Minecraft server will be
12+
used for the Web server. It works by detecting when a packet from a handshake connection is sent to your server, if it looks like
13+
an HTTP request or not. If it is the case, it switches the packet handler to LostEngine's HTTP packet handler and works the same as
14+
on a second port without affecting it or removing any feature.
15+
16+
## Configuring it
17+
::: code-group
18+
19+
```yaml [config.yml]
20+
pack_hosting:
21+
resource_pack_prompt: "Download the Lost Engine resource pack"
22+
self_hosted:
23+
enabled: true # [!code highlight]
24+
hostname: 0.0.0.0 # your server's public IP address [!code highlight]
25+
use_minecraft_port: true # if it uses Minecraft's port or `port` below [!code highlight]
26+
port: 7270 # if not using `use_minecraft_port` [!code highlight]
27+
external_host:
28+
enabled: false # [!code highlight]
29+
url: ""
30+
```
31+
32+
:::

src/introduction/getting-stated.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ outline: deep
88
and install the corresponding Paper or Folia version *(other forks may work but are not supported)*.
99
For example:
1010
`LostEngine-0.0.6-mc1.21.11.jar` needs Paper or Folia 1.21.11.
11-
- You will then need to put the JAR file into your servers' `plugins` folder and **restart your server**
11+
- You will then need to put the JAR file into your server's `plugins` folder and **restart your server**
1212
- After restarting your server, some default items will be added, the resource pack should be working by default,
1313
and you can access LostEngine's Web Editor using the `/le editor` command.

src/introduction/introduction.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
outline: deep
33
---
44

5+
# Introduction
56
## What is LostEngine?
67

78
LostEngine is a custom item plugin whose particularity is that it creates new items

0 commit comments

Comments
 (0)