Soggy Beans – Guides

Available Guides

Summary

Hey ☺️ we wrote some guides to help anyone who wants to start hosting their own Currents for Soggy Beans.

There’s many different ways to host content online, but these guides hope to help whether you’re already familiar with web hosting or have no idea where to begin.

We especially want to encourage anyone who hasn’t done anything like this before to give it a go. You don’t need to have hosted anything before, and we have a supportive community over on Discord if you need any help 👍

We’re also really grateful to everyone in the community who shares what they know and helps others get their Currents up and running.

Why RATMODE no host servers?

We designed Currents to work without RATMODE hosted servers. There are a few reasons for this, but the biggest is that we want Currents to belong to the people creating and sharing them.

By letting players host their own content, Currents aren’t dependent on RATMODE. As long as a player is willing to host a Current, it can remain available to everyone forever.

This does come with a little more responsibility. Creators need to set up their hosting, update their files and make sure it remains available for others to access. But we think it’s worth the independence.

We’re also fond of the open, independent spirit of the early internet, when people learned how to host simple websites and share things in their own little corners of the web. Currents are partly an invite for players to explore that again while creating something for others to enjoy ☺️

Hosting A Current

Hosting a Current is as simple as taking the zipped content (exported from the game) and making it publicly accessible at a URL. You are welcome to host your Current wherever you like so long as:

  1. you can host a zip file there
  2. the URL is public
  3. the URL uses HTTPS not HTTP
  4. the zip file is the first thing found at this URL (not inside another directory) 

Be aware that if this URL becomes in-accessible for any reason or the content hosted at the URL is invalid, players will be unable to subscribe to or update your Current.

Updating A Current

Currents can be updated even after players have subscribed to them. As long as the URL does not change, when a player updates a Current they will retrieve the latest content.

When a player receives an updated Current, the game will handle the changes a little differently depending on whether they’ve already discovered its items. 

Here’s how each situation is handled:

  1. the name, description and icon of a Current are always updated
  2. an undiscovered item is updated = the item is instantly updated
  3. an undiscovered item is removed = the item is instantly removed
  4. a discovered item is updated = the item does not update and the player can choose to return the item to receive its update
  5. a discovered item was removed = the item is flagged as removed allowing players to throw the item away

If a player has discovered an item, we do not update it without them choosing to do so.

Limits

Soggy Beans has configurable limits to help keep players safer while downloading online content. 

If a player downloads a zip that exceeds any of these limits, the Current won’t sync and the player will be presented with an error message informing them the sync didn’t occur due to the content exceeding a limit.

Players can adjust these limits in the game settings but it’s recommended to keep the size of your content within the default limits as some players won’t feel comfortable changing these. 

The different types of limits are:

  1. Max download size (block downloads that exceed this size)
  2. Max uncompressed content size (once downloaded if the uncompressed size of content exceed this, then we don’t update – prevents zip bombs)
  3. Max number of files within Current (if there are more files in the zip than this, block it. This checks all files in all directories of the zip)
  4. Max individual file size (if a single file exceeds this limit then block adding/updating the Current)

The default values for these limits are:

  • Max download size = 50mb
  • Max uncompressed size = 200mb
  • Max number of files = 1000 files
  • Max individual file size = 25mb