Mods / Particles Plus

Tags: #Graphics #QoL
Author: el_shift
Side: Client
Created: Jun 5th 2024 at 6:28 PM
Last modified: Nov 1st at 1:00 PM
Downloads: 23268
Follow Unfollow 647

Recommended download (for Vintage Story 1.21.0 and 1.21.5):
particlesplus-2.3.1.zip  1-click install


Note: If you used 1.x version before with custom config you will need to delete or rename it. 2.x will create new config file.

Demo Video

Features:

  • Add particles for clays, peat, meteoric iron, resin logs, high and pretta soil by default
  • GUI configuration: enable/disable particles, add new presets within the game ("P" key by default)
  • Toggle all active presets on/off from GUI or with hotkey ("CTRL + P" by default)
  • Add custom particles (requires config file editing)

 

Adding custom particles:

If you want to add custom particles you can do it in the mod's config. You should be familiar with:

  • JSON formating
  • Wildcards and Regex
  • AdvancedParticleProperties Class properties from VintageStory API.

 

Just follow default config format. I highly recommend to use Modding Tools by Maltiez for creating / exporting particles code.

 

Planned:

  • Particles managment (import, delete) in GUI
  • Renaming?
  • More particles options by default

 

☕💖If you want to say "Thank You" you can buy me a coffee <3

 

If you need any help you can reach me at Discord -> el_shift

 

 

Mod Version Mod IdentifierFor Game version Downloads Released Changelog Download 1-click mod install*
2.3.1 particlesplus 7479 Aug 1st at 2:03 PM particlesplus-2.3.1.zip 1-click install
  • Same as 2.3.0 compiled for 1.21 won't work with 1.20.x and older
2.3.0 particlesplus 2161 Aug 1st at 2:01 PM particlesplus-2.3.0.zip 1-click install
  • Added chat messages for errors / operations
  • Reduced font size for input fields
  • Added regex validation
2.2.0 particlesplus 878 Jul 23rd at 9:34 PM particlesplus-2.2.0.zip 1-click install

Default Config Changes:

  • Peat and Clay are disabled by default
  • Added new particles and presets for bonysoil and cracked vessels. Enabled by default

 

If you want those changes you will need to regenerate your config file

Global Toggle Feature:

  • Added ability to turn all Particle Plus presets on and off from GUI (little switch in titlebar) and by pressing Ctrl + P
2.0.1 particlesplus 902 Jul 15th at 6:31 PM particlesplus-2.0.1.zip 1-click install
  • Fixed GUI appear black when using with VintageSymphony
2.0.0 particlesplus 388 Jul 13th at 1:16 PM particlesplus-2.0.0.zip 1-click install
  • Restructured config for easier use (if you used external config prior 2.x you will need to delete / backup)
  • GUI dialog for presets configuration and toggle. ("P" key by default), can be changed in controls settings
1.2.1 particlesplus 5098 Feb 17th at 9:24 PM particlesplus-1.2.1.zip 1-click install
  • Added blue ember particles for suevite diamonds to default config.
1.1.1 particlesplus
1.20.0-rc.9 - 1.20.1
2987 Jan 10th at 8:29 AM particlesplus_1.1.1.zip 1-click install
  • Removed game dependancy version
  • Added icon
  • Cleaned up project files
1.1.0 particlesplus 3352 Jun 6th 2024 at 11:15 AM particlesplus_v1.1.0.zip 1-click install

Removed config file from ModConfig by default. For those who want to customize the particles / add their own please copy particlesplus.json from mod archive under assets/particlesplus/config/ to your ModConfig folder.

If you used previous versions, without modifying or adding anything in config file you can remove it in order to update particle effects.

97 Comments (oldest first | newest first)

💬 Mossling, 2 days ago

Can someone explain how editing the json file is meant to be done? I have been trying to add in copper and copied and pasted exactly what was described below, tried various other forms, made presents through the ingame GUI, but nothing happens. It repeatedly breaks the mod and nothing has particle effects as a result.

 

Image
image
💬 paulogabbi, 2 days ago

for some reason it stops working after some time

💬 MEHTOJIKA, 4 days ago

@Jotix Hi. Im pretty sure there is a mod called "Buzzword" to notify you about close beehives, plus hives have naturally visible particles around them

