Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/idreesinc/celeste

Add shooting stars to your Minecraft server with this Spigot Plugin 💫
https://github.com/idreesinc/celeste

bukkit minecraft spigot

Last synced: about 2 months ago
JSON representation

Add shooting stars to your Minecraft server with this Spigot Plugin 💫

Awesome Lists containing this project

README 

        
# Celeste - Add shooting stars to your Minecraft server

Celeste is a simple plugin that adds shooting stars to your Minecraft server. Inspired by the shooting stars from Animal Crossing and the falling stars from Breath of the Wild, this plugin brings some celestial ambience to your Minecraft world.



[Check out the overview video](https://www.youtube.com/watch?v=TXdrECjVTiU)



[Download the server plugin on Spigot](https://www.spigotmc.org/resources/celeste.81862/)



[Learn more about Celeste (the plugin, not the owl)](https://idreesinc.com/about-celeste.html?utm_source=github&utm_medium=readme&utm_campaign=celeste)



## Features

- Add shooting stars to the night sky, with configurable frequency

- Find rare falling stars that deliver precious materials in a sparkling package

- Watch meteor showers that occur every new moon, increasing the rate of shooting and falling stars



![Shooting stars and a falling star in the corner](/images/meteor_shower.gif)



### Shooting stars

Shooting stars occur once every 10 seconds by default (6 times a minute), but due to how large the area around a player is, you would usually only see one every few minutes unless you were stargazing. They have no functional purpose and are only there to sparkle and look pretty.

To more accurately emulate real world meteors, these virtual shooting stars vary in speed, length, and can even break up into multiple parts while burning up!



![Falling star](/images/falling_star_close.gif)



### Falling stars

Inspired by the star fragments from The Legend of Zelda: Breath of the Wild, these rare stars are fall from the sky only once or twice a night! They are marked by a streak of light and resonating sound as they fall towards the earth, and once they land the stars spark and sizzle for 10 seconds by default to help players find them. They can be easy to miss, with players only knowing one has fallen by the distinctly resonating sound they make on impact. But if a player is lucky enough to find one, they may receive a rare treasure as well as some experience! This loot is completely customizable, and the documentation for that can be found further below.



## In-Depth Functionality

Shooting stars and falling stars spawn on a per-world basis. This means that the number of players in a world does not affect the spawning rate. When either type of star is given a chance to spawn, the plugin will find a random player within that world and center the spawn in a large radius around said player, in order to avoid sending stars to unloaded chunks where they would never be found.

Additionally, the worlds that shooting and falling stars can spawn in must meet the following conditions:

- Must have players in the world currently

- Must be nighttime (between 13000 and 23000 in game time by default, but this can be configured)

- Must be clear weather (no rain or snow)

- Will not spawn in the nether or end by default



## Configuration

Installation is as simple as copying the newest build jar to your plugins folder. A configuration file is created by default, but if the file was created previously it may not include default values that were added in later updates. These values can be added easily by just copying and pasting the particular lines from the defaults below.

### Defaults

``` yaml

# Whether to perform an update check when starting or reloading the plugin

check-for-updates: true

# Whether to spawn shooting stars or not

shooting-stars-enabled: true

# Whether to spawn falling stars or not

falling-stars-enabled: true

# When to begin spawning shooting and falling stars

begin-spawning-stars-time: 13000

# When to stop spawning shooting and falling stars

end-spawning-stars-time: 23000

# The average number of shooting stars to create per minute for each world

shooting-stars-per-minute: 6

# The minimum y level where a shooting star can spawn

shooting-stars-min-height: 130

# The "maximum" y level where a shooting star can spawn

# Note that shooting stars will always spawn at least 50 blocks above a player which can overrule this limit

shooting-stars-max-height: 160

# The average number of falling stars to create per minute for each world

falling-stars-per-minute: 0.2

# The maximum distance around a player within which a falling star may spawn

falling-stars-radius: 75

# Whether falling stars should play a sound when falling

falling-stars-sound-enabled: true

# The volume at which falling star sounds should play

# Note that this maxes out at 1.0, with anything more increasing range by a factor of ~15 blocks per step

falling-stars-volume: 6

# How many ticks a falling star should spark for once it has landed (20 ticks is a second)

falling-stars-spark-time: 200

# How many experience points (not levels) to provide from catching a falling star

falling-stars-experience: 100

# The possible loot from a falling star, and the weighted chance of each item appearing

falling-stars-loot:

  diamond: 60

  emerald: 20

  fire_charge: 20

# Whether to have meteor showers on nights with a new moon, increasing the spawn rates

new-moon-meteor-shower: true

# The number of shooting stars to create per minute during meteor showers

shooting-stars-per-minute-during-meteor-showers: 15

# The number of falling stars to create per minute during meteor showers

falling-stars-per-minute-during-meteor-showers: 0.3

# The message to send in response to summoning a shooting star

shooting-stars-summon-text: "Make a wish!"

# The message to send in response to summoning a falling star

falling-stars-summon-text: "Make a wish!"

# Enables debug mode, which adds log messages for shooting and falling stars among other things

debug: false

```

### Falling Star Loot

Falling stars drop loot wherever they fall, and spark for 10 seconds (200 ticks) by default to show their location. The loot they drop is randomly selected from the loot table in the config, with each material being given a weight. For instance, in the default config, there is a 60% chance for a diamond, 20% of an emerald, and 20% chance of a fire_charge. Experience also drops from falling stars, 100 points (not levels) by default.



**You have the option of defining a simple list of items in the config or using Minecraft's built-in [loot table](https://minecraft.fandom.com/wiki/Loot_table) system.** The config-based loot system is simpler as it doesn't require messing with data packs, but it is limited to only one item at a time and is unable to produce items with NBT data attached. For more advanced loot, you'll probably want to use loot tables. Note that both kinds of loot configurations can be used at the same time if you wish to do so for whatever reason.



#### Simple Config-Based Loot



To define a simple list of potential loot that can appear, add the `falling-stars-loot` attribute to your config (remember, you will have to create the plugin config if it doesn't already exist) and list each item you want as well as the probability for it to appear. **The names of the items must be from the list provided [here](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html)**. Remember to only add materials available in your server version. Using this method, only one item will spawn at a time. If you want to spawn more items at once or add NBT data to the items spawned, you'll need to use loot tables (more on that below).



Here is an example of a custom config-based loot configuration:



``` yaml

falling-stars-loot:

  nether_star: 0.05

  apple: 33

  blaze_spawn_egg: 33

  blue_orchid: 33

 ```



 #### Loot Tables



Using Minecraft's built-in loot table feature, you can fully customize the type of items dropped, the number of items, and add whatever metadata you want. The catch is that loot tables are much more complex and require messing with external data files. [This](https://minecraft.tools/en/loots.php) tool can make it easier to work with loot tables, and a special thanks to [@Trico-Everfire](https://github.com/Trico-Everfire) for this feature's inclusion.



Here is an example of how to use a built-in loot table for the falling star drops:



``` yaml

falling-stars-loot-table: "minecraft:chests/simple_dungeon"

 ```



### Custom World Settings



If you would like to use different settings for particular worlds, you can use the `world-overrides` attribute in your config. World overrides give you the ability to easily change the plugin's functionality on a per-world basis. The following is an example of a config that has different settings for certain worlds:



``` yaml

falling-stars-spark-time: 200

falling-stars-experience: 100

falling-stars-loot:

  diamond: 60

  emerald: 20

  fire_charge: 20

# These settings override the above global settings for the specified worlds

world-overrides:

  some_world:

    falling-stars-enabled: false

  another_world:

    falling-stars-loot-table: "minecraft:chests/simple_dungeon"

    falling-stars-experience: 300

    

```



In the above example, the worlds "some_world" and "another_world" have properties that override the global settings. For instance, falling stars are disabled in "some_world" and a loot table is used in place of the simple loot config for "another_world". Any worlds not mentioned in the `world-overrides` section will continue to follow the global configs or use built in defaults if the attribute is unchanged.



## Commands

**/shootingstar [player]**  summons a shooting star in the sky directly above the player. If no player is given, spawns one above the summoner.  

*Permission: celeste.shootingstar*



**/fallingstar [player]** summons a falling star directly above the player. If no player is given, spawns one above the summoner.  

*Permission: celeste.fallingstar*



**/celeste reload** reloads the config file, recalculates the falling star loot, and checks for updates (if enabled)  

*Permission: celeste.reload*



**/celeste info** displays if shooting stars, falling stars, and meteor showers are enabled  

*Permission: celeste.info*