Skip to content

Commit 4d41641

Browse files
committed
update readme
1 parent e807aba commit 4d41641

File tree

1 file changed

+27
-20
lines changed

1 file changed

+27
-20
lines changed

README.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
### MultiPlatform (Plugin-first) Spigot/Velocity/Fabric/Forge plugin
99

1010
This is a Minecraft Multiplatform template that provides architecture and various tools you'll need to create new
11-
Spigot/Velocity plugins as fast as possible
11+
Spigot/Velocity/Fabric/Forge server-plugins as fast as possible
1212

1313
<h4 align="center">☄️ Plugins based on AstraTemplate☄️ </h4>
1414

@@ -25,30 +25,32 @@ Spigot/Velocity plugins as fast as possible
2525
<a href="https://github.com/Astra-Interactive/AstraShop">
2626
<img alt="spigot" src="https://img.shields.io/badge/github-AstraShop-1B76CA"/>
2727
</a>
28-
<a href="https://github.com/Astra-Interactive/SynK">
29-
<img alt="spigot" src="https://img.shields.io/badge/github-SynK[WIP]-1B76CA"/>
28+
<a href="https://github.com/Astra-Interactive/SoulKeeper">
29+
<img alt="spigot" src="https://img.shields.io/badge/github-SoulKeeper-1B76CA"/>
3030
</a>
3131
</p>
3232

33-
## Novice developer?
33+
## Not for novice developers
3434

3535
This project can be very difficult for novice developers. Especially for those who were working with java.
3636

3737
## Overview
3838

39-
AstraTemplate and it's libs design after more than 2 years of developing spigot plugins and android applications.
40-
It contains powerful and scalable architecture template which will help you in your development.
39+
AstraTemplate and it's libs design after more than 3 years of developing spigot plugins and android applications.
40+
It contains powerful and scalable architecture template which will help in your development.
4141

4242
## 1. Directory structure
4343

4444
├── modules
45-
│ ├── api-local # Local api with SQLite
45+
│ ├── api-local # Local api with runtime reloadable SQLite
4646
│ ├── api-remote # Remote sample RickMorty API
47+
│ ├── build-konfig # Compile-time constants
4748
│ └── core # Core multiplatform module
48-
├── forge # Forge template mod
49-
├── fabric # Fabric template mod
50-
├── velocity # Velocity template plugin
51-
└── plugin # Bukkit template mod
49+
├── instances
50+
│ ├── bukkit # Paper API plugin
51+
│ ├── forge # Forge server mod
52+
│ ├── fabric # Fabric server mod
53+
└── └── velocity # Velocity plugin
5254

5355
## 2. Gradle plugin
5456

@@ -62,30 +64,31 @@ My gradle plugin is well-documented and easy to use. [Please, see it](https://gi
6264

6365
#### 3.1 `api-local`
6466

65-
This module contains local API with sqlite database. It contains no spigot/velocity/fabric dependencies.
66-
Jvm only. Due to this factor, you can easily share this module between your spigot/velocity plugin or fabric/forge.
67+
This module contains local API with sqlite database. It's Jvm only. Due to this factor, you can easily share this module
68+
between your spigot/velocity plugin or fabric/forge.
6769

6870
With this module you will be only dependent on LocalApi, which is an interface.
6971

70-
Currently AstraLibs-orm is used for SQLite api-local, but you can replace it with anything you want.
72+
Currently Exposed is used for SQLite api-local, but you can replace it with anything you want.
7173
Only implementation will be changed, but LocalApi will be untouched, also as other functionality of your plugin/mod
7274

7375
#### 3.2 `api-remote`
7476

7577
This module contains remote api with RickMortyApi. It will return random character with suspend async response.
7678
Like `api-local`, this module also contains only jvm dependencies, so can be used in spigot/fabrict and others.
7779

78-
#### 3.3 `dto`
80+
#### 3.3 `build-konfig`
7981

80-
Sometimes you need to share models between other modules, so this module contains shared data models.
82+
Sometimes you need to share constants generated at compile-time between other modules, so this module exactly what you
83+
need.
8184

82-
#### 3.4 `shared`
85+
#### 3.4 `core`
8386

84-
Usually all instances(forge/bukkit) have the same logic, which can be located here without depending on platform
87+
Usually this module contains shared translation/configuration or utilities.
8588

8689
## 4. Velocity/Fabric/Forge
8790

88-
I've not been working with velocity too much, but this modules contains basic functionality with plugin
91+
I've not been working with this loaders too much, but th modules contains basic functionality with plugin
8992
information generation.
9093

9194
## 5. Quick overview
@@ -99,6 +102,8 @@ This plugin contains advanced and powerful spigot functionality
99102
- DI
100103
- Permissions
101104
- Configuration
105+
- ORM(database)
106+
- Reloading
102107

103108
## 6. Architecture overview
104109

@@ -198,7 +203,9 @@ Firstly, change gradle/libs.versions.toml destination-xxx to your folder
198203
$ ./gradlew :fabric:build # assemble the fabric .jar
199204
$ ./gradlew :forge:shadowJar # assemble the forge .jar
200205

201-
### Forge and fabirc is on pause
206+
### Test server
207+
208+
There's located [docker-compose.yml](docker-compose.yml) which can launch any server you need for testing purposes.
202209

203210
Also, checkout [AstraLearner](https://play.google.com/store/apps/details?id=com.makeevrserg.astralearner) - it will help
204211
you to learn foreign words easily!

0 commit comments

Comments
 (0)