Beat Saber 1.11.1 Update (and other things) by Zingabopp · Pull Request #19 · 71/BeatSinger

Zingabopp · 2020-09-13T20:20:34Z

Converted to BSIPA and updated for Beat Saber 1.11.1.
- Depends on SongCore and BS_Utils.
Includes fixes and settings from this fork.
Improvements:
- In-game settings UI.
- Song-specific settings in tab on GameplayModifiers panel.
  - Set timeOffset and timeScale
  - Button to fetch lyrics from online services.
  - Button to save song lyrics settings.
  - Button to test lyric settings from the menu.
- Matches song timescale (faster/slower song).
- Option to save fetched lyrics to JSON in the song directory.
  - lyrics.json can be either a JSON array as before, or a JSON object containing the array and timeOffset and timeScale settings.
- Added shake, color, size, and position settings for lyric text.

Let me know if you want me to do a version bump.
Closes #17
BeatSinger-1.2.0-bs1.11.1-001c3b2.zip

… for local lyrics

…e` buttons to song settings

Zingabopp · 2020-09-14T04:28:17Z

Ok, I think I'm finally satisfied with it. 🙄

71 · 2020-09-14T13:02:21Z

Thanks for all your work! I took a quick look but there are a lot of changes so I'll need some time to review everything. I'm also unable to test changes since I don't have a VR headset anyway, so I'd be glad if someone else can confirm that the changes work as intended.

As for versioning, I originally wanted to use the version scheme <Beat Saber version>.<Beat Singer patch>, so the new version should be 1.11.1.0?

Zingabopp · 2020-09-14T14:28:01Z

You can test with mouse/keyboard if you still own the game using FPFCToggle and MusicEscape.
For the release version, BeatMods requires SemVer for uploaded mods and iirc BSIPA needs it if a mod had BeatSinger as a dependency (unlikely). If neither of those matter then 1.11.1.0 is fine.

ChipWolf · 2020-09-14T23:07:18Z

I've been testing this, there's a strange issue with the BeatSinger mod menu for the song doesn't close correctly if you switch view. It seems to remain open behind the other menus.

Other than that, works perfectly. Thanks for the update!
It would be cool if there was a settings toggle to disable the BeatSinger toggle button or change it to a chord (I keep accidentally hitting it mid-song on the knuckles).

Many thanks

Zingabopp · 2020-09-14T23:28:28Z

I'll probably do something else with the song testing thing. Too much bug potential with moving the main screen out of view.

ChipWolf · 2020-09-15T14:22:42Z

On the Index, it turns out the toggle is bound to squeezing the left controller or pressing the A button on the left controller, squeezing the controller is probably what I kept repeatedly triggering accidentally.

… is relative

Zingabopp · 2020-09-16T02:11:09Z

Latest link up there should fix the lyric testing UI problems.

71 · 2020-09-18T12:28:03Z

+            }
+        }
+
+        public static JSONArray ToJsonArray(this IEnumerable<Subtitle> subtitles)


I don't like this much, since seeing a ToJsonArray in the wild make it seem as if ToJsonArray is a generic function that works for all IEnumerables (and that looks like it "pollutes" the namespace).

If it makes a difference, the extension only works (and shows up in Intellisense) for IEnumerable<Subtitle>. My thinking was Subtitle doesn't care how it's being serialized, so I made that method an extension instead of including it in the Subtitle class.

71

@Zingabopp Thanks! I have a few requests but I only had the time to review the first three commits.

Edit: I forgot to mention this before but I think you should set the new version to 1.2.0, since I was already using 1.1.0.0. Also, this is a pretty significant change so if you're comfortable with it, please add your name to the "authors" sections in metadata.

@ChipWolf There is already a setting for changing the toggle key, but I forgot to document it. In the mod preferences, you can set ToggleKeyCode = 1, replacing 1 with a value from https://github.com/71/BeatSinger/blob/master/BeatSinger/Helpers/ConInput.cs (the values appear to be available here).

71 · 2020-09-18T12:31:18Z


-            var sceneSetupData = (GameplayCoreSceneSetupData)SceneSetupDataField.GetValue(sceneSetup);
+            var sceneSetupData = Access_SceneSetupData(ref sceneSetup);
+            //(GameplayCoreSceneSetupData)SceneSetupDataField.GetValue(sceneSetup);


If your new code works, I think you can remove this (same thing below).

71 · 2020-09-18T12:33:06Z

-
-            if (inputDevices.Exists(x => x.name.IndexOf("rift", StringComparison.InvariantCultureIgnoreCase) != -1))
+
+            if (XRDevice.model.IndexOf("rift", StringComparison.InvariantCultureIgnoreCase) != -1)


I think XRDevice.model is now deprecated.

71 · 2020-09-18T12:35:13Z

@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="utf-8"?>


Where does this file come from? Same question for Directory.Build.props. I suppose it's some shared template?

Yeah, it's a set of build targets I'm including in the BeatSaberModdingTools templates. It's nicer than using post build events when other people are working on the project because it uses BeatSaberDir for the output and does some other things like verifying the version in manifest.json matches AssemblyVersion and automatically zips releases for BeatMods

71 · 2020-09-18T12:50:05Z

+    /// <summary>
+    ///   Container for subtitles.
+    /// </summary>
+    public sealed class SubtitleContainer : IEnumerable<Subtitle>


Looking at its usage, I think we should prefer a completely immutable data structure, so either we only build it when we have all necessary information, or we add a WithSubtitles function which returns a new Container. Overall I like this idea though!

71 · 2020-09-18T12:59:17Z

            if (Settings.VerboseLogging)
                Plugin.log?.Debug($"{level.songName} is {(customLevel != null ? "" : "not ")}a custom level.");
-            if (customLevel != null && LyricsFetcher.GetLocalLyrics(customLevel.customLevelPath, subtitles))
+            SubtitleContainer container = null;


Ideally we'd only have the SubtitleContainer or the subtitles to avoid having to think about both variables in all those possible branches.

The ideal solution IMO is a SubtitleContainer.Builder class that we'd use everywhere instead of List<Subtitle>, but this may be a lot of work for not much.

71 · 2020-09-18T13:08:04Z

            }
            return array;
        }
+        public static JSONObject ToJson(this SubtitleContainer subtitles)


Here and in some other places: please separate methods with an empty line.

(Also in other places but the GitHub code viewer doesn't make it easy to see them: please make sure all indentation is made with spaces instead of tabs, and please make sure all files end with a newline)

MaverickMartyn · 2021-01-14T13:37:57Z

Hi there guys. I miss this mod, and I was wondering what the holdup was?
Is there anything I can do to help?

71 · 2021-01-14T22:30:25Z

I haven't had time to test the changes, especially since I no longer have a VR headset (there are ways to test it, but I haven't gotten around to it). I think the best thing you (probably @Zingabopp if they're interested, since they already fixed what was needed) can do is fork the project. I'll mention the fork on the README if you decide to do that.

MaverickMartyn · 2021-01-15T07:20:12Z

In that case I'll wait a bit and see if @Zingabopp gets back to us. I wouldn't want to steal their thunder by grabbing their changes before they have a chance. :)
Is the project ready to build as is? That way I could compile it for myself until a release is available.

Mint-Martini · 2021-02-14T04:48:22Z

Any word on this, Singing along it beat saber really is one of my favorite things haha

71 · 2021-02-14T09:39:46Z

Given that @Zingabopp hasn't replied in over a month, I think you can take it @MaverickMartyn :)

@Neo4114, I took a very quick look and the mod that @Zingabopp linked in the first comment doesn't seem to do anything sketchy. I don't know if it works, but you can try it out.

Mint-Martini · 2021-02-14T09:44:49Z

@71 Thanks so much for the reply!,
I just dropped the file in my Plugins folder but it doesn't seem to work
I tried compiling it on my end and i am having some issues to build ( Might be me though haha ) Hopefully someone more experienced can pick it up!

to be fair i am running this on the newest version of Beat saber aswell

71 · 2021-02-14T09:54:45Z

Did you drop the .zip file or the .dll inside of it? Make sure it's the .dll. And yeah if the Beat Saber version has changed since then, it might no longer be compatible :(

Mint-Martini · 2021-02-14T21:41:47Z

Sadly yes, :( i just followed standard procedure when dealing with mods ,
Beat Saber is on 1.13.2 (I think ) Ill see if i can compile it, i am pretty familiar with code just not C# , or objects related to beat saber (Or unity in general )

71 · 2021-02-14T22:14:38Z

Alright, good luck! Start by changing BeatSaberDir in BeatSinger/BeatSinger.csproj, it should help resolve most of the dependencies automatically. After that you can try building the project with dotnet and try to fix whatever issues may arise.

Mint-Martini · 2021-02-15T05:22:46Z

Just wanted to give you an update ,
After resolving the dependencies here's what I got ,

It seems that these two dependencies are no longer supported in the base game, Could you give any word on what these actually do (or were intended to do)

My plan would be as follows ,

Figure out what the previous entities are
Find the equivalent class or class rewrite
????
Profit haha

Thanks again for explaining some things

Not sure on why Input is being a pain , ill look into that myself

Here they are in code inside Lyrics component

71 · 2021-02-15T08:19:57Z

Yep, looks like the API slightly changed... To find the new equivalent entities I'd recommend using dnSpy and looking into the assemblies of Beat Saber. That's how I did it:

Determine what i was looking for (e.g. the menu or the Flying Text effect).
Find it in the assembly with dnSpy.
Find classes that contain a field of what I'm looking for. If that class isn't available, start again with that class until I find a class that I can use with FindObjectOfType.

Not sure about Input either. I don't remember, but maybe it's a deprecated Unity API?

Zingabopp and others added 17 commits September 13, 2020 09:36

Updated for Beat Saber 1.11.1, converted to BSIPA

14f0aee

Local lyrics.json can specify timing offset and scale

1ad589e

Update README.md

8466672

Updated installation instructions

c1106fd

Check for null or empty songDirectory when getting local lyrics

0769988

Added local items to .gitignore

40777ca

Added shake, color, size, and position settings

47ab0c2

Kyle's SRT fixes

cb1dcae

Factor in faster/slower song modifer

844fea9

INI file sections

8dbe9ef

Fixed VerboseLogging setting

95fb1e5

BSML settings UI

a43c877

Delete old release zips on build

369a72a

Added gameplay options UI tab to change song TimeOffset and TimeScale…

8c15b2d

… for local lyrics

Refactored some lyrics fetching things. Added Fetch Online and `Sav…

