Skip to content

Commit f72cf01

Browse files
cryptobenchclaude
cryptobench
and
claude
committed
Rename to EasyHome and add admin commands
- Rename package from homeessentials to easyhome - Add /easyhome admin command for in-game configuration - Add configurable home limits, warmup, and permission-based limits - Add MIT license - Update README with full documentation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent b03d2a3 commit f72cf01

File tree

20 files changed

+793
-247
lines changed

20 files changed

+793
-247
lines changed

‎.github/workflows/build.yml‎

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ jobs:
2828
- name: Upload artifact
2929
uses: actions/upload-artifact@v4
3030
with:
31-
name: HomeEssentials
32-
path: target/HomeEssentials-*.jar
31+
name: EasyHome
32+
path: target/EasyHome-*.jar
3333

3434
release:
3535
needs: build
@@ -42,7 +42,7 @@ jobs:
4242
- name: Download artifact
4343
uses: actions/download-artifact@v4
4444
with:
45-
name: HomeEssentials
45+
name: EasyHome
4646
path: ./dist
4747

4848
- name: Get short SHA
@@ -53,38 +53,57 @@ jobs:
5353
id: date
5454
run: echo "DATE=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
5555

56-
- name: Rename JAR
57-
run: mv dist/HomeEssentials-*.jar dist/HomeEssentials.jar
56+
- name: Set version
57+
id: version
58+
run: echo "VERSION=v1.0.${{ github.run_number }}" >> $GITHUB_OUTPUT
5859

59-
- name: Delete existing latest release
60-
run: gh release delete latest --yes || true
61-
env:
62-
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
60+
- name: Rename JAR
61+
run: mv dist/EasyHome-*.jar dist/EasyHome-${{ steps.version.outputs.VERSION }}.jar
6362

6463
- name: Create Release
6564
uses: softprops/action-gh-release@v2
6665
with:
67-
tag_name: latest
68-
name: Latest Build (${{ steps.date.outputs.DATE }})
66+
tag_name: ${{ steps.version.outputs.VERSION }}
67+
name: EasyHome ${{ steps.version.outputs.VERSION }}
6968
body: |
70-
## HomeEssentials - Latest Build
69+
## EasyHome ${{ steps.version.outputs.VERSION }}
7170
72-
**Commit:** ${{ github.sha }}
71+
**Commit:** `${{ steps.sha.outputs.SHORT_SHA }}`
7372
**Date:** ${{ steps.date.outputs.DATE }}
7473
7574
### Installation
76-
1. Download `HomeEssentials.jar`
75+
1. Download `EasyHome-${{ steps.version.outputs.VERSION }}.jar`
7776
2. Place in your Hytale server's `mods/` folder
7877
3. Restart the server
7978
80-
### Setup
81-
```
82-
perm group add default homes.use
83-
perm group add default homes.limit.1
84-
```
79+
### Features
80+
- Multiple named homes (base, mine, farm, etc.)
81+
- Configurable home limits
82+
- Configurable teleport delay
83+
- Permission-based limits for different groups
8584
8685
### Commands
87-
`/sethome [name]` `/home [name]` `/homes` `/delhome <name>` `/homehelp`
88-
files: dist/HomeEssentials.jar
86+
| Command | Description |
87+
|---------|-------------|
88+
| `/sethome [name]` | Save current location |
89+
| `/home [name]` | Teleport to a home |
90+
| `/homes` | List all your homes |
91+
| `/delhome <name>` | Delete a home |
92+
93+
### Admin Commands
94+
| Command | Description |
95+
|---------|-------------|
96+
| `/easyhome admin config` | Show settings |
97+
| `/easyhome admin set default 3` | Everyone gets 3 homes |
98+
| `/easyhome admin set max 25` | Max homes allowed |
99+
| `/easyhome admin set warmup 0` | Instant teleport |
100+
101+
### Quick Setup
102+
```
103+
perm group add Adventure homes.use
104+
perm group add admin homes.admin
105+
/easyhome admin set default 3
106+
```
107+
files: dist/EasyHome-${{ steps.version.outputs.VERSION }}.jar
89108
prerelease: false
90109
make_latest: true

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Build output
22
target/
33

