Pip-Boy Apps

A forked repository of the official Mod Tool from The Wand Company to house all the great apps and games made by fellow vault-dwellers for the Pip-Boy 3000 Mk V device. Apps are hosted on pip-boy.com and are open-source for all to enjoy.

Pip-Boy.com  |  Discord Community

Bethesda Store  |  The Wand Company  |  Official Mod Tool

Espruino Reference  |  Bangle Apps  |  Bangle Images

Index

• Getting Started
• Mod Tool
• App List
• Minification
• Contributing

Getting Started

If you put a JS file in the USER folder, Pip-Boy will show it in a list of apps in the INV screen.

• g is a graphics instance that writes direct to the screen.

• bC is a graphics instance that writes to a 2 bit offscreen buffer, and calling bC.flip() will flip that buffer to the screen with a scanline effect.

More details here: API.md

Running the Pip-Boy Mod Tool

1. Clone the repository and its submodules:

   git clone https://github.com/CodyTolene/pip-boy-apps.git
   git submodule update --init --recursive

2. Install Docker:

   https://www.docker.com/

3. Build the docker image:

   docker build -t pip-boy-mod-tool .

4. Run the Docker container:

   # Unix/Linux/macOS
   docker run -dit --name pip-boy-mod-tool -p 8080:80 -v "$PWD":/usr/local/apache2/htdocs/ httpd:2.4
   # Windows Powershell
   docker run -dit --name pip-boy-mod-tool -p 8080:80 -v ${PWD}:/usr/local/apache2/htdocs/ httpd:2.4
   # Windows CMD
   docker run -dit --name pip-boy-mod-tool -p 8080:80 -v %cd%:/usr/local/apache2/htdocs/ httpd:2.4

   Once you run the application, it will be available at http://localhost:8080.

5. Stop the server any time with:

   docker stop pip-boy-mod-tool

6. Clean up:

   docker rm pip-boy-mod-tool
   docker rmi pip-boy-mod-tool
   docker image prune -a
   docker volume prune

App JSON Generation

1. With Node.js installed, open a new terminal at the root of this repo. Install the required Node.js packages:

   npm install

2. Run the app generation script:

   npm run build

   This will generate a file called apps.local.json in the root of the repository.

   You can also use jekyll to generate the apps.local.json file by running jekyll build.

   Do not commit this file to the repository, it is generated automatically and should not be tracked by Git.

Manual Minification

Sometimes the built in minification and tokenization doesn't work as expected, in this case you can run the Espruino minification manually using the following steps:

1. With Node.js installed, open a new terminal at the root of this repo. Install the required Node.js packages:

   npm install

2. Run the minification script:

   npm run min

   OR for live updates:

   npm run min:watch

   Press CTRL+C to stop the live update script.

Contributing

1. Make sure to run the following commands before committing any changes:

   npm run prettier

   This will format all files in the repository according to the Prettier configuration.

2. Add and commit your changes:

   git add .
   git commit -m "Your commit message"

3. Push your changes and create a pull request.

4. Further details on contributing can be found in the CONTRIBUTING.md file.