chore: Cleanup and Readme (#17)

README.md

@@ -0,0 +1,34 @@
+<br />
+<div align="center">
+  <a href="https://discord.gg/84VT8gv5Ya">
+    <img src=".github/assets/blockventure.jpg" alt="Logo">
+  </a>
+
+<h3 align="center">BlockVenture - Your journey awaits!</h3>
+
+  <p align="center">
+    A Minecraft Theme Park Server
+    <br />
+    Tribute to CraftVenture <3
+    <br />
+    <a href="https://discord.com/users/216487432667791360"><strong>Contact »</strong></a>
+    <br />
+    <br />
+    <a href="https://discord.gg/84VT8gv5Ya">Discord-Server</a>
+    ·
+    <a href="https://weblate.flawcra.cc/engage/blockventureplugin/">
+      Help us translate the server!
+      <img src="https://weblate.flawcra.cc/widget/blockventureplugin/translations/svg-badge.svg" alt="Translation status" />
+    </a>
+  </p>
+
+<br />
+<br />
+
+</div>
+
+
+## Developer Documentation
+
+We are working on providing all the needed informations for development on our [KTDocs](https://docs.blockventuremc.net).
+If you feel like there is something missing, feel free to [open a issue](https://github.com/BlockVentureMC/BlockVenturePlugin/issues/new)

build.gradle.kts

@@ -3,6 +3,22 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 import org.jetbrains.dokka.gradle.DokkaTask
 import java.net.URL
 
+/**
+ * Defines the versions of the dependencies inside gradle.properties.
+ */
+val exposedVersion: String by project
+val gsonVersion: String by project
+val hikariVersion: String by project
+val mariadbVersion: String by project
+val reflectionsVersion: String by project
+val dotenvVersion: String by project
+val fruxzAscendVersion: String by project
+val fruxzStackedVersion: String by project
+val serializationVersion: String by project
+val minecraftVersion: String by project
+val authlibVersion: String by project
+val placeholderApiVersion: String by project
+
 plugins {
     kotlin("jvm") version "2.0.0-RC1"
     id("com.github.johnrengelman.shadow") version "8.1.1"
@@ -37,33 +53,31 @@ repositories {
     maven("https://nexus.flawcra.cc/repository/maven-mirrors/")
 }
 
-val exposedVersion = "0.49.0"
-
 val deps = listOf(
-    "net.oneandone.reflections8:reflections8:0.11.7",
-    "dev.fruxz:ascend:2024.1.2",
-    "dev.fruxz:stacked:2024.1.1",
-    "io.github.cdimascio:dotenv-kotlin:6.4.1",
+    "net.oneandone.reflections8:reflections8:$reflectionsVersion",
+    "dev.fruxz:ascend:$fruxzAscendVersion",
+    "dev.fruxz:stacked:$fruxzStackedVersion",
+    "io.github.cdimascio:dotenv-kotlin:$dotenvVersion",
 
     "org.jetbrains.exposed:exposed-core:$exposedVersion",
     "org.jetbrains.exposed:exposed-dao:$exposedVersion",
     "org.jetbrains.exposed:exposed-jdbc:$exposedVersion",
     "org.jetbrains.exposed:exposed-java-time:$exposedVersion",
-    "com.google.code.gson:gson:2.10.1",
-    "org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.2",
+    "com.google.code.gson:gson:$gsonVersion",
+    "org.jetbrains.kotlinx:kotlinx-serialization-json:$serializationVersion",
 
 
-    "com.zaxxer:HikariCP:5.1.0",
-    "org.mariadb.jdbc:mariadb-java-client:3.3.3",
+    "com.zaxxer:HikariCP:$hikariVersion",
+    "org.mariadb.jdbc:mariadb-java-client:$mariadbVersion",
 )
 
 
 dependencies {
-    compileOnly("io.papermc.paper:paper-api:1.20.4-R0.1-SNAPSHOT")
+    compileOnly("io.papermc.paper:paper-api:$minecraftVersion")
 
     // External dependencies
-    compileOnly("com.mojang:authlib:1.6.25")
-    compileOnly("me.clip:placeholderapi:2.11.5")
+    compileOnly("com.mojang:authlib:$authlibVersion")
+    compileOnly("me.clip:placeholderapi:$placeholderApiVersion")
 
     deps.forEach {
         implementation(it)

gradle.properties

@@ -1 +1,13 @@
 kotlin.code.style=official
+exposedVersion="0.49.0"
+gsonVersion="2.10.1"
+hikariVersion="5.1.0"
+mariadbVersion="3.3.3"
+reflectionsVersion="0.11.7"
+dotenvVersion="6.4.1"
+fruxzAscendVersion="2024.1.2"
+fruxzStackedVersion="2024.1.1"
+serializationVersion="1.6.2"
+minecraftVersion="1.20.4-R0.1-SNAPSHOT"
+authlibVersion="1.6.25"
+placeholderApiVersion="2.11.5"

src/main/resources/translations/en-US.json

@@ -0,0 +1 @@
+{}