Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

Quick Test

knot126 edited this page Jan 21, 2024 · 35 revisions

You can quickly and easily test changes to segments by using a mod of Smash Hit that allows loading segments from a server on your computer that is enabled with Shatter by default.

You can find a demo on YouTube if you want to see what it looks like.

Tip

If you run into an error or find that we haven't described how to do something, try searching for the issue on a search engine like Google or DuckDuckGo.

Download and install the test client

To start, download the Shatter Test Client mod APK file and install it to your phone or to an emulator:

Old versions

Note

Test client v3.3.0 and later require Shatter v2023.06.28 or later.

Using the test client

To use Shatter Test Client, export your work in progress segment to the Quick Test Server by clicking FileExportShatter: Quick Test Server or using the keyboard shortcut Shift + Alt + E. After that is done, start the Shatter Test Client app on your phone.

If this is your first time running the app — or your computer's IP address has changed — then you will need to set your IP address. To do this, click the Select IP button at the bottom centre of the main menu. After that, find the Scene tab in Shatter, look for the Quick Test panel, and type the IP address from there.

Tip

You can click the boxes containg the numbers to change which box you edit.

After entering your IP address, you can click the Start button in Smash Hit and your segment will be downloaded from your computer and played in the app.

To test any new changes you have made to your segment, export your segment to the server again and restart the level in Smash Hit. Your changes will show up immediately!

Tip

Your IP address is always saved, even when you restart the test app, so you don't need to reenter your IP address until your computer's IP address changes.

Important

Smash Hit's HTTP file loader can be unreliable at times, so if it crashes on your first attempt, try again. If it keeps crashing the in the same way, make sure your firewall is off and that you have the correct IP address under the Select IP option.

Troubleshooting

You might need to allow your phone and computer to connect.

What is this?

Normally, a firewall blocks network connections that might allow people to gain access to things on your computer. We need to disable the firewall for port 8000 so the network connections that the Quick Test app makes are not blocked.

On your computer, you should have a firewall rule set up to allow traffic from port 8000. Assuming this is set up properly, the server will automatically start when Blender is opened and close when it is closed.

If you are on Windows, a dialogue should pop up asking if you want to allow network access the first time you start the Quick Test server. If you allow this, nothing more should be needed.

If you missed it or the dialogue did not show, you can find a guide about opening ports on Windows here: https://www.howtogeek.com/394735/how-do-i-open-a-port-on-windows-firewall/

Custom obstacles

Custom obstacles can be loaded over the network with the latest versions of Shatter and the Quick Test Client. They must be located in the assets/obstacles folder in an APK that is loaded in APK Editor Studio, or alternately in the obstacles folder of a custom assets path.

Please note that bundled obstacles, like dna or bar, are loaded from the client locally for performance reasons and any changes made to them won't show in the test client.

Credits

  • Knot126 — Most of the mod.
  • Yorshex — Some of the menus were updated by Yorshex to match the style of the Quick Test app!

Notes

  • As of 2.1.0 and later, the quick test app only supports devices with a 64-bit or 32-bit ARM processor. Also, note that previous versions did not support 32-bit ARM.
    • Support for saving IP address between restarts does not work on 32-bit ARM platfoms at the moment.
    • Support for 32-bit ARM devices will most likely be dropped in the next release. New versions of Shatter will continue to support the old client for now, so you can continue using the last 32-bit supported version.
  • Templates will only work if they can be automatically found from an APK loaded in APK Editor Studio or the file templates.xml is present in your Blender Tools folder.
  • You can change quality and game mode between tests. Please note that Zen and multiplayer modes do not work.
  • If you would like to load an entire level or room, you can use yorshex's asset server.
Clone this wiki locally