Skip to content

Commit 0fc5455

Browse files
changes
1 parent dc1726f commit 0fc5455

File tree

2 files changed

+34
-52
lines changed

2 files changed

+34
-52
lines changed

docs/nova/admin/compatibility/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,10 @@ add support on their end using [the API](../../api/protection/protectionintegrat
3535
- [x] Towny
3636
- [x] ProtectionStones
3737
- [x] QuickShop
38-
- [x] Residence
38+
- [x] Residence
39+
40+
## Incompatible Plugins
41+
42+
The following plugins cannot be used with Nova:
43+
44+
- [FastAsyncWorldEdit](https://www.spigotmc.org/resources/13932/) - Please consider using normal [WorldEdit](https://dev.bukkit.org/projects/worldedit) instead.

docs/nova/admin/setup.md

Lines changed: 27 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,20 @@
22

33
Before installing Nova, please make sure that you're running a [supported server software](compatibility/index.md#compatible-server-software).
44

5-
## Step 1: Plugin Installation
5+
## Step 1: Installing Nova and addons
66

77
* Like any other plugin, the Nova plugin jar file downloaded from [Hangar](https://hangar.papermc.io/xenondevs/Nova), [Modrinth](https://modrinth.com/plugin/nova-framework), [GitHub](https://github.com/xenondevs/Nova) or our [Discord](https://discord.gg/hnEknVWvUe) just needs to be put in the ``plugins/`` folder of your server.
8+
* Since 0.18, addons are loaded as plugins. Therefore, you can also just put them into the `plugins/` folder.
9+
* Some addons might require other addons in order to work.
10+
If this is the case, an error in the console will notify you of the missing addons:
11+
`Failed to initialize <Name of the Addon>: Missing addon(s): <Name(s) of the required addon(s) that are missing>`
812
* Start your server and wait until Nova is done loading. (Indicated by the message in the console `[Nova] Done loading`). This creates config files and directories which you will need to access in the following steps.
913
* Stop your server.
1014

11-
=== "0.18"
15+
The new resource pack containing the addon assets will be automatically generated, but it won't be sent to players yet.
16+
Please follow Step 2 to configure resource pack hosting.
1217

13-
## Step 2: Installing addons
14-
15-
Starting with 0.18, Nova addons are now loaded as plugins.
16-
Therefore, you can just put them into the plugins/ directory of your server.
17-
18-
=== "0.17 or older"
19-
20-
!!! bug "**Do NOT put addons in the plugins folder**"
21-
22-
Nova addons are not plugins and won't load in the `plugins/` folder.
23-
Please follow Step 2 to install addons.
24-
25-
## Step 2: Installing addons
26-
27-
To install an addon:
28-
29-
* Stop the server
30-
* Drag & drop the addon jar file into ``plugins/Nova/addons/``
31-
* Start the server again
32-
33-
The new resource pack containing the addon assets will be automatically generated, but it won't be sent to players yet.
34-
Please follow Step 3 to configure resource pack hosting.
35-
36-
!!! info
37-
38-
Some addons might require other addons in order to work.
39-
If this is the case, an error in the console will notify you of the missing addons:
40-
`Failed to initialize <Name of the Addon>: Missing addon(s): <Name(s) of the required addon(s) that are missing>`
41-
42-
## Step 3: Configure resource pack hosting
18+
## Step 2: Configure resource pack hosting
4319

4420
Due to the way server resource packs work, it is required to upload them to a web server first before they can be sent to players.
4521
This can be done either automatically or manually:
@@ -50,21 +26,6 @@ This can be done either automatically or manually:
5026
You can configure it in the main config file `plugins/Nova/configs/config.yml` under `resource_pack` > `auto_upload`.
5127

5228
!!! info "Available Upload Services"
53-
54-
=== "Patreon Upload Service"
55-
56-
[Patrons](https://www.patreon.com/xenondevs) are given access to upload to our servers.
57-
Due to hosting costs and the potential for abuse, this service is only available to Patrons and not available publicly.
58-
59-
Example config:
60-
61-
```yaml title="plugins/Nova/configs/config.yml"
62-
resource_pack:
63-
auto_upload:
64-
enabled: true
65-
service: xenondevs
66-
key: "" # Your Patreon-Uploader Key
67-
```
6829
6930
=== "Self-hosted"
7031
@@ -128,6 +89,21 @@ This can be done either automatically or manually:
12889
force_path_style: false # Forces path style URLs (Defaults to false)
12990
```
13091

92+
=== "Patreon Upload Service"
93+
94+
Patrons are given access to upload to our servers.
95+
Due to hosting costs and the potential for abuse, this service is only available to Patrons and not available publicly.
96+
97+
Example config:
98+
99+
```yaml title="plugins/Nova/configs/config.yml"
100+
resource_pack:
101+
auto_upload:
102+
enabled: true
103+
service: xenondevs
104+
key: "" # Your Patreon-Uploader Key
105+
```
106+
131107
=== "Manual resource pack hosting"
132108

133109
For manual resource pack hosting, upload the resource pack found under `plugins/Nova/resource_pack/ResourcePack.zip` to a file uploader of your choice.
@@ -155,12 +131,12 @@ This can be done either automatically or manually:
155131

156132
This step is only required if your server is already using a custom resource pack.
157133

158-
Due to technical limitations, it is only possible to have one server resource pack.
159-
To circumvent this issue, Nova can automatically merge existing resource packs with its own.
160-
Additionally, Nova also analyzes the existing resource pack and adjust its own data accordingly to prevent conflicts.
134+
In the past, there could be only one server resource pack. While this is no longer the case, resource pack
135+
merging is still important as Nova uses it to analyze the existing resource pack and adjusts its own data accordingly
136+
to prevent conflicts.
161137
**Therefore, it is NOT possible to manually merge resource packs, and it is also NOT possible to use merging services from other plugins.**
162138

163-
There are two ways to define base packs:
139+
You can define "base packs", which are resource packs that Nova should merge, in two ways:
164140

165141
=== "With Config"
166142

0 commit comments

Comments
 (0)