Wiki [ Video Demo ] [ Code Link Until One Click Merge ] If you run a complex campaign in Roll20 or have worked your way through a large module, you've probably felt the pain of hunting through the journal, flipping between handouts, and trying to remember where everything is. The Wiki Mod is a script that presents a single unified interface that lets you browse all your campaign information — handouts, GM notes, and map pins — from one panel, without ever leaving the page you're on. Wiki takes advantage of Roll20's new ability to link to specific header in handouts to give you much more control over navigation. As a bonus, it also allows you to automatically view all of the pins on any page, with pin pull functionality thrown in. Wiki works for both GMs and players, with automatic content filtering so players only see what they're supposed to see.It can be installed on a homebrew campaign, or give instant improved navigation in a module. The Wiki has two separate handouts: Wiki - GM — the full GM interface, accessible only to the GM Wiki - Player — the player-facing interface, shared with all players Both are updated automatically when you interact with the Wiki. The GM sees all content including GM Notes; players see only content from handouts shared with them, and only the player-facing portion of pin descriptions. Getting Started Type !wiki in chat to open the Wiki. A link to the Wiki - GM handout will be whispered to you. Players who type !wiki receive a link to Wiki - Player. The interface is divided into two main areas: Navigation Panel — the left panel, listing items you can open Content Panel — the right panel, showing the currently viewed content Wiki Home Typing !wiki always returns to the Wiki Home handout . The home button (⌂) in the top-right corner of the interface does the same. Navigating home clears the Back and Forward history. Wiki Home is a regular handout shared with all players. Edit it freely to create a campaign landing page. Links to other handouts inside Wiki Home will open directly in the Wiki panel when clicked. If you wish links on the home page to only show for the GM, put that content in the GM Notes. Background Image You can set a background image for the entire Wiki interface by adding an image URL as a tag on the Wiki Home handout. The URL must begin with https://. If multiple URL tags are present, the first one is used. The background will tile across the interface container. Handout Mode Handout Mode lets you read handouts in the content panel. Select a handout using the chooser button at the top of the navigation panel. The currently active mode button is outlined. When a handout is selected, its full contents are displayed and all headers appear in the navigation list. Click any header button to jump to that section. The currently viewed section is outlined in the navigation list. Header Level Buttons All — shows the entire handout and lists all headers at the highest available level H1–H4 — filters the navigation list to show only headers at that level arrow button — when active, also shows headers below the selected level GM Notes Headers For the GM, headers from the handout's GM Notes field also appear in the navigation list, shown in grey to distinguish them from the brown Notes headers. Clicking a grey header loads that GM Notes section into the content panel. If you are viewing the entire handout (using the "All" button, Notes and GM Notes content are separated by a horizontal rule in the content panel Handout Avatars If a handout has an avatar image set, it is displayed at the top of the content panel when viewing the full handout in All mode. Handout Links Links to other Roll20 handouts inside your content are automatically rewritten so that clicking them opens the target handout directly in the Wiki panel, rather than in a separate browser tab. Using Keywords (H5–H6) Keywords are optional tags used to filter sections. Create them by adding H5 or H6 headers inside a handout. Example: H2 Abandoned Mine H5 dungeon H6 goblins Clicking a keyword button filters the navigation list to show only sections containing that keyword. Multiple keywords can be active at once. Use Clear All to remove active filters. Keywords within a header group act as an OR filter. Keywords between header groups act as an AND filter. Thus in a city map, you cold have h5 refer tow wards of the city, and h6 be types of locations. You could select "thieves" in the h5 tags, and "tavern" and "temple" in the h6 tags, which would show you all of the temples or taverns in the thieves quarter. Pin Mode Pin Mode lists all map pins on the current page, sorted alphabetically. The currently active mode button is outlined. The currently selected pin is outlined in the navigation list. Selecting a pin loads its content into the content panel. Switching back to Handout Mode and then returning to Pin Mode will restore the last viewed pin automatically. Where Pin Content Comes From Direct notes — text stored directly on the pin A linked handout section — content pulled from a specific header in a handout, including GM Notes headers Player Visibility in Pin Mode For pins linked to a handout, content is separated using a blockquote. Players see only the content inside the blockquote. Everything after it is GM-only. The GM sees all content with a horizontal rule separating the two sections. Pins without a blockquote show no content to players. Use !wiki --audit-pins to scan the current page for player-visible linked pins that are not correctly configured. Use the Fix and Fix All buttons in the audit report to correct them automatically. Ping Buttons Each pin entry in the navigation list includes two @ buttons. The same buttons also appear in the content panel header when a pin is selected. Gold pin — pings the pin location for all players Grey pin — pings the pin location for the GM only Content Panel Buttons The control bar above the content panel provides navigation and action buttons. ◀ Back — returns to the previously viewed handout or section (GM and players) Forward ▶ — moves forward through history after going Back (GM and players) ✕ History — clears all Back and Forward history (GM and players) Previous / Next — steps through the filtered navigation list sequentially Open — opens the source handout for editing (GM only) Send to Chat: GM/Players — sends the current content to GM chat. or open chat. Does its best to filter GM-only content, but use with caution. Pintool — opens the Pintool interface if installed , in Pin Mode (GM only) Back and Forward track navigation across different handouts and sections. Previous and Next step through the current filtered list without affecting history. GM and player Back/Forward histories are tracked independently. Player Access Players type !wiki in chat to receive a link to Wiki - Player. The interface updates automatically when they interact with it. Players have their own independent navigation history. Players can see handouts that have been shared with them via Roll20's journal permissions. The GM can also grant access to any handout by tagging it wiki+ , regardless of journal permissions. Handout Tags wiki+ — makes a handout visible to players in the Wiki chooser, regardless of journal permissions wiki- — hides a handout from the Wiki chooser entirely. The Wiki - GM and Wiki - Player interface handouts are tagged this way automatically. ImageURL — an image URL in the Wiki Home handout tags will be used as a background image for all wiki content. An example would be a parchment background. Tags are set in the handout's Edit mode using the Tags field. Commands Reference !wiki — open the Wiki and go to Wiki Home !wiki --help — open this help document !wiki --audit-pin s — scan current page for misconfigured player-visible pins Tips for Organizing Your Campaign Use H1–H4 in handouts for structure and navigation. Use H5–H6 as keyword tags for filtering (optional). Keep keywords short and consistent across handouts. Use blockquotes in linked pin sections to mark the player/GM boundary. Set handout avatars to give locations and topics a visual identity. Edit Wiki Home with links to your most-used handouts as a campaign dashboard. Add an image URL as a tag on Wiki Home to set a background texture for the interface. Use wiki+ to share specific handouts with players without changing journal permissions. Use wiki- to hide utility or system handouts from the chooser.
