Check out the Quick Start and Information page for information on using the module and Web Hub site.
What is Web Hub?
Web Hub is a hosted sync of your Campaign Codex (CC) journals, accessible via the WebHub website. It uses Patreon for authorisation in the sync module and on the website.
Web Hub is not a Foundry backup. It is an out-of-Foundry sync of your CC journals; Foundry remains the source of truth and permanent storage for your content. Any edits made in Web Hub should be synced back to the Foundry world to permanently retain them.
What can you do on Web Hub?
In the current version, you can:
- View all of your CC journals, their links, and tabs, and organise them by Folder, Type, or Label.
- Edit the content of all of the journals.
- Share a link to a read-only version of the world for players to explore. Sheet visibility is transferred from Foundry, and no Patreon authorisation is needed to view the shared link.
How do I use Web Hub?
Web Hub adds a Sync Web Hub and Open Web Hub button to the bottom of the journal panel.
Sync Web Hub
Sync Web Hub opens a dialogue with a list of the Campaign Codex journals in the world, along with a checkbox to include images. It shows version changes and gives options for each journal and page: Skip, Keep Foundry, or Use Web Hub.
When you first open Sync Web Hub, you will be asked to authorise with Patreon via a pop-up window.
Open Web Hub
Open Web Hub will open the Web Hub website in your browser.
What are the settings?
Web Hub has one setting: what to do with images external to Foundry (i.e., in an S3 bucket). You can choose to have Web Hub link directly to the bucket or embed the images. Linking is the default option, and linked images don’t count toward your storage quota.
What’s stored on Web Hub?
- Your journals, encrypted in a database.
- Foundry downsamples locally hosted images to a maximum of 1920×1080 WebP and uploads them to display on Web Hub.
- We keep some Patreon account information to link your worlds to your account so you can access them.
What are the storage limits on Web Hub?
These are initial limits and may increase in the future if there is demand:
- Total image storage: 100MB (depending on the images, you could store 1,000-2,000 images).
- Total document (CC journals) count: 5,000.
- Total document (CC journals) count per world: 2,500.
- Total number of worlds: 10.
What’s the road map?
I’ll be creating and posting a roadmap on Patreon and on the documentation site, but the broad strokes are:
- Adding CC Sheets. Completed in Alpha
- Adding Custom Tabs to CC Sheets. Completed in Alpha
- Linking and Unlinking. Completed in Alpha
- Adding Tags.
- Adding Images.
What’s the nitty-gritty?
I, the admin Stephen Garrett (wgtngm), have access to an admin panel. From there, I can:
- See the status of your Patreon subscription.
- See the amount of pages, images, and general storage information.
- Remove accounts.
- Remove worlds.
What can’t I do?
- Your data is encrypted; I cannot see your content.
Web Hub is not a Foundry backup and should not be relied on as such. A total data loss on Web Hub should easily be rectified by resyncing with Foundry.
It is a useful tool to edit and make changes to CC sheets outside of Foundry, but those changes should be synced back for permanent storage.
--
Documentation:
--
Join our Discord to see the work in progress and discover upcoming features.
Support the project on Patreon or Ko-fi, or see what else I have on the go.