4+
# Local dependencies (but keep HytaleServer.jar for CI)
5+
lib/*.jar
6+
!lib/HytaleServer.jar
7+
48
# IDE
59
.idea/
610
*.iml

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 HomeEssentials Contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 122 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,117 +1,172 @@
1-
# HomeEssentials
1+
# EasyHome
22

3-
A user-friendly home management plugin for Hytale servers. Allows players to save, teleport to, and manage multiple named home locations.
3+
Let players save locations and teleport back instantly! Perfect for survival servers.
44

5-
## Features
5+
## Quick Start
66

7-
- **Multiple named homes** - Save locations with custom names
8-
- **Permission-based limits** - Configure how many homes each player/group can have
9-
- **Teleport warmup** - 3-second warmup that cancels if player moves
10-
- **Clean colored messages** - Easy to read feedback
11-
- **Simple commands** - Intuitive command syntax
7+
1. **Install**: Download the [latest release](../../releases/latest) and drop the JAR into your server's `mods/` folder
8+
2. **Restart** your server
9+
3. **Set a home**: Stand where you want and type `/sethome`
10+
4. **Teleport back**: Type `/home` from anywhere!
1211

13-
## Commands
12+
That's it! Players can now save and teleport to their favorite spots.
1413

15-
| Command | Description |
16-
|---------|-------------|
17-
| `/sethome` | Save current location as 'home' |
18-
| `/sethome <name>` | Save current location with custom name |
19-
| `/home` | Teleport to 'home' |
20-
| `/home <name>` | Teleport to named home |
21-
| `/homes` | List all your saved homes |
22-
| `/delhome <name>` | Delete a saved home |
23-
| `/homehelp` | Show help and setup guide |
14+
---
2415

25-
## Permissions
16+
## Features
2617

27-
| Permission | Description |
28-
|------------|-------------|
29-
| `homes.use` | Basic access to home commands |
30-
| `homes.limit.1` | Allow 1 home (default if no limit set) |
31-
| `homes.limit.3` | Allow 3 homes |
32-
| `homes.limit.5` | Allow 5 homes |
33-
| `homes.limit.unlimited` | Unlimited homes |
34-
| `homes.bypass.warmup` | Skip the 3-second teleport delay |
18+
- **Multiple Homes** - Save spots like "base", "mine", "farm" and teleport between them
19+
- **Easy Limits** - Choose how many homes players can have
20+
- **Teleport Delay** - Optional countdown before teleporting (stops combat logging)
21+
- **Simple Setup** - Configure everything in-game, no files to edit
3522

36-
## Installation
23+
---
3724

38-
1. Build the plugin:
39-
```bash
40-
mvn clean package
41-
```
25+
## Player Commands
4226

43-
2. Copy `target/HomeEssentials-1.0.0.jar` to your server's `mods/` folder
27+
| Command | What it does |
28+
|---------|--------------|
29+
| `/sethome` | Save where you're standing as "home" |
30+
| `/sethome base` | Save where you're standing as "base" |
31+
| `/home` | Teleport to "home" |
32+
| `/home base` | Teleport to "base" |
33+
| `/homes` | See all your saved homes |
34+
| `/delhome base` | Delete "base" |
35+
| `/homehelp` | Show help |
4436

45-
3. Start/restart the server
37+
---
4638

47-
## Quick Setup
39+
## Server Owner Setup
4840

49-
Run these commands in the server console to set up basic permissions:
41+
### Step 1: Let players use homes
5042

43+
Run this in your console:
5144
```
52-
perm group add default homes.use
53-
perm group add default homes.limit.1
45+
perm group add Adventure homes.use
5446
```
5547

56-
For VIP players with more homes:
48+
Done! Players can now use `/sethome` and `/home`.
49+
50+
### Step 2: Choose how many homes players get
51+
52+
**Want everyone to have 3 homes?**
5753
```
58-
perm group add vip homes.use
59-
perm group add vip homes.limit.3
54+
/easyhome admin set default 3
6055
```
6156

62-
For admins with unlimited homes:
57+
**Want to turn off the teleport delay?**
6358
```
64-
perm group add admin homes.use
65-
perm group add admin homes.limit.unlimited
59+
/easyhome admin set warmup 0
60+
```
61+
62+
**Want instant teleport for admins only?**
6663
```
64+
perm group add admin homes.bypass.warmup
65+
```
66+
67+
---
6768

68-
## Usage Examples
69+
## Admin Commands
6970

70-
**Save your first home:**
71+
### See your current settings
7172
```
72-
/sethome
73+
/easyhome admin config
7374
```
7475

75-
**Save a home called "base":**
76+
### Change how many homes everyone gets
7677
```
77-
/sethome base
78+
/easyhome admin set default 5
7879
```
7980

80-
**Teleport home:**
81+
### Change the maximum homes allowed
8182
```
82-
/home
83+
/easyhome admin set max 25
8384
```
8485

85-
**Teleport to "base":**
86+
### Change the teleport delay
8687
```
87-
/home base
88+
/easyhome admin set warmup 5
8889
```
90+
Set to `0` for instant teleport.
8991

90-
**See all your homes:**
92+
### Turn permission-based limits on/off
9193
```
92-
/homes
94+
/easyhome admin set permissions off
9395
```
96+
When OFF: Everyone gets the same number of homes.
97+
98+
When ON: You can give different groups different limits using permissions.
99+
100+
---
101+
102+
## Giving Different Groups Different Limits
94103

95-
**Delete a home:**
104+
Want VIPs to have more homes than regular players? Here's how:
105+
106+
**First, turn on permission mode:**
107+
```
108+
/easyhome admin set permissions on
96109
```
97-
/delhome base
110+
111+
**Then set up your groups:**
98112
```
113+
perm group add Adventure homes.use
114+
perm group add Adventure homes.limit.1
99115
100-
## Data Storage
116+
perm group add vip homes.use
117+
perm group add vip homes.limit.5
101118
102-
Player homes are stored as JSON files in `mods/Community_HomeEssentials/homes/`:
119+
perm group add admin homes.use
120+
perm group add admin homes.limit.unlimited
121+
perm group add admin homes.admin
103122
```
104-
homes/
105-
├── <player-uuid-1>.json
106-
├── <player-uuid-2>.json
107-
└── ...
123+
124+
Now regular players get 1 home, VIPs get 5, and admins get unlimited!
125+
126+
---
127+
128+
## All Permissions
129+
130+
| Permission | What it does |
131+
|------------|--------------|
132+
| `homes.use` | Can use home commands |
133+
| `homes.admin` | Can use `/easyhome admin` |
134+
| `homes.limit.1` | Can have 1 home |
135+
| `homes.limit.3` | Can have 3 homes |
136+
| `homes.limit.5` | Can have 5 homes |
137+
| `homes.limit.10` | Can have 10 homes |
138+
| `homes.limit.25` | Can have 25 homes |
139+
| `homes.limit.50` | Can have 50 homes |
140+
| `homes.limit.unlimited` | Can have max homes |
141+
| `homes.bypass.warmup` | Teleports instantly (no delay) |
142+
143+
---
144+
145+
## Common Questions
146+
147+
### "How do I give everyone 3 homes without messing with permissions?"
148+
```
149+
/easyhome admin set default 3
150+
/easyhome admin set permissions off
151+
```
152+
153+
### "Players say teleporting takes too long"
154+
```
155+
/easyhome admin set warmup 0
108156
```
109157

110-
## Requirements
158+
### "A player says they can't set more homes"
159+
Either increase the default limit:
160+
```
161+
/easyhome admin set default 5
162+
```
163+
Or give them a higher permission:
164+
```
165+
perm user add PlayerName homes.limit.10
166+
```
111167

112-
- Hytale Server
113-
- Java 25
168+
---
114169

115170
## License
116171

117-
MIT License - Feel free to modify and distribute.
172+
MIT - Use it however you like!

‎pom.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
55
<modelVersion>4.0.0</modelVersion>
66

7-
<groupId>com.homeessentials</groupId>
8-
<artifactId>HomeEssentials</artifactId>
7+
<groupId>com.easyhome</groupId>
8+
<artifactId>EasyHome</artifactId>
99
<version>1.0.0</version>
1010
<packaging>jar</packaging>
1111

12-
<name>HomeEssentials</name>
13-
<description>User-friendly home management plugin for Hytale</description>
12+
<name>EasyHome</name>
13+
<description>Let players save locations and teleport back instantly</description>
1414

1515
<properties>
1616
<maven.compiler.source>25</maven.compiler.source>
@@ -72,7 +72,7 @@
7272
<configuration>
7373
<archive>
7474
<manifest>
75-
<mainClass>com.homeessentials.HomeEssentials</mainClass>
75+
<mainClass>com.easyhome.EasyHome</mainClass>
7676
</manifest>
7777
</archive>
7878
</configuration>

0 commit comments

Comments
 (0)