https://github.com/ckosmic/CustomEnergyBars

A Beat Saber mod that adds custom energy bars
https://github.com/ckosmic/CustomEnergyBars

Last synced: about 2 months ago
JSON representation

A Beat Saber mod that adds custom energy bars

• Host: GitHub
• URL: https://github.com/ckosmic/CustomEnergyBars
• Owner: ckosmic
• License: mit
• Created: 2021-04-30T09:36:44.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-02-07T22:10:53.000Z (over 2 years ago)
• Last Synced: 2024-07-14T03:32:35.949Z (3 months ago)
• Language: C#
• Size: 2.95 MB
• Stars: 17
• Watchers: 3
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Custom Energy Bars

A Beat Saber mod that adds custom energy bars to the game.

## Installation

* Install SiraUtil and BSML via ModAssistant or manually

* Download the [latest release](https://github.com/ckosmic/CustomEnergyBars/releases/latest) from the releases page

* Drop the file into the Plugins folder in your Beat Saber directory

To install custom energy bars, place a `.energy` file into the CustomEnergyBars folder located in your Beat Saber directory.  If this folder doesn't exist, either create it yourself or run Beat Saber at least once with the mod installed.

## Creating your own Custom Energy Bar

Refer to the [wiki](https://github.com/ckosmic/CustomEnergyBars/wiki) to learn how to make a custom energy bar.

## Example bars

* [Energy bars made by me](https://github.com/ckosmic/CustomEnergyBars/tree/master/Resources/ExampleBars)

* Check out more under #other-files and #mod-assets in BSMG and also over at [Bobbie's website](https://bobbie.dev/misc)!

## For developers

### Contributing to CustomEnergyBars (info taken from [CustomSabers](https://github.com/nalulululuna/CustomSaberPlugin))

In order to build this project, please create the file CustomEnergyBar.csproj.user in the project directory and add your Beat Saber directory path to it. This file should not be uploaded to GitHub and is in the .gitignore.

```xml 

  

    

    D:\Program Files (x86)\Steam\steamapps\common\Beat Saber

  

```

To build the Unity plugin, make sure your CustomEnergyBarUnityPlugin.csproj.user contains a definition for `UnityEditorDir`.

```xml

  

    D:\Program Files (x86)\Steam\steamapps\common\Beat Saber

	D:\Program Files\Unity Editors\2018.1.6f1\Editor

  

```

If you plan on adding any new dependencies which are located in the Beat Saber directory, it would be nice if you edited the paths to use $(BeatSaberDir) in CustomEnergyBar.csproj.

```xml 

...

  $(BeatSaberDir)\Plugins\BS_Utils.dll

  $(BeatSaberDir)\Beat Saber_Data\Managed\IPA.Loader.dll

...

```