/ParticleWorkshop

A tool for creating custom Particles in NeosVR

Primary LanguageC#

Particle Workshop

A simple plugin for creating particles with color and alpha over time in Neos VR Metaverse Engine. Created by Gareth48 with some huge help from Epsilion!

Getting Started (For Users)

  1. Click this link to go to releases
  2. Download the .dll
  3. Navigate to your Libraries directory, usually ~\Steam\steamapps\common\NeosVR\Libraries
  4. Place the dll in that folder
  5. In steam, right click Neos VR and select Properties
  6. In launch settings paste this line -LoadAssembly "Libraries\ParticleWorkshop.dll"
  7. Once you're in game you can check if it worked by checking your friends list, if your friends appear pink you've succeeded

What to do once you're in game

  1. Open the component browser and navigate to the tab labaled "Gareth"
  2. There are three new components
  3. Live particle editor, which accepts and can edit a particle system in realtime (make sure the blend mode on your particle material is set to alpha if you want to see alpha changes!)
  4. Random Particles, which randomly generates particles with a set amount of alpha and color transitions
  5. If you use the live particle editor, once you're satisfied with your changes you can just delete the component and your changes will be saved
  6. Once you've created a particle, save it to your inventory, remove the launch option addition and reboot Vanilla Neos
  7. Enjoy your new particle! Feel free to use it as you please, if you do something neat with it I would love to see a picture!

How this works

  1. If it helps, think of this plugin like an inventory editor
  2. Using it, we can create objects that Neos technically supports but that we have no way to generate at the moment
  3. An example of color over time in the base game is the particle spray tip! It's rainbow effect is acheived in this way
  4. All this plugin does is provide a GUI for you to edit those values

Known issues

  1. You cannot add duplicate color or alpha transitions
  2. You can only add up to 8 unique color transitions AND 8 unique alpha transitions
  3. Driving randomiterations to a large number will crash the game!
  4. If the component somehow stops working, delete all instances of it, restart your game and send your logs to Gareth48
  5. As a good rule of thumb, deleting the component, restarting your game and reapplying it should fix most trivial bugs
  6. Once you assign a particle style to the Live Particle Editor's reference field the component it is locked on. To edit another particle system simply create another Live Particle Editor

Contribution Guidelines

  1. Please send any bugs or suggestions you have to Gareth48 in Neos, or report them via the github
  2. If you would like, open an issue stating your problem or motivation and a suggested solution.
  3. Create a pull request which links to your issue.