Skip to content

Commit

Permalink
Changing version
Browse files Browse the repository at this point in the history
README added
  • Loading branch information
RX0kas committed Feb 16, 2025
1 parent 8dbf2b5 commit 4445cd5
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 6 deletions.
39 changes: 39 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -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)
7 changes: 4 additions & 3 deletions fabric/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions neoforge/src/main/resources/META-INF/neoforge.mods.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
modLoader = "javafml"
loaderVersion = "[2,)"
#issueTrackerURL = ""
issueTrackerURL = "https://github.com/RX0kas/entity-purge/issues/"
license = "MIT"

[[mods]]
Expand All @@ -9,7 +9,7 @@ version = "${version}"
displayName = "EntityPurge"
authors = "RXokas"
description = '''
A simple ClearLag mod that aims to be as customizable as possible
'''
#logoFile = ""

Expand Down

0 comments on commit 4445cd5

Please sign in to comment.