AstralTransRocketries/minosoft
1
0
Fork 0
mirror of https://gitlab.bixilon.de/bixilon/minosoft.git synced 2025-09-10 07:48:29 -04:00
Code Issues Packages Projects Releases Wiki Activity

Improve Modding.md

Browse Source
This commit is contained in:
Bixilon 2020-11-29 16:52:37 +01:00
parent 5fc59092d7
commit 1d09f928b5
No known key found for this signature in database
GPG Key ID: 5CAD791931B09AC4
1 changed files with 26 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/Modding.md
View File

@ -57,21 +57,6 @@ In the root folder of your jar file (the mod) must be a file called `mod.json`.
- `minimum` Minimum versionId required. **Maximum, minimum, both or none** - `minimum` Minimum versionId required. **Maximum, minimum, both or none**
- `maximum` Maximum versionId required. **Maximum, minimum, both or none** - `maximum` Maximum versionId required. **Maximum, minimum, both or none**
## Mod loading (aka Main class)
Your main class must extend the following class: `de.bixilon.minosoft.MinosoftMod`.
### Phases
There are different phases (states) for the loading. There are the following phases:
1. `BOOTING` Happens after loading all configuration files and while displaying the server list.
2. `INITIALIZING` All mods are loaded into the ram and everything before registering anything happens here (like OpenGL stuff, etc). You should also register Events here.
3. `LOADING` You have custom items, entities, blocks, etc? Load it here.
4. `STARTING` All items, etc are loaded. If you want to do anything else, do it here.
5. `STARTED` The loading is complete
The most important thing is performance. To archive fast loading times, etc, all mods (if they don't on each other) are getting loaded async.
One phase is completed (= Next phase starts), once all mods have completed the previous phase. Everything is async.
If your start function needs much time, you can set the loading priority in the `mod.json` to start at the beginning. The `start` method returns a success boolean.
## Getting started ## Getting started
Add Minosoft to your maven dependencies with Add Minosoft to your maven dependencies with
Repository: Repository:
@ -85,12 +70,33 @@ Repository:
``` ```
Dependency: Dependency:
```xml ```xml
<dependency> <dependencies>
<groupId>de.bixilon.gitlab.bixilon</groupId> <dependency>
<artifactId>minosoft</artifactId> <groupId>de.bixilon.gitlab.bixilon</groupId>
<version>master-SNAPSHOT</version> <artifactId>minosoft</artifactId>
</dependency> <version>master-SNAPSHOT</version>
</dependency>
</dependencies>
``` ```
Instead of `master-SNAPSHOT` you should write the latest commit, if there is no release tagged yet.
## Mod loading (aka Main class)
Your main class must extend the following class: `de.bixilon.minosoft.modding.MinosoftMod`.
### Phases
There are different phases (states) for the loading. There are the following phases:
1. `BOOTING` Happens after loading all configuration files and while displaying the server list.
2. `INITIALIZING` All mods are loaded into the ram and everything before registering anything happens here (like OpenGL stuff, etc). You should also register Events here.
3. `LOADING` You have custom items, entities, blocks, etc? Load it here.
4. `STARTING` All items, etc are loaded. If you want to do anything else, do it here.
5. `STARTED` The loading is complete
The most important thing is performance. To archive fast loading times, etc, all mods (if they don't on each other) are getting loaded async.
One phase is completed (= Next phase starts), once all mods have completed the previous phase. Everything is async.
If your start function needs much time, you can set the loading priority in the `mod.json` to start at the beginning. The `start` method returns a success boolean.
Create a Main class, here is an example Create a Main class, here is an example
```java ```java
package de.bixilon.example.mod.main; package de.bixilon.example.mod.main;