Paperize.io: Make Better Games, Faster!

Paperize helps game designers make better games by leveraging free web tools to rapidly create and iterate on their designs.

Get Involved

• Use the tool
• Support the project on Patreon
• Chat with programmers and game designers on Discord
• Read the Docs
• Contribute to the Docs

Getting Started

• Install NodeJS
• clone this repository
• Set up your API Keys:
  • visit the Google API Developer Console
  • create a new Project for your Paperize keys
  • create the OAuth consent screen. You just need to enter the application name, the support email and keep the existing scopes for the moment.
  • create a Google OAuth Client ID
    • Application Type: Web Application
    • Name: totally up to you
    • Authorized JavaScript Origins: http://localhost:8080
    • Authorized Redirect URIs: none
  • from the Library menu, enable Web Fonts Developer API and create an API Key
  • from the Library menu, enable the Google Drive API and choose the previously created API key
  • from the Library menu, enable the Google Picker API and choose the previously created API Key
  • from the Library menu, enable the Google Sheets API and choose the previously created API Key
  • Open the OAuth Consent Screen menu again, and add the following scopes:
    • Google Drive API ../auth/drive.appdata
    • Google Drive API ../auth/drive.file
    • Google Sheets API ../auth/drive.file
  • copy and rename example.api_keys.dev.json to .api_keys.dev.json (cp example.api_keys.dev.json .api_keys.dev.json)
  • modify .api_keys.dev.json to contain the keys you just set up
• npm install
• npm test (Optional test, may not work on some systems)
• npm start
• visit http://localhost:8080 and go go go!
• Please, be sure to use localhost:8080, as opposed to 127.0.0.1, when adding the Authorized Javascript Origins and opening your server in the browser, since 127.0.0.1 is not allowed by Google API permissions.

Libraries, Tools, & Services

• VueJS 2.x: low-overhead, highly productive front-end framework
• Vuetify 1.5.x: material design components for Vue
• Material Design Icons: icons integrated into Vuetify
• jsPDF and my fork: PDF generation in the browser
• Cypress.io: modern, browser-based integration testing
• NodeJS, Webpack, Babel: so we can write modern JS
• Google Drive API for user-controlled storage (more to come)
• Amazon Route53/Cloudfront/S3: simple, fast, cheap, global CDN