Skip to content

Commit 293f8e6

Browse files
update readme to be clearer and include more information
1 parent 3adb2b2 commit 293f8e6

File tree

1 file changed

+29
-10
lines changed

1 file changed

+29
-10
lines changed

README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,39 @@
22
Set up custom spawns points and modify the loot from animals.
33

44
## Features
5-
- Modify the loot dropped by animals on death.
6-
- Set up custom spawn points for animals with a specific radius and respawn time.
5+
- Modify the loot dropped by animals on death
6+
- Set up custom spawn points for animals
7+
- Limit the radius of how far animals can walk away from their spawn point
8+
- Set exactly how long it takes for an animal to respawn after death
79

8-
When **CustomSpawns** are enabled the following Config.json settings are ignored or overridden:
9-
- `Respawn_Time`
10-
- `Max_Instances_Tiny`, `Max_Instances_Small`, `Max_Instances_Medium`, `Max_Instances_Large`, `Max_Instances_Insane`
10+
## Notes
11+
The following **Config.json** settings are ignored or overridden when plugin is installed and **CustomSpawns** is set to **true**.
12+
13+
```json
14+
"Animals": {
15+
"Respawn_Time": 180.0, // ignored
16+
"Damage_Multiplier": 0.75,
17+
"Armor_Multiplier": 1.25,
18+
"Max_Instances_Tiny": 4, // ignored
19+
"Max_Instances_Small": 8, // ignored
20+
"Max_Instances_Medium": 16, // ignored
21+
"Max_Instances_Large": 32, // ignored
22+
"Max_Instances_Insane": 64, // ignored
23+
"Weapons_Use_Player_Damage": false
24+
}
25+
```
1126

1227
## Commands
13-
- `/setanimalspawn <animal> [maxRadius] [respawnTime]` - Set a custom spawn point for an animal.
14-
- `/removeanimalspawns [radius]` - Remove all custom animal spawn points in a radius.
15-
- `/tpanimal <animal>` - Teleport to a random animal.
16-
- `/rocket reload AnimalManager` - Reload the configuration. Not recommended with **CustomSpawns** enabled.
28+
- `/setanimalspawn <animal> [maxRadius] [respawnTime]` - Set a custom spawn point for an animal. Max radius is specified in meters and respawn time is in seconds.
29+
Example: `/setanimalspawn cow 100 600`
30+
31+
- `/removeanimalspawns [radius]` - Remove all animal spawns in a radius from where you are standing.
32+
Example: `/removeanimalspawns 100`
33+
34+
- `/tpanimal [animal]` - Teleport to a random or specified animal.
35+
Example: `/tpanimal cow`
1736

1837
## Configuration
19-
### AnimalManager.Configuration.xml
2038
```xml
2139
<?xml version="1.0" encoding="utf-8"?>
2240
<AnimalManagerConfiguration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
@@ -75,6 +93,7 @@ When **CustomSpawns** are enabled the following Config.json settings are ignored
7593
```
7694

7795
### AnimalSpawns.Washington.xml
96+
This configuration will generate automatically if it doesn't exist with all the original animal spawn points from the map. If you want to remove them, just use `/removeanimalspawns 999999` in-game to remove all the spawns.
7897
```xml
7998
<?xml version="1.0" encoding="utf-8"?>
8099
<AnimalSpawnsConfiguration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

0 commit comments

Comments
 (0)