shammond42 / chronicler

Generate epub from Obsidian Portal Content

Introduction

Chronicler is a tool to pull adventure logs from Obsidian Portal and generate an epub book out of them for reading off line on an iPad, Kindle or something similar.

Dependencies

• oauth — Gem for OAuth authentication
• mage-hand — Ruby gem for accessing the Obsidian Portal API
• eeepub — Ruby gem for generating epub files

Usage

Authorization

Before you can use Chronicler on a campaign, you must first authorize Chronicler to access your Obsidian Portal account. To get started use the command

$ chronicler authorize

You will be given a URL to enter into your browser.

Put https://www.obsidianportal.com/oauth/authorize?oauth_token=XXXXXXXXXXXXXXXXX in your browser

The oauth_token piece willl look different. When you enter the URL, Obsidian Portal will ask if you want to authorize the app. Click Authorize and you will be given an token and a secret. Enter those when prompted.

Enter token: xxxxxxxxxxxxxxxx
Enter secret: xxxxxxxxxxxxxxxx

This information will be saved and you will be ready to start using chronicler.