Skip to content

Commit fc283af

Browse files
author
ProSureString
committed
Merge remote-tracking branch 'origin/master'
2 parents 405641b + f14b86a commit fc283af

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed

README.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# ServerTimer
2+
3+
A Minecraft Bukkit/Spigot plugin that provides ab SMP start sequence with countdown timers, world border management, and grace period functionality.
4+
5+
## Features
6+
7+
- **Customizable World Border**: Set the initial and target world border size
8+
- **Game Start Countdown**: Visual countdown with boss bar and chat notifications
9+
- **Grace Period**: Configurable PvP-free grace period after game start
10+
- **Visual Feedback**: Boss bar timers, title announcements, and sound effects
11+
- **Multi-World Support**: Works across all server worlds
12+
13+
## Commands
14+
15+
### `/startserver <BorderSize> <StartDuration> <GraceDuration>`
16+
17+
Initiates the server start sequence with the specified parameters:
18+
19+
- `BorderSize`: The target size (in blocks) that the world border will expand to
20+
- `StartDuration`: The countdown duration (in minutes) before the game starts
21+
- `GraceDuration`: The grace period duration (in minutes) during which PvP is disabled
22+
23+
Example: `/startserver 3000 5 10` - Sets a 5-minute start countdown, expands the border to 3000 blocks whne the start countdown ends, and sets a 10-minute grace period after.
24+
25+
## Sequence Overview
26+
27+
1. **Initialization**:
28+
- PvP is disabled across all worlds
29+
- World border is set to a small initial size (20 blocks by default)
30+
- A countdown boss bar appears
31+
32+
2. **Start Countdown**:
33+
- The boss bar displays the remaining time until game start
34+
- Changes color from green to yellow at 1 minute remaining
35+
- Changes to red for the final 15 seconds
36+
- Final countdown (3-2-1) appears as title messages
37+
38+
3. **Game Start**:
39+
- "GO!!!" title appears
40+
- World border begins expanding to the target size
41+
- Grace period timer begins
42+
43+
4. **Grace Period**:
44+
- A pink boss bar displays the remaining grace period time
45+
- Changes to red for the final minute
46+
- PvP remains disabled during this period
47+
48+
5. **Full Game Start**:
49+
- PvP is enabled across all worlds
50+
- A notification appears to all players
51+
- Thunder sound plays to signify the end of the grace period (for dramatics)
52+
53+
## Installation
54+
55+
1. Download the ServerTimer.jar file
56+
2. Place it in your server's `plugins` folder
57+
3. Restart your server or use `/reload confirm`
58+
59+
## Configuration
60+
61+
~~The plugin uses a configuration file (`config.yml`) which is generated on first run.~~
62+
No config yet. The current configuration system doesn't work.
63+
64+
## Permissions
65+
66+
No special permissions are currently required to use the plugin commands.
67+
68+
## Requirements
69+
70+
- Bukkit/Spigot/Paper server
71+
- Minecraft version compatibility: [1.21.1+]
72+
73+
## Building from Source
74+
75+
1. Clone the repository
76+
2. Open in Intellij IDEA [Other IDEs untested but should work]
77+
3. Build using Maven: `mvn install`
78+
4. The compiled jar will be in the `target` folder
79+
80+
81+
## Support
82+
83+
For issues, feature requests, or questions, please [Contact ProSureString](https://discord.com/users/678287437583351808) on discord..
84+
85+
---
86+
87+
Created by ProSureString. All Rights Reserved

0 commit comments

Comments
 (0)