💬 Jotix, Nov 18th at 1:29 PM (modified Nov 18th at 1:29 PM)

hi, is possible add particles or like for bee hives ?
i look at code and try but cant find the wildcard for the beehives ;(

thansk for your time and work

💬 el_shift , Nov 1st at 12:58 PM

MushroomDot Azraile you can do all of that via config and particle editing yourself. I'm not feeling like investing anytime in it.

💬 MushroomDot, Oct 28th at 12:53 PM

nice mod, but would be nice for the particles to be a little less obvious. rn its a beacon

💬 Azraile, Oct 28th at 12:46 AM

some sugestions: 

add hight controls for particles,

add fire clay  (PLEASE)

add tree stumps PARTICUARLY with the fungus infection ... LOTS of partricals in the whole area for that for the wildcraft trees mod XD

💬 UncleBiff, Sep 20th at 12:58 AM

Is there a way to change the max height of the particles?

💬 Rui333, Sep 15th at 11:15 PM

Tried to do this for Primitive Survival's tree hollows but wasn't successful. Tried "treehollowgrown-*" for the wildcard. Any advice?

💬 Delta0010, Sep 8th at 7:06 AM

bintoss thanks mate 👍

💬 bintoss, Sep 8th at 1:05 AM

Delta0010 SHIFT+P or CTRL+P.

💬 Delta0010, Sep 5th at 2:25 PM

where can i find the configuration menu that appears in the 5th pic? been searching everywhere and i can't find it

 

💬 el_shift , Aug 28th at 2:36 AM (modified Sep 2nd at 1:52 PM)

Pamela this is HSVA (Hue, Saturation, Value, and Alpha), try get values here https://www.selecolor.com/en/hsv-color-picker/ last value is for alpha so it represents transparency. Little problem is that most pickers represent values in degrees for hue (360 max) and percentage for SV (100 max) while in game values are all in 8 bits (255 max) so you will need to use a bit of math there or use mods mentioned in the description. Example: 
Hue of 180 is picker would be 127 in game
Saturation or Value of 50% would be 127 in game

 

Hope that makes sense. 

💬 Pamela, Aug 28th at 12:30 AM

I would like to change the color of the clay particles, but can't figure out which numbers to change as RGB only has 3 numbers....
Can you please help?

💬 el_shift , Aug 27th at 1:34 AM

NylonCat no problem <3

💬 el_shift , Aug 27th at 1:33 AM

MoltenSlag this is client side only mod, there is no server side

💬 NylonCat, Aug 26th at 6:15 PM

Thank you for updating your mod so quickly, i'm playing with default settings/config and haven't encountered any issues.

💬 MoltenSlag, Aug 26th at 2:39 PM (modified Aug 26th at 2:44 PM)

So I appreciate the mod and really want to use it, but the current rate at which some of the particle types appear is a bit overwhelming. How can I adjust the particle rate? Thank you.

 

edit: so I scrolled down the comment section and saw you already answered this, but I have another question. How can I ensure that the changes are effective server-side, if they aren't by default? I'm running a small private server, so I could guide my players through the process, but I'd rather not have to if that's possible.

💬 el_shift , Aug 25th at 9:36 PM

pimblokto try treehollowplaced-*

💬 pimblokto, Aug 25th at 7:11 PM

They all start with primitivesurvival:treehollowplaced-(type)

💬 el_shift , Aug 25th at 11:07 AM

pimblokto with enabled debug info in creative for example. it will say "code" in block tooltip

💬 pimblokto, Aug 25th at 4:44 AM

I'm not sure how to find it, how can I do that?

💬 el_shift , Aug 25th at 3:09 AM

pimblokto its block id?

💬 pimblokto, Aug 24th at 11:42 PM

what could i add to the code make particles appear for the tree hollows from primitive survival?

💬 el_shift , Aug 19th at 5:06 PM

Laimfo_II you can't this is the game limitation 

💬 Laimfo, Aug 19th at 3:11 PM

The particles begin to appear at a distance of 40 blocks. How can I increase the distance?

💬 Okuromatsu, Aug 17th at 2:07 PM

For those who come after me :
Make sure your server time is not stopped

Thanks again el_shift for the debug :)