c961abb

…e` buttons to song settings

More refactoring, abstractions, and ability to test lyrics in the menu

9fda6f3

Fixed some UI state bugs

ba92dbc

PreviewController cancellation that probably will never get used

0784b2b

Forgot to add Back button to settings-submenus

e35a78e

Added setting to enable toggle key

fd4ee22

Zingabopp added 4 commits September 15, 2020 18:50

If supported (by a future version of BSML), TimeOffset slider min/max…

f71ff5d

… is relative

Better DragReleaseSupported check

a5ee830

Removed leftover test stuff

6d65fc2

Floating panel with close button for lyrics testing

572ef7a

Fixed oops

c4b9635

71 reviewed Sep 18, 2020

View reviewed changes

71 requested changes Sep 18, 2020

View reviewed changes

Version bump, 1.2.0

001c3b2

71 mentioned this pull request Sep 22, 2021

Beat Saber 1.17? #20

Closed


		if (inputDevices.Exists(x => x.name.IndexOf("rift", StringComparison.InvariantCultureIgnoreCase) != -1))

		if (XRDevice.model.IndexOf("rift", StringComparison.InvariantCultureIgnoreCase) != -1)

Conversation

Zingabopp commented Sep 13, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Zingabopp commented Sep 14, 2020

Uh oh!

71 commented Sep 14, 2020

Uh oh!

Zingabopp commented Sep 14, 2020

Uh oh!

ChipWolf commented Sep 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Zingabopp commented Sep 14, 2020

Uh oh!

ChipWolf commented Sep 15, 2020

Uh oh!

Zingabopp commented Sep 16, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

71 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MaverickMartyn commented Jan 14, 2021

Uh oh!

71 commented Jan 14, 2021

Uh oh!

MaverickMartyn commented Jan 15, 2021

Uh oh!

Mint-Martini commented Feb 14, 2021

Uh oh!

71 commented Feb 14, 2021

Uh oh!

Mint-Martini commented Feb 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

71 commented Feb 14, 2021

Uh oh!

Mint-Martini commented Feb 14, 2021

Uh oh!

71 commented Feb 14, 2021

Uh oh!

Mint-Martini commented Feb 15, 2021

Uh oh!

71 commented Feb 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Zingabopp commented Sep 13, 2020 •

edited

Loading

ChipWolf commented Sep 14, 2020 •

edited

Loading

71 left a comment •

edited

Loading

Mint-Martini commented Feb 14, 2021 •

edited

Loading