Skip to content

Community Scripts

Community Scripts provide an open-source alternative to traditional script publishing on the Cereal Marketplace. Scripts are automatically synced from GitHub repositories, making it easy to share free scripts with the community.

Overview

Community Scripts are: - Always Free: No payment required for users - Open Source: Source code is publicly available on GitHub - Automatically Synced: New releases are discovered automatically - No Account Required: No need for a Cereal developer account

Quick Start

1. Add the GitHub Topic

Add cereal-community-script as a topic to your public GitHub repository:

  1. Navigate to your repository on GitHub
  2. Click the gear icon next to "About" section
  3. Add cereal-community-script to the topics field
  4. Save changes

2. Create a Release

Create a GitHub release with your JAR file:

  1. Go to the "Releases" section of your repository
  2. Click "Create a new release"
  3. Tag your release (e.g., v1.0.0)
  4. Attach your compiled JAR file
  5. Optionally add release notes (will be shown in the marketplace)
  6. Publish the release

3. Wait for Sync

Your script will be automatically discovered and published within a couple of hours!

Requirements

GitHub Repository

  • Must be public
  • Must have the cereal-community-script topic
  • Should have a meaningful description (used in marketplace)
  • Optionally add relevant topics for better discoverability

Metadata Syncing

Script Information

The following is automatically synced from GitHub:

Source Destination Priority
STORELISTING.md Script description 1
Repository description Script description 2
Repository topics Script tags (max 10) -
Repository issues URL Support URL -
Release tag Release version name -
Release notes Release notes -
Repository name Script title (if not in manifest) -

[!TIP] Use STORELISTING.md in the root of your repository to provide a rich HTML description. The content is converted from Markdown to HTML automatically.

Best Practices

Repository Setup

  1. Add a README: Explain what your script does
  2. Use Topics Wisely: Add relevant topics for discoverability (e.g., osrs, farming, automation)
  3. Write Clear Descriptions: The repository description becomes the script description
  4. Maintain Issues: The issues page becomes your support channel
  5. License Your Code: Add an open-source license (e.g., MIT, GPL)

Versioning

  1. Increment Version Code: Always increase the version_code for new releases
  2. Use Semantic Versioning: Tag releases as v1.0.0, v1.1.0, etc.
  3. Write Release Notes: Help users understand what changed
  4. Test Before Release: Ensure your JAR works before publishing

Limitations

Community scripts have some limitations compared to developer console scripts:

  • Always Free: Cannot charge for community scripts
  • No Direct Editing: Cannot edit metadata through developer console
  • Limited Control: Description and tags come from GitHub only
  • No Revenue: Not eligible for revenue sharing programs
  • Public Source: Code must be publicly available

Troubleshooting

Script Not Appearing

If your script doesn't appear on the marketplace: 1. Verify the cereal-community-script topic is added 2. Check that your repository is public 3. Ensure you have created a release (not just a tag) 4. Verify the release has a .jar file attached

Version Not Updating

If a new release doesn't publish: 1. Ensure the version_code is higher than the current production 2. Check that the package_name matches exactly 3. Verify the JAR file is attached to the release

Switching from Developer Console to Community Script

If you have a script published through the developer console and want to migrate it to community scripts:

  1. Add the cereal-community-script topic to your GitHub repository
  2. Create a release
  3. Contact support to remove the script from the developer console and link the existing script to your repository

Note: Paid scripts cannot be migrated to community scripts.

Switching from Community Script to Developer Console

If you want to move a community script to the developer console for more control or to make it paid:

  1. Remove the cereal-community-script topic from your repository
  2. Contact support to transfer ownership
  3. Note: This process requires manual intervention and the script's identifier must remain the same

Support

For help with community scripts: - Check this documentation - Join the community Discord for questions

Examples

Looking for examples? Search GitHub for repositories with the cereal-community-script topic:

https://github.com/topics/cereal-community-script