Skip to content

🔥 From Source

The most flexible way to use the Projects | Latest features, editable, standard git clone

⚡️ Installing

Running any of my Projects takes only two commands

1. Select your Platform

Open some folder to download the code on Windows Explorer

  • Press Ctrl+L , run powershell and execute:
PowerShell
1
irm https://brokensrc.dev/get.ps1 | iex
What is irm and iex?
  • irm is an alias for Invoke-RestMethod to download the script
  • iex is an alias for Invoke-Expression to run the script
  • The pipe symbol | sends the first command's output to the second
Enable Developer Mode for a Better Experience

To have Folder Shortcuts (Symbolic Links) to the Project's Workspace Directory where the Source Code is (Data, Downloads, Config, etc), please enable Developer Mode on Windows Settings per Rye FAQ

Open a Terminal on some directory and run

Bash
1
/bin/bash -c "$(curl -sS https://brokensrc.dev/get.sh)"

Open a Terminal on some directory and run

Bash
1
/bin/bash -c "$(curl -sS https://brokensrc.dev/get.sh)"

  • Install Git and Rye on your Platform

Clone the Monorepo and all Submodules
1
git clone https://github.com/BrokenSource/BrokenSource --recurse-submodules --jobs 4
Enter the Monorepo directory
1
cd BrokenSource
Checkout all Submodules to the Master branch
1
git submodule foreach --recursive 'git checkout Master || true'
Create the main Virtual Environment and Install Dependencies
1
rye sync
Activate the main Virtual Environment
1
2
3
4
5
6
7
# Windows:
.venv\Scripts\Activate.ps1 # PowerShell
.venv\Scripts\Activate.bat # CMD

# Linux and MacOS:
source .venv/bin/activate # Bash
source .venv/bin/activate.fish # Fish
Start using any Project
1
2
3
broken
shaderflow
depthflow

Something Failed?

Try following the Manual Instructions Tab above, else Get in Touch with me

2. Run any Project

Now simply run broken for a full Command List 🚀

  • Return the Project you want to run for extras

3. Next time, to use the Projects..

You just have to Open a Terminal on the BrokenSource Folder and Source the Virtual Environment

  • Windows:
    • +PowerShell: .venv\Scripts\Activate.ps1
    • +CMD: .venv\Scripts\Activate.bat
  • Linux:
    • +Bash: source .venv/bin/activate
    • +Fish: source .venv/bin/activate.fish
  • MacOS:
    • +Zsh: source .venv/bin/activate


🚀 Upgrading

🌱 Submodules

The installation script should've initialized and set all Submodules to the Master branch

Command
1
git submodule foreach --recursive 'git checkout Master || true'

After that, you can pull the latest changes of all Repositories with

Command
1
git pull --recurse-submodules

You might need to add --force if you want to override Local Changes. Be careful with data loss!

🌱 Virtual Environment

The Python Tooling I chose to Orchestrate the Monorepo is Rye

  • You'll probably only need to know of a single command:

Command: rye sync

This will update the Virtual Environment and Install any new Dependencies