Skip to content
This repository has been archived by the owner on Jan 22, 2023. It is now read-only.

Latest commit

 

History

History
136 lines (106 loc) · 5.36 KB

README.md

File metadata and controls

136 lines (106 loc) · 5.36 KB
Raw

Note: This repository is not maintained and is not compatible with current BombSquad versions (>v1.5). See https://github.com/bombsquad-community/plugin-manager for a modern alternative.

BombSquad Community Mod Manager

What is it?

This is a mod for the game BombSquad by Eric Froemling that aims to improve the management of community created content for BombSquad.

It's build using the modding api so it can be used on all platforms and should be compatible with all recent versions of BombSquad.

A list of all mods can be viewed here, you can also filter by category (all minigames) or view specific mods (mod manager).

Installation

Put installer.py in your mods folder. This file will download and install the Mod-Manager and its dependencies. You can find your mods folder in Settings > Advanced > Show Mods Folder.

Note:
On Android M or higher you'll need to give BombSquad access to the storage. You can do that by clicking on `Settings > Advanced > Show Mods Folder` or enabling it manually in the system settings.
Platform Path
OS X ~/Library/Containers/net.froemling.bombsquad/Data/Library/Application Support/BombSquad/mods
Android <sdcard>/BombSquad/mods
Windows %appdata%/BombSquad/mods
Linux ~/.bombsquad/mods

One-Liners

OSX 
cd ~/Library/Containers/net.froemling.bombsquad/Data/Library/Application\ Support/BombSquad/mods && curl -O https://raw.githubusercontent.com/Mrmaxmeier/BombSquad-Community-Mod-Manager/master/utils/installer.py
Linux (wget) 
wget -P ~/.bombsquad/mods https://raw.githubusercontent.com/Mrmaxmeier/BombSquad-Community-Mod-Manager/master/utils/installer.py
Linux (curl) 
cd ~/.bombsquad/mods && curl -O https://raw.githubusercontent.com/Mrmaxmeier/BombSquad-Community-Mod-Manager/master/utils/installer.py
Windows (PowerShell) 
wget https://raw.githubusercontent.com/Mrmaxmeier/BombSquad-ModManager-and-Mods/master/utils/installer.py -OutFile $env:APPDATA/BombSquad/mods/installer.py

Usage

After restarting BombSquad there should be a new button in the settings window. Settings Window Upon clicking this button a new window pops up. ModManager Window You can download, install or delete mods here.

Tabs

The mods are grouped in three categories:
Minigames Installing these will add games to the game select screen.
Utilities These are mods that add UI elements or other non game related things
Libraries These are mods that can be used as libraries by other mods.

You can also view all mods using the 'all' tab.

Settings

There is a settings button in the mod manager window.
Setting More infos
Branch A List of all available branches can be found here
Auto check for updates This will check for updates while BombSquad is starting
Auto-update old mods This will update mods with versions that are known to be old. <br >Mods you are developing won't get updated by this.

Contributing

Want to contribute? Great!

  1. Fork it
  2. Create a new file in the mods folder
  3. Add a json file with additional infos (optional)
  4. Open a Pull Request
  5. Profit

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org>