💬 el_shift , Aug 17th at 1:27 PM (modified Aug 17th at 1:31 PM)

Okuromatsu send me client-main.log and your particlesplus.json to discord.

💬 Okuromatsu, Aug 17th at 11:32 AM (modified Aug 17th at 11:34 AM)

@el_shift I know it's client side, the mod is only installed on my client but the particle won't show on the server only in solo. The mod is NOT installed on the server.
The GUI work in the server but no particle (event pressing ctrl P). I'm on 1.20.12 with 2.3.0 version of the mod

💬 el_shift , Aug 17th at 11:17 AM (modified Aug 17th at 11:23 AM)

Criticalhat  - "@looseores-(nativecopper|malachite)-(.*)" if you want to cover malachite ore as well

Okuromatsu - This is client side only mod, all particles client side only. You don't need to install this on the server side.

💬 Okuromatsu, Aug 17th at 10:37 AM (modified Aug 17th at 10:37 AM)

The mod work perfectly on solo but not on my custom private server and I don't know why, I can open the GUI but can't see any particles ;(
Do I miss any server side config ?

💬 Criticalhat, Aug 17th at 4:40 AM

Apologies if this is a dumb question, but what would the wildcard value need to be set to to mark surface copper bits?

💬 el_shift , Aug 12th at 3:55 PM (modified Aug 12th at 3:57 PM)

PeridotClod go to game settings and change it to whatever you want under controls. Any hotkey for any mod is reassignable by default in controls settings.

💬 PeridotClod, Aug 12th at 2:31 PM (modified Aug 12th at 2:31 PM)

Hi, couldn't it be useful to set the shortcut to another key than P, already used by ConfigLib, or at least add the shortcut key into the config JSON? Having to delete configlib to access the mod configuration seems inconvenient :/ ..

💬 Gerby, Aug 10th at 6:49 AM

Thank you

💬 el_shift , Aug 10th at 1:12 AM

Gerby enable debug in the game settings, check in creative? it should show it in block tooltip 

💬 Gerby, Aug 9th at 5:06 PM

How can you find the wildcard name for the blocks?

💬 Pamela, Jul 30th at 2:44 PM

Super!  Thanks so much!

💬 el_shift , Jul 29th at 5:02 PM (modified Jul 29th at 5:03 PM)

Pamela
1. Read https://wiki.vintagestory.at/index.php/Modding:Simple_Particles , Properties Overview section

2. Make copy of existing soil particles with different name in config

3. Adjust "HsvaColor" section

💬 Pamela, Jul 29th at 4:09 PM

I would like to change the color of the particles for clay, so I can tell them apart from soil.  Can you guide me through that??

💬 JustDavid, Jul 27th at 4:13 PM

@el_shift Thank you

💬 el_shift , Jul 27th at 3:27 PM

JustDavid just delete particlesplus.json and mod will recreate default one or add it back via GUI. Wildcard is "meteorite-iron"

💬 JustDavid, Jul 27th at 3:21 PM

I goofed and deleted meteoric iron and I have no idea how to add it back correctly. I don't know the Wildcard for it. Any help would be appreceated.

💬 el_shift , Jul 27th at 8:41 AM

Tanihk If you had 1.x config you will need to delete / backup the old one, otherwise mod will not load.

Send me the log from %APPDATA%\VintagestoryData\Logs\client-main.log to my Discord - el_shift.

 

💬 Tanihk, Jul 27th at 1:37 AM

For some reason this mod isnt working for me. It has in the past but now its not. I even deleted and redownloaded the mod. WWhen I press P it opens ConfigLib instead of this and if I change keybinds it still wont open. CTRL+P doesnt do anythingf either which makes me beleieve its not even loading. Im currently using version 1.20.12. I would love any help you could offer. My vision isnt great and this was a hugehelp.

💬 el_shift , Jul 24th at 7:15 PM

Just for someone who is looking for the answers and have a simular problem I will post the solution here:

 

"copper / malachite": {

"Enabled": false,

"Wildcard": "@ore-(.*)-(malachite|nativecopper)-(.*)",

"Particles": "Ore Sparks"

},

"hematite / limonite / magnetite ": {

"Enabled": false,

"Wildcard": "@ore-(.*)-(hematite|limonite|magnetite)-(.*)",

"Particles": "Ore Sparks"

},

"olivine": {

"Enabled": false,

"Wildcard": "ore-olivine-*",

"Particles": "Ore Sparks"

}

💬 Valkyrja, Jul 24th at 5:24 PM

el_shift I sent you a friend req on discord!

I didn't realize it was regex, I guess. I was just noodling around in the config like an idiot, haha. I thought the could only be used as the last symbol, and didn't realize it could be used in any of the slots gdi- Now my only struggle is getting something like copper and other multi block shite to work. My attempt to have two ores in the wildcard with a comma between them;

"Wildcard": "ore--nativecopper-","ore--malachite-",

 

Or iron which has three 

"Wildcard": "ore--hematite-","ore--limonite-","ore--magnetite-",

 

I tried with [] and () around them as well, but I might just be doing it wrong?

"Wildcard": ("ore--olivine_peridot-","ore-olivine-*",),

But the version with () and [] both break the gui, and so does just putting commas between them. And if it breaks the gui, I'm assuming it doesn't work. Sorry this has basically turned into regex 101 whoops.

We're also going to ignore the ten minutes I spent trying to figure out a symbol on the regex cheat sheet I was looking at, only for it to turn out to be a speck on my moniter.

I just reread your message and now I'm more confused- I can swap wildcard for regex? I definitely don't follow ^^;

💬 el_shift , Jul 24th at 8:49 AM

Valkyrja could you send me your config that breaks GUI? :D I can also fix it for you and it will help me to bulletproof GUI from breaking :D Hit me up on Discord - el_shift

To target all gold quartz you can do ore-*-quartz_nativegold-*

You can also do ore-*-quartz_native*-* for silver and gold

In reality you can do as many different blocks you want by using regex, the line have to start with @ character for regex to work. Examples above are not regex, those just using wildcard character

💬 Valkyrja, Jul 24th at 4:15 AM

I love this so much, the clay ones really help with being colorblind lmao.
Is there a way to put multiple things in the wildcard section? Like, I've tried a few different attempts, but something with my sytax just cause the gui to utterly break and I have to revert back lmao.

right now i have a section labelled goldA -goldD, 

"Golda": {
"Enabled": true,
"Wildcard": "ore-poor-quartz_nativegold-*",
"Particles": "Ore Sparks"
},
"Goldb": {
"Enabled": true,
"Wildcard": "ore-medium-quartz_nativegold-*",
"Particles": "Ore Sparks"
},
"Goldc": {
"Enabled": true,
"Wildcard": "ore-rich-quartz_nativegold-*",
"Particles": "Ore Sparks"
},
"Goldd": {
"Enabled": true,
"Wildcard": "ore-bountiful-quartz_nativegold-*",
"Particles": "Ore Sparks"
},

Basically, is there a way to mush all of those into one chunk so I don't have to enable/disable 4 seperate options?
Also, making my own particle effects was actually pretty entertaining, so that was a cool side effect.

💬 el_shift , Jul 20th at 8:34 PM

Crowflake this is why I made this :D Some use it for halite but I don't go that far. Planning to add cracked vessels and bonysoil to it...

💬 GalloViking, Jul 20th at 6:48 PM

Love this mod! I wish there was a more "organic" way to find high fertility dirt, because right now my "tolerance to pure RNG crap" is already spent on halite prospecting.

💬 el_shift , Jul 15th at 10:49 PM

Cairen yes you can do it in gui, press P to open it up.

💬 Cairen, Jul 15th at 8:37 PM

 Is there a way to disable particles just for peat? I find SO MUCH of it during my games that I dont need to actively go out and search for it, but I have a hard time distinguishing it from High Fertility Soil.

💬 el_shift , Jul 15th at 6:32 PM

AlexUnknown fixed the bug with VintageSymphony, we used same id for gui composer, thank you for reporting.

💬 el_shift , Jul 15th at 7:47 AM

AlexUnknown you can, manually in particlesplus.json. Under particles key you want to modify, look for

"Quantity" and "Size". Beware that Resin contains 4 instances of the same particles for each side of the block so you will need to modify it 4 times.

This article might help you big time editing / adding your own https://wiki.vintagestory.at/index.php/Modding:Simple_Particles

You don't need C# code from there but it explains what those properties do pretty well.

💬 AlexUnknown, Jul 15th at 1:12 AM

Vintage Symphony seems to break the gui.
Is there a way to lower the amount of particles and size? I wanted to lower it a bit. 

💬 el_shift , Jul 14th at 6:16 PM

AlexUnknown have you used 1.x version? Do you have an old config mb? Personally never seen it black. GUI is writen using vanilla API. What version are you on? Try running it without other mods.

💬 AlexUnknown, Jul 14th at 3:15 PM

I need to look more into it, probably a mod conflicting. The settings window is pure black.

💬 eerino, Jun 18th at 12:56 AM

Thanks JimmyMac!!!

💬 el_shift , Jun 17th at 5:59 PM

Byucknah still works for me

¯\_(ツ)_/¯

💬 Byucknah, Jun 6th at 8:12 PM

The mod just stopped working entirely for me today. I have tried removing it and re-adding it. I tried removing the customized config json. I removed all mods and then reinstalled it fresh. Nothing is working. The particles will not appear anymore.

💬 Byucknah, Apr 21st at 5:55 PM

Is there a way to increase the distance at which particles can start appearing? It seems that if I am too high up they wont spawn.

💬 Pamela, Apr 5th at 6:36 PM

Would you consider adding particles for blue and fire clay, now that they are so hard to find??

💬 Gaylad, Mar 24th at 5:51 PM

JimmyMac

This JSON is perfect as far as my needs go. Thanks a ton for uploading this here.

 

Have you considered maybe posting the file as a mod on this database so people could parse versions and whatnot? Would keep it from staying buried in the comment section of its parent mod.

💬 el_shift , Mar 24th at 5:14 AM

Ghaelen why would farmland give any particles? Particles are for soil not farmland. And this mod is a client side only mod. Why are you installing this on your server?

💬 el_shift , Mar 24th at 5:12 AM

Thap not with this mod no

💬 Thap, Mar 23rd at 6:03 AM

Is there a way to make the particles only appear when you are close? And not go much far up, only like three blocks?

💬 Zadak, Mar 19th at 10:32 PM

It is still working fine as of 1.20.5 btw, not sure why it isn't working for others

💬 Tanihk, Mar 19th at 9:37 PM

This doesnt seem to work for me either.

 

Edit: I didn't rwealise time was stopped. Works just fine

💬 Morcalvin, Mar 16th at 8:20 AM

Does this affect surface copper? I struggle to see them and am hoping this could help with that

 

💬 el_shift , Feb 23rd at 2:04 PM

Ragnarogk it seems that it only applies to running water. My guess would be that it spawns right bellow the block it's on with offset probably have something that checks in JSON assets for water or could be hardcoded into the game.

💬 Ragnarogk, Feb 23rd at 12:30 PM

what about dripping particles to blocks just below water? Like if you are digging and the block above have water directly over it, particle that falls like dripping water.

💬 Zadak, Feb 19th at 10:44 PM

Is it possible to have a hotkey to disable it/enable it (and reload when re-enabled)?

💬 SternFr, Feb 18th at 10:46 AM

good soup

 

💬 Zadak, Feb 14th at 10:11 AM

Ah that makes sense, it works! Thanks Staniboy

💬 el_shift , Feb 11th at 3:03 PM

JimmyMac good job, I would add some more X and Z position variation through.

💬 el_shift , Feb 11th at 2:59 PM

Zadak for regex you need to start key with "@" also use "(.*)" instead of plain "*". Soil setup is pretty good example for it. If you need to test it you can use something like regex101. Hit me up on discord I will take a look

💬 JimmyMac, Feb 8th at 9:31 PM

Custom Config - All the things! - Video

I love this mod. Thanks for making it. I modified the iron, high fert, and terra. I added red blue and fire clay particles. For me the particles were just standing out too much making them way too easy to find. My version makes them much more subtle. You can't just look off at the horizon and see them a hundred blocks away but if you come across them in the world you won't miss them.

Custom JSON Config - JSON Download

💬 Zadak, Feb 8th at 8:22 PM

Best mod out there, I have a suggestion, because you say it supports Regex, but I tried it e.g. with using wildcards (.*) and it doesn't seem to work, however, wildcards (*) do act as "any"?

Am I misunderstanding naming things and the pattern matching it uses? Is it pure regex?

💬 el_shift , Jan 18th at 10:36 PM

Keagan yup

💬 Keagan, Jan 18th at 9:22 PM

will this work in 1.20.1 or will you update it to 1.20.1?

💬 Ijkdenem, Jan 18th at 12:01 AM

i like how it looks like dripping honey.

💬 el_shift , Jan 14th at 6:51 PM

Sapion yes

💬 Sapion, Jan 13th at 6:47 PM

is this a client side mod?

💬 el_shift , Oct 7th 2024 at 4:42 PM

NastyFlytrap Once again you can do pretty much anything u want via config file. I don't think I will be writing any UI for it ever. If you need help with config file you can write me on discord.

💬 NastyFlytrap, Oct 5th 2024 at 11:01 PM

Yea, they are, but the game logic you wrote isnt, and if you write a bit more that lets us toggle the individual functionalities on and off, and then let us change those in game using config lib, then that'll work

💬 el_shift , Sep 30th 2024 at 11:15 PM

NastyFlytrap yeah no promises :D those particle configs are pretty much raw game object so... Again if u want particle editing Modding Tools are pretty good. This plugin is just a hook for the game engine pretty much to insert w/e u want 

💬 NastyFlytrap, Sep 29th 2024 at 3:54 PM

Config lib is for editing the config files of mods, in game, without having to edit text files, and needing to relaunch the game.

💬 el_shift , Sep 28th 2024 at 8:30 PM

NastyFlytrap you probably can configure it this way ticking some box for particle collision just like in resin particles. Or you could remove meteoric iron from config completely since there is really no exposed meteoric iron in-game. I don't see any reason to add config lib since you pretty much can add any particles to any blocks and if you need to create your own particles u can use Modding Tools by Maltiez who also created Config Lib. You can hit me up on discord @staniboy if you need help with editing config 

edit: Under meteorite-iron, change "TerrainCollision" to true

💬 NastyFlytrap, Sep 23rd 2024 at 6:02 PM

It'd be really nice if i could make it not show the meteoric iron particles if the blocks are still buried. Yes, i know it defeats the purpose of easily finding it, but, still. I dont want the game to tell me these things if i cant physically see the block. With the terra preta its fine because its the top layer, i can see it, i just need to pay attention, so its not cheating with that.

 

Edit: Its great that you're letting us configure the mod, but, would it be possible to create a setting that only shows the particles for the iron if its 'exposed to air'?

Also, any chance for config lib support?

💬 el_shift , Sep 19th 2024 at 1:46 PM

Germugulgon yes, see "Advanced Usage" then you can remove particles for meteoric iron, basicly you can cut out whole section. Let me know if you need more help.

💬 Germugulgon, Aug 13th 2024 at 1:13 AM

Great mod! Is there a way I can disable the functionality for meteoric iron and keep the other two?

I'm fine with the help finding soil and resin, but would rather keep iron rare and more meaningful to find.  Unsure if I can do that with the config, it appears to mostly be the visuals related to the particles rather than a flag toggle.

Cheers.

💬 DUCATISLO, Jun 9th 2024 at 1:37 PM

gg

💬 karma_cool, Jun 6th 2024 at 5:37 PM

nice mod, it's a real time-saver!

💬 el_shift , Jun 6th 2024 at 11:25 AM

@DUCATISLO Yeah I agree, I tonned them down a bit.

💬 YourCreator, Jun 6th 2024 at 10:20 AM

👎

💬 DUCATISLO, Jun 6th 2024 at 10:08 AM

i like it but the terra preta soils isnt that good but hey i can always "edit it out"

 (edit comment delete)
Основной веб-сайт | Почтовый сервер | FTP сервер | Административная панель | API интерфейс | Content Delivery Network | Статические файлы | Ресурсы сайта | Изображения | Файловое хранилище | Блог | Интернет-магазин | Техническая поддержка | Справочная система | Документация | Форум | Новости | Загрузки | Демонстрация | Тестовая среда | Приложение | Медиа контент | Разработка | Промежуточная среда | Бета версия | Безопасная зона | Вход в систему | Панель управления | Портал | Система управления контентом