Skip to content

Commit 5791183

Browse files
committed
Document JAR variants and set archiveBaseName
Clarify installation and JAR choices in README and DOCUMENTATION: explain the difference between PlayerAnalytics-X.X.X-all.jar (recommended for servers, includes bundled dependencies) and the non-"-all" dev JAR, and recommend using the -all JAR for deployments. Also update app/build.gradle to set archiveBaseName = 'PlayerAnalytics' for the jar and jarJar tasks so produced artifacts have a consistent, expected filename.
1 parent fd42980 commit 5791183

3 files changed

Lines changed: 30 additions & 1 deletion

File tree

DOCUMENTATION.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,19 @@
117117
### Installation Steps
118118

119119
1. **Download the Mod**
120-
- Place `PlayerAnalytics-1.20.1-1.2.jar` in your server's `mods` folder
120+
- Download `PlayerAnalytics-X.X.X-all.jar` from the releases page
121+
- Place it in your server's `mods` folder
122+
123+
**JAR File Variants**:
124+
- **`PlayerAnalytics-X.X.X-all.jar`****Use this for production servers**
125+
- Contains mod code + all bundled dependencies (JDA, SQLite JDBC, etc.)
126+
- Standalone, requires nothing else - works immediately
127+
- Recommended for all server deployments
128+
129+
- `PlayerAnalytics-X.X.X.jar` (Development use only)
130+
- Contains only mod code
131+
- Requires manual dependency setup in a libs folder
132+
- Not recommended for production use
121133

122134
2. **Start Server**
123135
```bash

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
Player analytics mod for Minecraft Forge 1.20.1.
44

5+
## Installation
6+
7+
### JAR File Selection
8+
9+
Two JAR files are provided in each release:
10+
11+
- **`PlayerAnalytics-X.X.X-all.jar`** (Recommended for servers) - Contains the mod + all bundled dependencies (JDA, SQLite, etc.). Use this for server deployment.
12+
- **`PlayerAnalytics-X.X.X.jar`** (Development only) - Contains only the mod code. Requires dependencies to be manually added to a libs folder.
13+
14+
**For server deployment, always use the `-all.jar` file** to ensure all dependencies are included and the mod works immediately without requiring manual setup.
15+
516
## Server-side only
617
This mod is intended to run on the server only. Players do not need to install it on their client to join the server.
718

app/build.gradle

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,8 @@ tasks.matching { it.name.startsWith('prepare') && it.name.contains('Run') }.conf
116116
}
117117

118118
tasks.named('jar', Jar) {
119+
archiveBaseName = 'PlayerAnalytics'
120+
119121
manifest {
120122
attributes([
121123
'Specification-Title' : project.mod_id,
@@ -128,3 +130,7 @@ tasks.named('jar', Jar) {
128130
}
129131
finalizedBy 'reobfJar'
130132
}
133+
134+
tasks.named('jarJar').configure {
135+
archiveBaseName = 'PlayerAnalytics'
136+
}

0 commit comments

Comments
 (0)