Skip to content

Commit b26fcd3

Browse files
authored
Update README
1 parent d3f72da commit b26fcd3

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
1. **Install the Plugin**: Add the `softlanding` plugin to your SerenityJS server's `plugins` directory.
1111

12-
2. **Configure the Plugin**: Create a `softlanding.json` file in the plugin directory:
12+
2. **Configure the Plugin**: Create a `softlanding.config.json` file in the root directory:
1313

1414
```json
1515
{
@@ -29,27 +29,27 @@
2929

3030
## Features
3131

32-
##### [Automatic Player Transfer]
32+
### [Automatic Player Transfer]
3333

34-
Players are automatically redirected to a fallback server when the current server closes, ensuring a smooth experience.
34+
* Players are automatically redirected to a fallback server when the current server closes, ensuring a smooth experience.
3535

36-
##### [Fallback Server List]
36+
### [Fallback Server List]
3737

38-
Specify multiple fallback servers with addresses and ports. SoftLanding can optionally ping these servers to check availability before transferring players.
38+
* Specify multiple fallback servers with addresses and ports. SoftLanding can optionally ping these servers to check availability before transferring players.
3939

40-
##### [Configurable Ping Intervals]
40+
### [Configurable Ping Intervals]
4141

42-
The plugin can periodically check fallback server availability with a customizable interval in milliseconds (pingInterval).
42+
* The plugin can periodically check fallback server availability with a customizable interval in milliseconds (pingInterval).
4343

44-
##### [Safe Shutdown Warnings]
44+
### [Safe Shutdown Warnings]
4545

46-
Optional pre-transfer notifications can alert players before the server closes (if enabled in future versions).
46+
* Optional pre-transfer notifications can alert players before the server closes (if enabled in future versions).
4747

48-
##### [Lightweight & Easy]
48+
### [Lightweight & Easy]
4949

50-
Minimal setup required — just install, configure, and start your server.
50+
* Minimal setup required — just install, configure, and start your server.
5151

52-
##### Configuration Options
52+
## Configuration Options
5353

5454
Option Type Description
5555
enabled boolean Whether the plugin is enabled.

0 commit comments

Comments
 (0)