Skip to content

Publishing

There are two ways to publish scripts on the Cereal Marketplace:

  1. Developer Console Publishing - For commercial and premium scripts
  2. Community Scripts - Open-source scripts automatically synced from GitHub

Developer Console Publishing

This is the standard method for publishing scripts that you develop and maintain through the Cereal Developer Console.

Signup developer console

To get started with publishing scripts, you'll need to sign up for a developer account. Once signed up, you'll have access to the developer console where you can manage your scripts.

Create release

To create a new script:

  1. Navigate to the scripts section in the developer console
  2. Click "Create Script"
  3. Fill in the required information:
  4. Script Name (max 50 characters)
  5. Script ID (must be unique, in Java package name format like com.example.myscript)
  6. Short description (max 100 characters)
  7. Full description (rich text editor)
  8. Pricing (Free or Paid)
  9. If Paid: Set price (minimum $2.00)

Publishing status

A script can have different statuses as outlined below. The current status of a script can be viewed at the scripts overview page.

Status Description Can Edit? Visible to Users?
Draft The script is still in draft and not available for anyone to download. Yes No
Processing for production The script is being processed before made available in the marketplace. Once processed the status will automatically change to "Production". The processing normally doesn't take longer then 15 minutes. No No
Production The script is available in the marketplace. Limited Yes
Unpublished The script is not visible to new users but existing users can still access it and receive updates. Yes Limited

Important notes:

  • Once a script is published as paid, you cannot change it back to free
  • The Script ID cannot be changed after creation
  • You can toggle between Production and Unpublished status at any time
  • When a script is unpublished, existing users can still find it and will receive updates

Community Scripts

Community Scripts are open-source scripts that are automatically synced from GitHub repositories and published to the Cereal Marketplace. This provides an easy way for developers to share free scripts with the community.

How It Works

  1. Tag Your Repository: Add the cereal-community-script topic to your GitHub repository
  2. Create Releases: Create GitHub releases with your JAR file attached
  3. Automatic Sync: The Cereal platform automatically discovers your script
  4. Instant Publishing: New releases are automatically published to the marketplace

Requirements

To publish a Community Script, your GitHub repository must:

  1. Have the cereal-community-script topic added
  2. Be publicly accessible
  3. Have GitHub releases with .jar script file attachments

Benefits

  • No Developer Account Required: You don't need to sign up for a developer account
  • Automatic Updates: New releases are automatically synced and published
  • Always Free: Community scripts are always free to use
  • Open Source: Your source code is public on GitHub, fostering community collaboration
  • GitHub Integration: Uses your repository's description, topics (as tags), and issues page (as support URL)

Getting Started

  1. Create your script following the getting started guide
  2. Push your code to a public GitHub repository
  3. Add the cereal-community-script topic to your repository:
  4. Go to your repository on GitHub
  5. Click the gear icon next to "About"
  6. Add cereal-community-script as a topic
  7. Create a release:
  8. Go to "Releases" in your repository
  9. Click "Create a new release"
  10. Attach your compiled JAR file
  11. Publish the release

Your script will be discovered and published to the marketplace within a couple of hours!

Limitations

  • Community scripts are always free (no paid options)
  • You cannot edit script details through the developer console
  • All metadata (description, tags) comes from your GitHub repository
  • Support is handled through the GitHub repository issues