BSManager

https://github.com/zagrios/bs-manager
Admin
BSManager simplifies your Beat Saber experience by centralizing the management of mods, maps, and...
Tokens:7,667
Snippets:160
Trust Score:8.8
License:GPL-3.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install project tools and dependencies

Source: https://github.com/zagrios/bs-manager/blob/master/CONTRIBUTING.md

Use these commands to set up the development environment after cloning the repository.

```bash
mise install
```

```bash
npm ci
```

--------------------------------

### Install BSManager via APT

Source: https://github.com/zagrios/bs-manager/wiki/Guides/Installation-and-updates/install-bsmanager-on-linux/install-bsmanager-on-linux

Standard command to install the package after adding the repository.

```bash
sudo apt install bs-manager
```

--------------------------------

### Install BSManager via Flatpak

Source: https://github.com/zagrios/bs-manager/wiki/Guides/Installation-and-updates/install-bsmanager-on-linux/install-bsmanager-on-linux

Command to install the downloaded .flatpak file.

```bash
flatpak install --user ./bsmanager.flatpak
```

--------------------------------

### Install Ubuntu/Debian prerequisites and build DEB

Source: https://github.com/zagrios/bs-manager/blob/master/CONTRIBUTING.md

Commands for setting up Ubuntu 24.04/Debian and building the native DEB package.

```bash
sudo apt update
sudo apt install -y build-essential libarchive-tools python3
```

```bash
npm run build
npx electron-builder --config electron-builder.config.js --publish never --linux deb --x64
```

--------------------------------

### Install BSManager via dpkg

Source: https://github.com/zagrios/bs-manager/wiki/Guides/Installation-and-updates/install-bsmanager-on-linux/install-bsmanager-on-linux

Manual installation command for downloaded .deb files.

```bash
dpkg -i ./bsmanager.deb
```

--------------------------------

### Install Fedora prerequisites and build RPM

Source: https://github.com/zagrios/bs-manager/blob/master/CONTRIBUTING.md

Commands for setting up Fedora 44 and building the native RPM package.

```bash
sudo dnf install -y binutils gcc-c++ libxcrypt-compat make python3 rpm-build
```

```bash
npm run build
npx electron-builder --config electron-builder.config.js --publish never --linux rpm --x64
```

--------------------------------

### Install Arch Linux prerequisites and build pacman package

Source: https://github.com/zagrios/bs-manager/blob/master/CONTRIBUTING.md

Commands for setting up Arch Linux and building the native pacman package.

```bash
sudo pacman -Syu --needed base-devel libarchive libxcrypt-compat python
```

```bash
npm run build
npx electron-builder --config electron-builder.config.js --publish never --linux pacman --x64
```

--------------------------------

### Create a feature branch

Source: https://github.com/zagrios/bs-manager/blob/master/CONTRIBUTING.md

Follow the naming convention for branches when starting new work.

```bash
git checkout -b (feature|bugfix|hotfix|chore)/(short-description)(/issue-id)
```

--------------------------------

### Run BSManager via nix-shell

Source: https://github.com/zagrios/bs-manager/wiki/Guides/Installation-and-updates/install-bsmanager-on-linux/install-bsmanager-on-linux

Command to execute BSManager without permanent installation on Nix systems.

```bash
nix-shell -p bs-manager --run bs-manager
```

--------------------------------

### Clone the repository

Source: https://github.com/zagrios/bs-manager/wiki/Guides/Contribution/Help-us-update-the-wiki/help-us-update-the-wiki

Use these commands to download your fork to your local machine and navigate into the directory.

```bash
git clone https://github.com/[your-username]/[repository-name].git
cd [repository-name]
```

--------------------------------

### Development and packaging commands

Source: https://github.com/zagrios/bs-manager/blob/master/CONTRIBUTING.md

Standard commands for running the application in development mode or packaging it for distribution.

```bash
npm start
```

```bash
npm run package
```

```bash
npm run build
npx electron-builder --config electron-builder.config.js --publish never --linux <deb|rpm|pacman> --x64
```

```bash
npm run publish
```

```bash
npm run publish:flatpak
```

--------------------------------

### Create a batch file for taskbar shortcuts

Source: https://github.com/zagrios/bs-manager/wiki/Guides/Installation-and-updates/Create-a-shortcut/Create-a-shortcut

Use this batch script template to launch a specific BSManager version link from the taskbar.

```bat
@echo off
start <version link>
```

--------------------------------

### Commit and push changes

Source: https://github.com/zagrios/bs-manager/wiki/Guides/Contribution/Help-us-update-the-wiki/help-us-update-the-wiki

Use these commands to stage, commit, and push your local edits to your GitHub fork.

```bash
git add .
git commit -m "Describe your changes here"
git push origin master
```

--------------------------------

### Add BSManager PPA Repository

Source: https://github.com/zagrios/bs-manager/wiki/Guides/Installation-and-updates/install-bsmanager-on-linux/install-bsmanager-on-linux

Commands to add the PPA repository and update the package list on Debian-based systems.

```bash
curl -fsSL https://raw.githubusercontent.com/silentrald/bs-manager-deb/refs/heads/main/KEY.gpg | sudo gpg --dearmor -o /usr/share/keyrings/bs-manager.gpg
echo "deb [signed-by=/usr/share/keyrings/bs-manager.gpg] https://raw.githubusercontent.com/silentrald/bs-manager-deb/refs/heads/main ./" | sudo tee /etc/apt/sources.list.d/bs-manager.list
sudo apt update
```

--------------------------------

### Verify changes before submission

Source: https://github.com/zagrios/bs-manager/blob/master/CONTRIBUTING.md

Run these commands to ensure code quality and functionality before opening a pull request.

```bash
npm run build
npm test -- --runInBand
npm run lint
npm audit --omit=dev
```

--------------------------------

### Configure Flathub Remote

Source: https://github.com/zagrios/bs-manager/wiki/Guides/Installation-and-updates/install-bsmanager-on-linux/install-bsmanager-on-linux

Commands to add the Flathub remote if package resolution fails.

```bash
sudo flatpak remote-add --if-not-exists --system flathub https://flathub.org/repo/flathub.flatpakrepo

# or

flatpak remote-add --if-not-exists --user flathub https://flathub.org/repo/flathub.flatpakrepo
```

--------------------------------

### Set SUID permissions for chrome-sandbox

Source: https://github.com/zagrios/bs-manager/wiki/Troubleshoots/Installation-Problems/Linux/[Linux]-[deb]-The-SUID-Sandbox-Helper-Binary-Was-Found/[Linux]-[deb]-The-SUID-Sandbox-Helper-Binary-Was-Found

Adjusts the permissions of the chrome-sandbox binary to resolve sandbox-related execution errors.

```bash
chmod 4755 /opt/BSManager/chrome-sandbox
```
Tokens:
Raw