Skip to content

Customizing MiniAdventure

Jump to bottom
Torivon edited this page Dec 13, 2016 · 7 revisions

#Customizing MiniAdventure

The main point of the design of MiniAdventure is so that other people can tell their own stories on the Pebble. All I ask is that if you do publish your own app, please include a link back to the main MiniAdventure repository in your app store description.

###Overview

  1. Fork the repository
  2. Download to a local PC
  3. Run init_new_project.py
  4. Using the Story format, design your adventure
  5. Add any necessary art
  6. If you have access to the Pebble SDK locally, run "pebble build", which will automatically process your data and art and create the pbw.
  7. If you want to compile with Cloudpebble, run process_stories.py and check in. You can then import to Cloudpebble to do the build step.

###Details

  1. Fork the repository

    1. Make an account on github.com.
    2. Go to MiniAdventure.
    3. Click on the word "Fork" in the upper right corner of the page. This creates your own working copy of the repository.

  2. Download to a local PC

    1. Go to your fork of the repository. It should have a URL like https://github.com/username/MiniAdventure
    2. There should be a "Download Zip" button, and next to that, a link to open the repository in Github desktop. If you are comfortable with the command-line tool, feel free to use that.

  3. Run init_new_project.py

    1. This requires python installed locally. If you don't have it, install python.
      • I have tested on Windows and Mac. I have also tested on both Python 2.7.10 and Python 3.5.1.
    2. In a command prompt from your MiniAdventure main directory, run "python dev_tools\init_new_project.py <author> <shortname> <longname>", eg. "python dev_tools\init_new_project.py Me Quest MyQuest".
    3. This will update src_data/base-appinfo.json with your project information, as well as generate a new uuid for the project.

  4. Using the Story format, design your adventure

    1. This is, of course, the tricky bit. At this point, the story format is still very basic. To get a sense of what additional features I intend to add, check out the issues page.
    2. Once you have designed your skills, monsters, classes, and locations and created a <story>.json file. Put it in src_data/stories.
    3. src_data/stories.txt should include a list of all the stories you want included in your app.

  5. Add any necessary art

    1. Make art for each monster and location.
      • These pieces should be 80x80 and included in src_data/images. For now, I have been unable to get MiniAdventure small enough to run on Aplite devices, so you only need to create color images. I will keep trying, though.
      • They should be referred to by name in the story json file.

  6. Build your pbw file with one of the following options:

    • (Option 1) If you have access to the Pebble SDK locally, run "pebble build", which will automatically process your data and art and create the pbw.

      1. If necessary, install the SDK.
      2. From the MiniAdventure main directory, run "pebble build".
        • Running "pebble build" locally will automatically run process_stories.py. This generates the binary story files, copies all necessary resources, including art, to the resources directory. In addition, it creates the appinfo.json file which will be used by the pebble build step.
      3. The generated pbw will be in the the build directory.

    • (Option 2) If you want to compile with Cloudpebble, run process_stories.py and check in. You can then import to Cloudpebble to do the build step.

      1. Run "python dev_tools\process_stories.py". This will generate the binary story files, copy all resources in the resources directory and create the appinfo.json file.
      2. Commit this change to github.
      3. Make an account on Cloudpebble.
      4. Click the "Import" button and fill in the options to import your project from Github.
      5. Click compilation in the menu on the left side of the screen, and click "Run Build"
      6. You can then use the emulators to test your app, or download the pbw for publishing.

  7. For instructions on submitting your app to the Pebble app store, see "Pebble Appstore Publishing".

Clone this wiki locally