From 4445cd5966ca61d744ecca253dfdf32cc5905af9 Mon Sep 17 00:00:00 2001
From: RX0kas <116596186+RX0kas@users.noreply.github.com>
Date: Sun, 16 Feb 2025 21:33:37 +0100
Subject: [PATCH] Changing version README added

---
 README                                        | 39 +++++++++++++++++++
 fabric/src/main/resources/fabric.mod.json     |  7 ++--
 gradle.properties                             |  2 +-
 .../resources/META-INF/neoforge.mods.toml     |  4 +-
 4 files changed, 46 insertions(+), 6 deletions(-)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..02c3646
--- /dev/null
+++ b/README
@@ -0,0 +1,39 @@
+# Entity Purge
+### A simple ClearLag mod that aims to be as customizable as possible
+
+## Configuration File
+### clearItem
+- **Description :** Determines whether the ground objects should be deleted during ClearLag
+- **Default value :** `true`
+
+### minutesBetweenEachPurge
+- **Description :** Specifies the time in minutes between each entity and object purge cycle
+- **Default value :** `1`
+
+### entitiesToClear
+- **Description :** Contains the identifiers of the Minecraft entities that will be deleted during ClearLag
+- **Example :** `["minecraft:pig","mymod:importantentity"]`
+
+### warning10s
+- **Description :** Enables or disables the display of a warning message 10 seconds before the ClearLag is triggered
+- **Default value :** `true`
+
+### warning10sMessage
+- **Description :** Sets the warning message displayed to players 10 seconds before entities are removed
+- **Default value :** `"§cCaution, the clear lag will append in 10 seconds!"`
+
+### warninghappend
+- **Description :** Enables or disables the display of a message indicating that purge has been performed
+- **Default value :** `true`
+
+### warninghappendMessage
+- **Description :** Sets the message displayed to players after ClearLag has been executed
+- **Default value :** `"§2Clear lag done!"`
+
+
+
+## Dependencies
+### Architectury API required
+![Architectury API logo](https://cdn.modrinth.com/data/hUDBrSHN/dcc7d780f3522c50c9298c11fd0b73f27f17b225_96.webp)
+### MidnightLib required
+![MidnightLib logo](https://cdn.modrinth.com/data/codAaoxh/icon.png)
\ No newline at end of file
diff --git a/fabric/src/main/resources/fabric.mod.json b/fabric/src/main/resources/fabric.mod.json
index b8a65c1..ada6c6f 100644
--- a/fabric/src/main/resources/fabric.mod.json
+++ b/fabric/src/main/resources/fabric.mod.json
@@ -3,15 +3,16 @@
   "id": "entitypurge",
   "version": "${version}",
   "name": "EntityPurge",
-  "description": "",
+  "description": "A simple ClearLag mod that aims to be as customizable as possible",
   "authors": [
     "RXokas"
   ],
   "contact": {
-    "homepage": ""
+    "homepage": "https://github.com/RX0kas/entity-purge",
+    "issues": "https://github.com/RX0kas/entity-purge/issues/"
   },
   "license": "MIT",
-  "environment": "server",
+  "environment": "*",
   "entrypoints": {
     "main": [
       "fr.rxokas.entitypurge.fabric.EntitypurgeFabric"
diff --git a/gradle.properties b/gradle.properties
index aa6b82c..d1fb8d2 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -2,7 +2,7 @@
 org.gradle.jvmargs=-Xmx2G
 org.gradle.parallel=true
 # Mod properties
-mod_version=0.0.1
+mod_version=1.0.0
 maven_group=fr.rxokas
 archives_name=EntityPurge
 enabled_platforms=fabric,neoforge
diff --git a/neoforge/src/main/resources/META-INF/neoforge.mods.toml b/neoforge/src/main/resources/META-INF/neoforge.mods.toml
index 6d45c55..75b6b45 100644
--- a/neoforge/src/main/resources/META-INF/neoforge.mods.toml
+++ b/neoforge/src/main/resources/META-INF/neoforge.mods.toml
@@ -1,6 +1,6 @@
 modLoader = "javafml"
 loaderVersion = "[2,)"
-#issueTrackerURL = ""
+issueTrackerURL = "https://github.com/RX0kas/entity-purge/issues/"
 license = "MIT"
 
 [[mods]]
@@ -9,7 +9,7 @@ version = "${version}"
 displayName = "EntityPurge"
 authors = "RXokas"
 description = '''
-
+A simple ClearLag mod that aims to be as customizable as possible
 '''
 #logoFile = ""