SETUP

If you are using Pokeweb's spa editor for a hg/ss rom, skip this setup and go here first https://github.com/hzla/Pokeweb/wiki/Spa-Editor-for-HG-SS-(for-windows)

To setup first open your shell and navigate to pokeweb's folder

Assuming you have a rom loaded into pokeweb, run the following commands in the shell. Replace python with whatever commmand your system recognizes to run python.

python python/spa_reader.py all projects/YOUR_PROJECT_NAME -r

The above command will extract all move particle effects to projects/YOUR_PROJECT_NAME/spas.

To view in your browser, navigate to localhost:3000/spas/SPA_ID, replace SPA_ID with the particles you want to view. To check which moves you which particles, open a move's animation file from the move editor. For example localhost:3000/spas/295 is fire blast.

You can view all the textures a spa file uses, and open up the extracted json by clicking the purple Open Particle Infobutton. Edits to this file will be applied to the .spa file. If you want to check the color of a specific tile on the textures, you can right click and inspect element if you are on chrome.

Finally open your session_settings.json and change 'output_spas' to 'true'.

Your edits will now be applied to rom you export to pokeweb.

You can edit textures by clicking on a palette and entering either a an rbg value separated by commas, or a hex value.

USAGE

.SPA files are split up into particle blocks, textures, and palletes.

You will first see a list of particles and their color attributes, and some other main attributes. To make a color edit, click the teal colored text next to a color and type in a color value either in rgb format or hex.

To make an edit on other fields, simply edit the teal colored text All edits are saved automatically

Particles

base_color the general color the particle

color_start the starting color of the particle

color_end the ending color of the particle

base_scale the size of the particle (4 bytes)

base_delay how many frames to wait before starting the animation

particle_duration how many frames the particle will stay on screen

air_resistance affects speed of the particle, the lower the number the slower the particle

Textures

Textures are used by the particles. You can edit the colors of the textures by editing the color values on the pallete display. Hovering over a pallete will highlight the corresponding palletes on the canvas as black.

Pallete colors accept either an rgb value of 3 comma separated integers or a hex value.

More Fields

To view the full list of fields to edit, click on the purple open particle info button on the top right to open a json file representing all the particles and texture fields availalbe

To download a copy of your edited .spa file, click export

To view the your .spa file in NitroEffects, click the View Edits in NitroEffects button

Public Spa Bank

A rom is available at fishbowlweb.cloud:3000 as a project title spa_particle_bank with the password pokeweb. You may view any .spa file by entering the url /spas/SPA_ID, for example: fishbowlweb.cloud:3000/spas/100. The .spa file can then be downloaded by clicking the purple export button.

Edits are permanent and shared. You can also make a copy of a .spa file online by going to the url /spas/SPA_ID_TO_COPY/copy_to/SPA_ID_COPY_DESTINATION Entering a SPA_ID destination greater than the total number of .spa files will result in the copied .spa being appended to the list of total .spa files.

For example: visiting /spas/171/copy_to/750 will copy .spa 171 to .spa 750 If there is no 750th .spa file, it will instead add it after the last .spa ID which in this case is usually 738. Your new .spa file will then be available to edit at /spas/739

If you require a private rom with the spa editor enabled, use Pokeweb-Live offline mode.