generated from Astra-Interactive/AstraTemplate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/master'
- Loading branch information
Showing
1 changed file
with
2 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,70 +1,5 @@ | ||
[![kotlin_version](https://img.shields.io/badge/kotlin-1.7.0-blueviolet?style=flat-square)](https://github.com/Astra-Interactive/AstraLibs) | ||
[![minecraft_version](https://img.shields.io/badge/minecraft-1.19-green?style=flat-square)](https://github.com/Astra-Interactive/AstraLibs) | ||
[![platforms](https://img.shields.io/badge/platform-spigot%7Cfabric%7Cforge-blue?style=flat-square)](https://github.com/Astra-Interactive/AstraLibs) | ||
# AstraTemplate | ||
This plugin template will help you to create new Spigot plugins as fast as possible | ||
# | ||
<h4 align="center">☄️ Plugins based on AstraTemplate☄️ </h4> | ||
</br> | ||
<p align="center"> | ||
<a href="https://github.com/Astra-Interactive/AstraLibs"> | ||
<img alt="spigot" src="https://img.shields.io/badge/github-AstraLibs-1B76CA"/> | ||
</a> | ||
<a href="https://www.spigotmc.org/resources/astra-market.99114/"> | ||
<img alt="spigot" src="https://img.shields.io/badge/github-AstraMarket-1B76CA"/> | ||
</a> | ||
<a href="https://www.spigotmc.org/resources/simple-rating.103317/"> | ||
<img alt="spigot" src="https://img.shields.io/badge/github-SimpleRating-1B76CA"/> | ||
</a> | ||
</p> | ||
|
||
# Brief description for AstraTemplate | ||
|
||
AstraTemplate depends on kotlinx libraries, which located in [AstraLibs](https://github.com/Asrta-Interactive/AstraTemplate/wiki/AstraLibs), which you are allowed to modify, so, if you don't like this dependencies - you can get rid of that by yourself | ||
|
||
|
||
Astra template has everything(probably) you need including: | ||
- [x] Paginated menu example | ||
- [x] Menu live-update example | ||
- [x] EventManager and Event example | ||
- [x] Commands example | ||
- [x] TabCompleter example | ||
- [x] Database example | ||
- [x] Permissions example | ||
- [x] FileManager example | ||
- [x] YML Config loader example | ||
- [x] Translation config example | ||
- [x] Plugin reload | ||
- [x] PlugMan support | ||
- [x] GSON-like YML loader using GSON or kotlinx.serialization | ||
- [x] Logger, which can be logged in file | ||
- [x] Readable code | ||
- [x] (almost) Everything is commented | ||
- [x] Error catching | ||
- [x] Enum extensions | ||
- [x] DTO And domain structure | ||
- [x] Multimodules structure | ||
- [x] DSL Database | ||
- [x] Easy DI aka Dependency Injection | ||
- [x] MVI GUI example | ||
- [x] And more other stuff - better look by yourself | ||
|
||
# Platforms | ||
|
||
- [x] Spigot/Paper | ||
- [x] Fabric - Pre Alpha state | ||
- [ ] Velocity/Bungee | ||
- [x] Forge - Pre-Alpha state | ||
|
||
Also, checkout [AstraLearner](https://play.google.com/store/apps/details?id=com.makeevrserg.astralearner) - it will help you to learn foreign words easily! | ||
|
||
## Directory structure | ||
|
||
├── domain # Shared module between fabric/spigot/forge | ||
├── buildSrc # Build components | ||
├── fabric # Fabric template mod | ||
└── plugin # Spigot template mod | ||
|
||
## Build jar executables | ||
$ ./gradlew :plugin:shadowJar # assemble the plugin .jar | ||
$ ./gradlew :fabric:build # assemble the Fabric .jar | ||
# AstraEssentials | ||
Essentials plugin for EmpireSMP |