Speedrace3

A Minecraft Paper plugin that allows server administrators to organize speed races where players compete to reach a specific location.

Features

• Start races at specific X/Z coordinates with customizable radius
• Broadcasts player arrival messages with their rank
• Configurable particle effects to mark the destination area

Commands

Command	Description	Permission
/speedrace3 start <x> <z> [radius]	Start a new race at coordinates X/Z with optional radius	speedrace3.admin
/speedrace3 stop	Stop the current race	speedrace3.admin
/speedrace3 query	Check the status of the current race	speedrace3.query
/speedrace	Alias for /speedrace3	-
/spr	Short alias for /speedrace3	-

Permissions

Permission	Description	Default
speedrace3.admin	Allows access to race management commands (start/stop)	OP
speedrace3.query	Allows checking race status	All players

Configuration

The plugin's configuration file (config.yml) can be found in the plugin directory. Here are the available options:

# Accepted maximum Chebyshev distance to the center
default-offset-radius: 8.0

particles:
  enabled: false
  # Namespaced key
  type: minecraft:end_rod
  # Per block
  count: 3
  # Possible options: `edge`, `all`
  position: edge
  # Force display on clients
  force: true
  interval: 60  # ticks
  height: 10  # blocks

lang: en

Configuration Details

• default-offset-radius: The default radius for race areas when not specified in the start command. Minimum value is 1.0.

• particles.enabled: Whether to show particle effects around the race area.

• particles.type: The particle type to use. Must be a valid Minecraft particle namespaced key (e.g., minecraft:end_rod, minecraft:firework).

• particles.count: Number of particles to spawn per block in the area.

• particles.position: Where to place particles:

  • edge: Only on the edges of the race area
  • all: Throughout the entire race area

• particles.force: Whether to force particles to be visible to all players, even if they're far away.

• particles.interval: How often (in ticks) to update the particle effects. Minimum value is 10 ticks.

• particles.height: The height (in blocks) at which particles should appear.

• lang: The language to use for plugin messages:

  • en: English
  • zh: Chinese

Game Mechanics

1. Race Setup: Admins use /speedrace3 start <x> <z> [radius] to define a race area
2. Player Participation: All online players automatically participate in the race
3. Winning Condition: Players must reach within the specified radius around the target coordinates
4. World Restriction: Only the overworld is considered for race completion
5. Arrival Tracking: Players are marked as arrived once they enter the area, and their arrival is broadcast to all players
6. Race End: Admins can stop the race at any time using /speedrace3 stop

Compatibility

• Minecraft Version: 1.21.4+
• Server Software: PaperMC only (not compatible with Spigot or Bukkit)

Development

To compile the plugin yourself:

1. Clone this repository
2. Run ./gradlew build
3. The compiled JAR will be in the build/libs directory

Support

If you encounter any issues or have questions, please:

1. Check the plugin's configuration
2. Ensure you're using a compatible Minecraft and Paper version
3. Look for similar issues on the project's issue tracker

License

This plugin is released under the Apache 2.0 License.

Credits

• Author: teddyxlandlee