Cobblemon Spawn Alerts
Активный0.0
Установок
0
Последнее обновление
2 недели назад
Версии
1.21.1
Клиент
Fabric
Neoforge
Игровые механики
Утилиты
Аддоны
Cobblemon Spawn Alerts
A highly customizable Cobblemon sidemod to alert you when a certain Pokemon spawns
IMPORTANT:
Some Pokemon info may not display properly if you are on a server! Servers can optionally install this mod to broadcast this info to clients if they desire, also with a config of its own. If a server does not have this mod installed, then things will not display correctly.
Also, while the serverside mod is optional, all clients must have the mod if the server does.
No more staring at the minimap!
Have you ever been hunting for an ultra-rare, and as you're flying around your eyes are too focused on reading each Pokemon's name that you miss something? Well with this mod, you can simply receive a message in chat when the Pokemon spawns instead! The config is a JSON file that is very easy to edit and add any Pokemon you want.
Complete the Pokedex!
By simply editing the config, you can be alerted whenever an unregistered or uncaught Pokemon spawns near you!
Customizability!
Each Pokemon can be individually customized exactly to your needs. If you want to shiny hunt for a Ralts while making sure you don't miss out on any beautiful Bidoofs (i love bidoof), you can do that. Messages use MiniMessage formatting to easily color or format messages however you like (see the MiniMessage docs).
The default message looks like this:
But can be modified to look like this, or however you want!
Global Alerts!
Inspired by Cobblemon Spawn Notification, all players will be alerted when a rare Pokemon (such as a shiny or legendary) spawns. This can be disabled in the server's server.json config for the mod. The server simply sends a packet to all clients, so that each player can individually customize their messages.
Config:
Config - Main (client)
The config is found in your Minecraft instance folder under `config -> cobblemon-spawn-alerts`. You can also use the command `/cobblemonspawnalerts openconfig`.This file is called `main.json` ### Config Settings:
* **alertAllShinies**: Alerts you when any shiny spawns, unless `alertShiny` is disabled in its config, or its config is disabled.
* **alertAllLegendaries**: Alerts you when any legendary spawns, unless its config is disabled.
* **alertAllMythicals**: Alerts you when any mythical spawns, unless its config is disabled.
* **alertAllUltraBeasts**: Alerts you when any ultra beast spawns, unless its config is disabled.
* **alertAllParadox**: Alerts you when any paradox spawns, unless its config is disabled.
* **alertAllNotInDex**: Alerts you when any Pokemon which is not already registered in your Pokedex spawns, unless its config is disabled.
* **alertAllUncaught**: Alerts you when any Pokemon which you have not caught spawns, unless its config is disabled.
* **alertEverything**: Alerts you to every single spawn near you, unless its config is disabled. Why would you want to do this? Idk. For IV/EV hunting, see the IV/EV Hunting tab under Config ### Reloading the Config:
You can edit the config while the game is running, and simply use the command `/cobblemonspawnalerts reload` to reload it. Leaving/entering a world will **NOT** reload the config. The command must be run to take effect.
Config - Pokemon (client)
The config is found in your Minecraft instance folder under `config -> cobblemon-spawn-alerts`. You can also use the command `/cobblemonspawnalerts openconfig`.`pokemon.json` is where the bulk of the config is at. By default, the config will come with a default set of options that will be applied to any alert for a Pokemon that is not added to the config. **DO NOT DELETE OR RENAME THIS.** You can freely edit its contents, but leave the name as it is *exactly*. You can copy the formatting and change the name of the Pokemon to add a new spawn message for any other Pokemon.
### Config Parameters:
The name of each Pokemon's config can be formatted like "x, y, z" to include multiple Pokemon. E.g. "charmander, charmeleon, charizard" will alert to the whole Charmander line. * **enabled**: Enables the spawn message for the Pokemon. If set to false, this setting will override every other config setting for the Pokemon and make its spawn message never display. * **alwaysAlert**: Whether to always alert the Pokemon's spawn message, assuming enabled is set to true. Setting this to false will only display a spawn message given some other condition is true (e.g. alertShiny). * **alertShiny**: Whether to alert a shiny Pokemon, or if the Pokemon is shiny. If alwaysAlert is set to false, this will ONLY alert that Pokemon's spawn if it is shiny. If alwaysAlert is set to true, then it will simply specify if the spawned Pokemon is shiny. * **showLegendary**: Shows whether the Pokemon is legendary, mythical, paradox, or ultra beast. * **customAlertMessage**: Used to create a custom alert message for a Pokemon using [MiniMessage](https://docs.advntr.dev/minimessage/format.html) format.
The following are a sub category of the config for displaying certain info about a Pokemon. These have 3 options -- `"MAIN_MESSAGE"`, `"HOVER"`, and `"DISABLED"`: * **level**: Shows the Pokemon's level. * **ivs**: Lists the Pokemon's IVs in order of HP/Atk/Def/Sp.Atk/Sp.Def/Speed. * **evs**: Lists the Pokemon's EV Yield in order of HP/Atk/Def/Sp.Atk/Sp.Def/Speed. * **nature**: Shows the Pokemon's nature. * **ability**: Shows the Pokemon's ability. * **gender**: Shows the Pokemon's gender. * **coordinates**: Shows the Pokemon's coordinates (x/y/z).
* **biome**: Shows the biome the Pokemon spawned in.
You will also see sounds listed below the stat displays. See the Custom Sounds tab under Config. ### Examples:
Show all stats in message:
```json "bidoof": { "enabled": true, "alwaysAlert": true, "alertShiny": true, "showLegendary": true, "statDisplayModes": { "level": "MAIN_MESSAGE", "ivs": "MAIN_MESSAGE", "evs": "MAIN_MESSAGE", "nature": "MAIN_MESSAGE", "ability": "MAIN_MESSAGE", "gender": "MAIN_MESSAGE", "coordinates": "MAIN_MESSAGE", "biome": "MAIN_MESSAGE" }, "customAlertMessage": "" ...other config stuff }, ```  Show all stats in hover:
```json "bidoof": { "enabled": true, "alwaysAlert": true, "alertShiny": true, "showLegendary": true, "statDisplayModes": { "level": "HOVER", "ivs": "HOVER", "evs": "HOVER", "nature": "HOVER", "ability": "HOVER", "gender": "HOVER", "coordinates": "HOVER", "biome": "HOVER" }, "customAlertMessage": "" ...other config stuff }, ``` 
Full template example
```json { "configVersion": 1.7, "pokemonConfigs": { "default (You can modify anything BELOW this, but dont delete it!)": { "enabled": true, "alwaysAlert": true, "alertShiny": true, "showLegendary": true, "statDisplayModes": { "level": "HOVER", "ivs": "HOVER", "evs": "HOVER", "nature": "HOVER", "ability": "HOVER", "gender": "HOVER", "coordinates": "HOVER", "biome": "HOVER" }, "customAlertMessage": "", "sounds": { "shiny": "", "legendary": "", "mythical": "", "ultrabeast": "", "paradox": "", "unregistered": "", "uncaught": "" }, "customAlertSound": "" }, "charmander, charmeleon, charizard": { "enabled": true, "alwaysAlert": true, "alertShiny": true, "showLegendary": true, "statDisplayModes": { "level": "MAIN_MESSAGE", "ivs": "MAIN_MESSAGE", "evs": "MAIN_MESSAGE", "nature": "MAIN_MESSAGE", "ability": "MAIN_MESSAGE", "gender": "MAIN_MESSAGE", "coordinates": "MAIN_MESSAGE", "biome": "MAIN_MESSAGE" }, "customAlertMessage": "", "sounds": { "shiny": "", "legendary": "", "mythical": "", "ultrabeast": "", "paradox": "", "unregistered": "", "uncaught": "" }, "customAlertSound": "" } } } ```Config - Templates (client)
The config is found in your Minecraft instance folder under `config -> cobblemon-spawn-alerts`. You can also use the command `/cobblemonspawnalerts openconfig`.`message_templates.json` is where you can find and edit the default messages, and message parts. These apply to EVERY spawn, with the exception of `fullSpawnMessage`, which is only used when a custom spawn message is not provided. These templates are what replace the dynamic replacement placeholders.
### Finding the Default Templates:
The default values for the templates are found in your Minecraft instance's language file for the mod.
The defaults for en_us.json (the only currently added language)
```json { "cobblemon-spawn-alerts.client_config_reloading": "When modifying templates, keep in mind the spacing and parameters. `%s` is used internally to insert values, and the amount of them **MUST** match the default template. For example, if you are modifying the template for IVs, your new template must have EXACTLY 6 `%s` - no more, no less. These also insert values in order, so unfortunately changing the order of IVs or coordinates is currently impossible.
**Note:** Some of the default templates have spaces in them to make formatting work properly, so just be aware of that if you are modifying a template.
### Examples:
Change the shiny color for all Pokemon:
```json "shiny": "
Change the default spawn message for all Pokemon: ```json "fullSpawnMessage": "
Config - Server
The config is found in your server folder under `config -> cobblemon-spawn-alerts`. You can also use the command `/cobblemonspawnalerts openconfig` in singleplayer.This file is called `server.json` ### Config Settings:
* **alertShinies**: Alerts all players on the server when a shiny spawns.
* **alertLegendaries**: Alerts all players on the server when a legendary spawns.
* **alertMythicals**: Alerts all players on the server when a mythical spawns.
* **alertUltraBeasts**: Alerts all players on the server when a ultra beast spawns.
* **alertParadox**: Alerts all players on the server when a paradox spawns.
* **broadcastIVs**: Tells clients what IVs a spawned Pokemon has.
* **broadcastEVs**: Tells clients what EV Yield a spawned Pokemon has.
* **broadcastNature**: Tells clients what Nature a spawned Pokemon has.
* **broadcastAbility**: Tells clients what Ability a spawned Pokemon has.
**Note:** Disabling these on your client instance will also stop things from displaying properly in singleplayer... so don't do that? ### Reloading the Config:
You can edit the config while the game is running, and simply use the command `/cobblemonspawnalerts-server reload` to reload it. You must have permission level 3 (OP) or higher to use this command.
Custom Alert Messages
Custom alert messages can utilize dynamic replacement to include info about the Pokemon. Currently, the available dynamic replacements are: * **{name} / {name_lower} / {name_upper}**: Inserts the Pokemon's name * **{legendary} / {legendary_unformatted}**: Inserts the Pokemon's rarity (legendary/mythical/ultra beast/paradox) if `showLegendary` is enabled * **{shiny} / {shiny_unformatted}**: Inserts a shiny message if the Pokemon is shiny and `alertShiny` is enabled * **{level} / {level_unformatted}**: Inserts the Pokemon's level if enabled * **{ivs} / {ivs_unformatted}**: Inserts the Pokemon's IVs if enabled * **{evs} / {evs_unformatted}**: Inserts the Pokemon's EV Yield if enabled * **{nature} / {nature_unformatted}**: Inserts the Pokemon's nature if enabled * **{ability} / {ability_unformatted}**: Inserts the Pokemon's ability if enabled * **{gender} / {gender_unformatted}**: Inserts the Pokemon's gender if enabled * **{coords} / {coords_unformatted}**: Inserts the Pokemon's coordinates if enabled * **{biome} / {biome_unformatted}**: Inserts the biome the Pokemon spawned if enabled * **{nearest_player} / {nearest_player_unformatted}**: Inserts the name of the nearest player to the spawned Pokemon if enabled * **{despawned}**: Inserts the Pokemon's despawn message for despawn, captured, and fainted respectively. This probably shouldn't be used though. ### Examples:Creating a custom alert message:
```json "bidoof": { "enabled": true, "alwaysAlert": true, "alertShiny": true, "showLegendary": true, "statDisplayModes": { "level": "MAIN_MESSAGE", "ivs": "DISABLED", "evs": "DISABLED", "nature": "DISABLED", "gender": "DISABLED", "coordinates": "MAIN_MESSAGE", "biome": "DISABLED" }, "customAlertMessage": "
Custom Sounds
In your `pokemon.json` configs, custom spawn sounds can be added for a bunch of things, like shiny, legendary, or even whenever a Pokemon spawns at all. To get started with adding your own sounds, download the [resource pack template](https://github.com/StainlessStasis/CSA-Pack-Template) and drag it into your resource packs folder (you can open this in the menu in game).Inside the resource pack, start by adding your sound (**this must be `.ogg`!**) in `assets\minecraft\sounds\cobblemonspawnalerts`. Once you have your sounds added, edit `sounds.json` using whatever text editor -- Notepad++ is a great free option. In the file, you'll find a template for creating your own sounds. When adding a sound, you must begin with the name of the directory where the sounds are located. By default, this will be `cobblemonspawnalerts`. So, if you are adding a sound called `legendary.ogg`, you would add it like so:
```json "cobblemonspawnalerts.legendary": { "sounds": [ { "name": "cobblemonspawnalerts/legendary", "attenuation_distance": 0 } ] } ``` Also, an attenuation distance of 0 is set so that the sound stays a constant volume no matter your distance to the source. For more info, see the [Minecraft wiki page](https://minecraft.wiki/w/Sounds.json).
Next up is adding your sound in the config, which is super simple. Whatever your sound is called in the sounds file -- so `cobblemonspawnalerts.legendary` in this case -- you just put that directly in the config for whichever sound you desire. To add this sound for legendary spawns, it would be added like so: `"legendary": "cobblemonspawnalerts.legendary",`
Full template using the default sounds provided in the pack
This plays the Pokemon: Legends Arceus shiny sound when any shiny spawns ```json { "configVersion": 1.7, "pokemonConfigs": { "default (You can modify anything BELOW this, but dont delete it!)": { "enabled": true, "alwaysAlert": true, "alertShiny": true, "showLegendary": true, "statDisplayModes": { "level": "MAIN_MESSAGE", "ivs": "DISABLED", "evs": "DISABLED", "nature": "DISABLED", "ability": "DISABLED", "gender": "HOVER", "coordinates": "HOVER", "biome": "MAIN_MESSAGE" }, "customAlertMessage": "", "sounds": { "shiny": "cobblemonspawnalerts.your_sound_here", "legendary": "", "mythical": "", "ultrabeast": "", "paradox": "", "unregistered": "", "uncaught": "" }, "customAlertSound": "" } } } ```IV/EV Hunting
IV and EV hunting can be found in your `main.json` config. To prevent bloating of the Pokemon-specific configs, these apply to all spawns. This may be changed in the future if deemed necessary or is heavily requested.Let's start with IV hunting, as it is the more complicated of the two: * **requireAllMinimumsMet**: Requires all of the specified minimum stats to be met for an alert to trigger. For example, say `minHp` and `minAtk` are both set to 20, and a Pokemon spawns with 25 hp but only 10 atk. If this is enabled, then an alert will NOT trigger, since both conditions aren't met. If this is disabled, however, an alert will trigger since at least one of the conditions is met. (basically, if it's true it functions as an AND gate, and false, an OR gate) * **minPerfectIVs**: Requires at least x perfect IVs to trigger an alert For EV hunting, there is no equivalent of `requireAllMinimumsMet`. An alert will be triggered if any of the minimum conditions are true. So, if `minHp` and `minAtk` are both set to 1, then any Pokemon with an EV yield of at least 1 hp OR attack will trigger an alert.
Lastly, for both IV and EV hunting, anything set to 0 will be ignored when determining whether to alert. This means you can safely leave any stats you don't care about at 0 and it will not falsely alert.
More to come!
I currently plan to add the following:
- Ability/HA hunting
- Nature hunting
I may also add these, but I'm unsure:
- Alert to specific type or egg group
- Alert to specific spawn bucket (unsure if possible, but very likely to add if so)
- Ability to edit config in game
If you have any other ideas, feel free to share them with me!
Feedback | Contact me
You can contact me on Discord; my username is stasis_the_shattered. You can find me in the Cobblemon discord in #content-zone-help and search for Cobblemon Spawn Alerts. Or, if you'd like, message me directly. I'm looking to make this mod as polished as I can, so hit me up with any bugs or suggestions.
Участники проекта
StasisTheShattered
Разработчик
