Skip to content

Installation

Jump to bottom
Alunacoz edited this page Mar 23, 2026 · 21 revisions

Download the files

Static download (no extra requirements)

Download the Latest Release!

You should download the latest Source code (zip), then unzip it where you'd like to install!

You can also use the green code button to download the cutting edge version of the viewer!

Git clone (requires git to be installed)

run git clone https://github.com/Alunacoz/BounceX-Viewer.git in a terminal/cmd in the directory you'd like to install from.

Prerequisites

If you do NOT have Python installed, it will ask you if you'd like to install it! This feature is experimental, feedback appreciated (both if it works or if it doesn't work!)

  • Python 3.x
  • pip

Installation

Using the Start Script (Recommended)

This starts both the main site AND the manager.

Linux & Mac:

Double click StartWebsite.sh or in a terminal:

chmod +x StartWebsite.sh
./StartWebsite.sh

Note: On Mac, you may run into Gatekeeper. Right click StartWebsite.sh -> Open then confirm!

Windows:

Double Click StartWebsite.bat and if anything asks, allow it to run!

Or in a terminal:

StartWebsite.bat

If you do not have python, it will prompt you to install it. After it installs, close the window and restart StartWebsite.bat and it should work!

This script automatically activates the virtual environment and starts the website.

...and you're done! Now add some videos!

Accessing the Website

Once the server is running, open your browser and navigate to:

http://localhost:8000

If you want to access it from another device on your local network:

http://[YOURLOCALIPHERE]:8000

Adding Videos (Automatic) (Recommended)

1. Download a valid package for this website.

The source could really be anyone, but the DH Discord Server is likely a good place to start. You will know it's valid where the root of the .zip (when you double click it) just contains a video and or playlist folder.

2. Visit the manager and drag the .zip in

In the navigation bar of the website, open "Manager" and drag the .zip into the window, or click the import .zip button.

3. Verify that your new videos are at the top of the list!

You can drag the videos/playlists up and down to change the order they appear.

And you're done! You now have everything set up and can import videos. If you would like to learn how to manually install videos or create new packages, go here.

Updating:

Automatic (recommended!)

Double click Update.sh or Update.bat for Mac/Linux and Windows respectively. It will prompt you to install git if you do not have it. You may have to restart the script after installing git. After that, it will simply get the newest version of the viewer!

Manual

Repeat the installation instructions for static download, but make sure not to overwrite any files named manifest.json!

Troubleshooting:

If you run into any issues, try a hard refresh:

Windows/Linux: Ctrl + Shift + R
Mac: Cmd + Shift + R

This resolves most caching issues that may occur. This also may erase some settings.

Clone this wiki locally