ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

music plugin: add sound volume overrides

Browse Source
This commit is contained in:
Adam
2019-09-21 12:57:56 -04:00
committed by Adam
parent 6fc270dfc2
commit 0145582b41
2 changed files with 141 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
runelite-client/src/main/java/net/runelite/client/plugins/music/MusicConfig.java Normal file
View File

@@ -0,0 +1,79 @@
/*
* Copyright (c) 2019, Adam <Adam@sigterm.info>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.client.plugins.music;
import net.runelite.client.config.Config;
import net.runelite.client.config.ConfigGroup;
import net.runelite.client.config.ConfigItem;
import net.runelite.client.config.Range;
@ConfigGroup("music")
public interface MusicConfig extends Config
{
@ConfigItem(
keyName = "musicVolume",
name = "Music Volume",
description = "Overrides music volume in game with more granular control",
position = 1
)
@Range(
min = 0,
max = 255
)
default int getMusicVolume()
{
return 0;
}
@ConfigItem(
keyName = "soundEffectVolume",
name = "Sound Effect Volume",
description = "Overrides the sound effect volume in game with more granular control",
position = 2
)
@Range(
min = 0,
max = 127
)
default int getSoundEffectVolume()
{
return 0;
}
@ConfigItem(
keyName = "areaSoundEffectVolume",
name = "Area Sound Effect Volume",
description = "Overrides the area sound effect volume in game with more granular control",
position = 3
)
@Range(
min = 0,
max = 127
)
default int getAreaSoundEffectVolume()
{
return 0;
}
}

63
runelite-client/src/main/java/net/runelite/client/plugins/music/MusicPlugin.java
View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2019, Anthony Chen <https://github.com/achencoms>
* Copyright (c) 2019, Adam <Adam@sigterm.info>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -24,6 +25,7 @@
*/
package net.runelite.client.plugins.music;
import com.google.inject.Provides;
import java.util.Arrays;
import java.util.Collection;
import java.util.Comparator;
@@ -37,8 +39,10 @@ import net.runelite.api.ScriptID;
import net.runelite.api.SoundEffectID;
import net.runelite.api.SpriteID;
import net.runelite.api.VarClientInt;
import net.runelite.api.events.ConfigChanged;
import net.runelite.api.events.GameStateChanged;
import net.runelite.api.events.VarClientIntChanged;
import net.runelite.api.events.VolumeChanged;
import net.runelite.api.events.WidgetLoaded;
import net.runelite.api.widgets.JavaScriptCallback;
import net.runelite.api.widgets.Widget;
@@ -47,6 +51,7 @@ import net.runelite.api.widgets.WidgetInfo;
import net.runelite.api.widgets.WidgetPositionMode;
import net.runelite.api.widgets.WidgetType;
import net.runelite.client.callback.ClientThread;
import net.runelite.client.config.ConfigManager;
import net.runelite.client.eventbus.Subscribe;
import net.runelite.client.game.chatbox.ChatboxPanelManager;
import net.runelite.client.game.chatbox.ChatboxTextInput;
@@ -55,7 +60,7 @@ import net.runelite.client.plugins.PluginDescriptor;
@PluginDescriptor(
name = "Music",
description = "Adds search and filter for the music list"
description = "Adds search and filter for the music list, and additional volume control"
)
public class MusicPlugin extends Plugin
{
@@ -65,6 +70,9 @@ public class MusicPlugin extends Plugin
@Inject
private ClientThread clientThread;
@Inject
private MusicConfig musicConfig;
@Inject
private ChatboxPanelManager chatboxPanelManager;
@@ -77,10 +85,17 @@ public class MusicPlugin extends Plugin
private MusicState currentMusicFilter = MusicState.ALL;
private int lastMusicVolume;
private int lastEffectVolume;
private int lastAreaEffectVolume;
@Override
protected void startUp()
{
lastMusicVolume = lastEffectVolume = lastAreaEffectVolume = -1;
clientThread.invoke(this::addMusicButtons);
clientThread.invoke(this::applyMusicVolumeConfig);
}
@Override
@@ -95,6 +110,12 @@ public class MusicPlugin extends Plugin
tracks = null;
}
@Provides
MusicConfig getConfig(ConfigManager configManager)
{
return configManager.getConfig(MusicConfig.class);
}
@Subscribe
public void onGameStateChanged(GameStateChanged gameStateChanged)
{
@@ -167,6 +188,46 @@ public class MusicPlugin extends Plugin
}
}
@Subscribe
public void onVolumeChanged(VolumeChanged volumeChanged)
{
applyMusicVolumeConfig();
}
@Subscribe
public void onConfigChanged(ConfigChanged configChanged)
{
if (configChanged.getGroup().equals("music"))
{
clientThread.invokeLater(this::applyMusicVolumeConfig);
}
}
private void applyMusicVolumeConfig()
{
int musicVolume = musicConfig.getMusicVolume();
// Set the volume if it is >0, or if it was >0 and is now going back to 0
if (musicVolume > 0 || lastMusicVolume > 0)
{
client.setMusicVolume(musicVolume);
lastMusicVolume = musicVolume;
}
int soundEffectVolume = musicConfig.getSoundEffectVolume();
if (soundEffectVolume > 0 || lastEffectVolume > 0)
{
client.setSoundEffectVolume(soundEffectVolume);
lastEffectVolume = soundEffectVolume;
}
int areaSoundEffectVolume = musicConfig.getAreaSoundEffectVolume();
if (areaSoundEffectVolume > 0 || lastAreaEffectVolume > 0)
{
client.setAreaSoundEffectVolume(areaSoundEffectVolume);
lastAreaEffectVolume = areaSoundEffectVolume;
}
}
private boolean isOnMusicTab()
{
return client.getVar(VarClientInt.INVENTORY_TAB) == 13;