Skip to content

Uploading to the workshop

Jump to bottom
pongo1231 edited this page Apr 11, 2023 · 14 revisions

Starting with mod version v2.0, you are able to download external effect scripts and sounds from the comfort of the config utility and have them immediately loaded in the mod through hot reloading.

image

Submissions are merely a collection of one or more scripts and/or sounds.

Creating a submission

For scripts consult this page.

For sounds the following applies:

  • Sounds must be stored inside a sounds folder located in the root path of the submission, otherwise the mod will not register them!
  • If multiple submissions (or the user) register the same sound, they will be added to a pool and played at random
  • Otherwise the same ruleset as user sounds applies
    • effect_id.mp3 to play a sound when a specific effect gets dispatched (check either the source code or the effect-specific settings inside the config utility to fetch the name)
    • global_effectdispatch.mp3 to play a sound on each effect dispatch
    • If you want to use varied sounds you can instead create a folder with the same name (minus the .mp3) and store sound files with random names inside there

You can also store .txt files in case you want to provide some additional info for people who browse through your downloaded submission's files.

Once you are done archive the content of your submission work directory as an unprotected .zip file. If you want to upload sounds make sure the created archive didn't create a root folder where all your files are contained in as that will break them!

Uploading

First off you will need an account. Account creation is currently only possible through an admin but will eventually be opened up. Contact either pongo1231#6909 on discord or pongo1999712@gmail.com with your desired username (and optionally password).

Once you have an account visit https://chaos.gopong.dev/workshop/view and log in with your credentials.

Afterwards:

  1. Click on Create New
  2. Fill in your desired submission name and version at a minimum. The fields marked with (optional) are exactly as it implies
  3. Upload your archived submission under Data File
  4. Ensure you've followed the specified rules for all the fields
  5. Cross your fingers and click on Create. If anything is wrong it will tell you in red text below the Create button

If all is well you should be booted back to Your Submissions screen with your newly uploaded submission visible. You can also check the Workshop tab of the config utility and click on the Refresh button to verify if your submission is viewable.

You have the option to either download your submission directly from that screen (though it's going to be a zstd compressed version of your uploaded archive which not every archiving program can handle) or to edit your submission. If you wish to edit your submission you only have to modify the fields you want to update and optionally upload a new archive.

Clone this wiki locally