Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Kylemc1413/SongCore

A plugin for handling custom song additions in Beat Saber.
https://github.com/Kylemc1413/SongCore

Last synced: 6 days ago
JSON representation

A plugin for handling custom song additions in Beat Saber.

Host: GitHub
URL: https://github.com/Kylemc1413/SongCore
Owner: Kylemc1413
License: mit
Created: 2019-05-19T00:58:10.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-04-12T20:55:29.000Z (7 months ago)
Last Synced: 2024-04-13T22:04:16.906Z (7 months ago)
Language: C#
Size: 1.04 MB
Stars: 85
Watchers: 8
Forks: 47
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# SongCore
A plugin for handling custom song additions in Beat Saber.
## Configuration
- The Settings for SongCore can be found in the `UserData/SongCore` Folder, or in game in the Mod Settings section of the main menu
## Installing Custom Songs
- Custom Song folders go in `Beat Saber_Data/CustomLevels`
- The song files must be in the root of the song folder, and not within a subfolder
- You can place songs in the `Beat Saber_Data/CustomWIPLevels` folder instead to place them in the `WIP Maps` song pack and have them only be playable in practice mode. This is recommended if you are either making the map yourself or testing someone else's map
### Zip Files
- You can place Zip files in `Beat Saber_Data/CustomWIPLevels` and whenever SongCore Loads songs it will attempt to handle them in the following way
- Clearing the `Beat Saber_Data/CustomWIPLevels/Cache` folder of all files
- Extracting the zips to the Cache folder inside of a folder of the same name of the zip
- Attempting to load any songs found within the Cache folder
- If any songs are successfully loaded from the Cache folder, they will show up within a "Cached WIP Maps" LevelPack next to the WIP Maps pack
- This loading is less efficient due to having to extract the zips every time, and occurs before regular loading starts, so be aware that song loading may slow down if you have a large amount of zips in the folder
### Additional Song Folders
- You can specify additional folders to load songs from by modifying the `UserData/SongCore/folders.xml` file, which is generated by SongCore when loading the game if it does not exist
- Example File:
```xml

Example
ExamplePath
0
False
Example

Example
ExamplePath2
1

```
```
Required files:
1. cover.jpg (Size 256x256)
- This is the picture shown next to song in the selection screen.
- The name can be whatever you want, make sure its the same as the one found in info.dat
- Only supported image file formats are JPG and PNG
2. song.ogg
- This is your song you would like to load
- Name must be the same as in info.dat
- Only supported audio file formats are WAV and OGG
- Songe Converter and BeatSaver will convert to EGG
3. easy.dat / normal.dat / hard.dat / expert.dat
- This is the note chart for each difficulty
- Names must match the "_beatmapFilename" in info.dat
- Use a Beat Saber editor to make your own note chart for the song
4. info.dat
- Contains the info for the song
```

### info.dat Explanation

v1.31.0 has recently released info.dat v2.1.0 which adds _colorSchemes and _environmentNames, read the bsmg wiki if you intend to use these features [https://bsmg.wiki/mapping/infodat-format.html#color-schemes](https://bsmg.wiki/mapping/infodat-format.html#info-dat)

```
"_version": - Format Version, below is an example of 2.0.0
"_songName": - Name of your song
"_songSubName": - Text rendered in smaller letters next to song name. "ft. Artist"
"_songAuthorName": - Author of the song itself
"_levelAuthorName": - The person that mapped the note chart
"_beatsPerMinute": - BPM of the song you are using
"_songTimeOffset": - Offset playing the audio (in seconds)
"_shuffle": - Time in number of beats how much a note should shift
"_shufflePeriod": - Time in number of beats how often a note should shift
"_previewStartTime": - How many seconds into the song the preview should start
"_previewDuration": - Time in seconds the song will be previewed in selection screen
"_songFilename": - Filename of the audio file
"_coverImageFilename": - Filename of the cover file
"_environmentName": - Game Environment to be used
Possible environmentNames (-> Name listed in game):
- DefaultEnvironment -> The First
- Origins -> Origins
- TriangleEnvironment -> Triangle
- BigMirrorEnvironment -> Big Mirror
- NiceEnvironment -> Nice
- KDAEnvironment -> KDA
- MonstercatEnvironment -> Monstercat
- DragonsEnvironment -> Dragons
- CrabRaveEnvironment -> Crab Rave
- PanicEnvironment -> Panic

"_customData": {
"_contributors": [
{
"_role": - Role of contributor
"_name": - Name of contributor
"_iconPath": - Filename of icon to use for contributor
}
],
"_customEnvironment" - Custom platform override, will use "environmentName" if CustomPlatforms isn't installed or disabled
"_customEnvironmentHash" - The hash found on ModelSaber, used to download missing platforms
},
"_difficultyBeatmapSets": [
{
"_beatmapCharacteristicName": - Characteristic of the BeatmapSet, Refer to Characteristics further down
"_customData":
{
"_characteristicLabel" : - The name to display for this selected characteristic when the icon is hovered
"_characteristicIconImageFilename" : - The file name of the characteristic icon
},
"_difficultyBeatmaps": [ - DifficultyBeatmaps must be listed in Ascending Oder to show properly in Game
{
"_difficulty": - Name of the Difficulty (Easy/Normal/Hard/Expert/ExpertPlus)
"_difficultyRank": - Rank of the difficulty corresponding to above (1/3/5/7/9)
"_beatmapFilename": - Filename of the associated beatmap
"_noteJumpMovementSpeed": 10,
"_noteJumpStartBeatOffset": 0,
"_customData": {
"_oneSaber" : - true means the level is One Saber, false means the level uses both sabers
"_showRotationNoteSpawnLines" : - false disables the lower note spawn line on rotational maps
"_difficultyLabel" - The name to display for the difficulty in game
Note: Difficulty labels are unique per _beatmapCharacteristicName
"_editorOffset": 0,
"_editorOldOffset": 0,
"_colorLeft": { - The RGB values to override the colors to if the player has custom song colors enabled
"r": 0.013660844415416155,
"g": 0,
"b": 0.07069587707519531
},
"_colorRight": {
"r": 0.0014191981941151946,
"g": 0.14107830811467803,
"b": 0.07064014358987808
},
"_envColorLeft": {
"r": 0.013660844415416155,
"g": 0,
"b": 0.07069587707519531
},
"_envColorRight": {
"r": 0.0014191981941151946,
"g": 0.14107830811467803,
"b": 0.07064014358987808
},
"_envColorLeftBoost": {
"r": 0.013660844415416155,
"g": 0,
"b": 0.07069587707519531
},
"_envColorRightBoost": {
"r": 0.0014191981941151946,
"g": 0.14107830811467803,
"b": 0.07064014358987808
},
"_obstacleColor": {
"r": 1,
"g": 0,
"b": 0
},
Color range for r,g, and b is a 0-1 scale, not 0-255 scale
If a color is not present as an override and the player has overrides enabled,
it will use the color from the player's current color scheme, with the exception
of envLeft and envRight which will first try to use colorLeft / colorRight, the environment boost colors will fallback to the respective environment colors if not used
"_warnings": - Any warnings you would like the player to be aware of before playing the song
"_information": - Any general information you would like the player to be aware of before playing the song
"_suggestions": - Any mods to suggest the player uses for playing the song, must be supported by the mod in question otherwise the player will constantly be informed they are missing suggested mod(s)
"_requirements": - Any mods to require the player has before being able to play the song, must be supported by mod in question otherwise song will simply not be playable
}
}
]
}
```
The following is a template for you to use:
```json
{
"_version": "2.0.0",
"_songName": "Song Name",
"_songSubName": "Ft. Person",
"_songAuthorName": "Artist",
"_levelAuthorName": "Mapper Name",
"_beatsPerMinute": 160,
"_songTimeOffset": 0,
"_shuffle": 0,
"_shufflePeriod": 0.5,
"_previewStartTime": 12,
"_previewDuration": 10,
"_songFilename": "song.ogg",
"_coverImageFilename": "cover.jpg",
"_environmentName": "DefaultEnvironment",
"_customData": {
"_contributors": [{
"_role": "Kirb",
"_name": "Kyle 1413",
"_iconPath": "derp.png"
}, {
"_role": "Lighter",
"_name": "Kyle 1413 The Second",
"_iconPath": "test.png"
}
],
"_customEnvironment": "Platform Name",
"_customEnvironmentHash": ""
},
"_difficultyBeatmapSets": [{
"_customData" : {
"_characteristicLabel" : "MyCharacteristic",
"_characteristicIconImageFilename" : "test.png"
},
"_beatmapCharacteristicName": "Standard",
"_difficultyBeatmaps": [{
"_difficulty": "Easy",
"_difficultyRank": 1,
"_beatmapFilename": "Easy.dat",
"_noteJumpMovementSpeed": 10,
"_noteJumpStartBeatOffset": 0,
"_customData": {
"_oneSaber" : true,
"_showRotationNoteSpawnLines" : false,
"_difficultyLabel": "",
"_editorOffset": 0,
"_editorOldOffset": 0,
"_colorLeft": {
"r": 0.013660844415416155,
"g": 0,
"b": 0.07069587707519531
},
"_colorRight": {
"r": 0.0014191981941151946,
"g": 0.14107830811467803,
"b": 0.07064014358987808
},
"_envColorLeft": {
"r": 0.013660844415416155,
"g": 0,
"b": 0.07069587707519531
},
"_envColorRight": {
"r": 0.0014191981941151946,
"g": 0.14107830811467803,
"b": 0.07064014358987808
},
"_obstacleColor": {
"r": 1,
"g": 0,
"b": 0
},
"_warnings": [],
"_information": [],
"_suggestions": [],
"_requirements": [
"Mapping Extensions"
]
}
}
]
}
]
}
```

## Capabilities
- Note: Make sure to add a requirement if your map uses Capabilities from a mod that are not compatible with the base game! Example being anything from Mapping Extensions

## Beatmap Characteristics
- These control what difficulty set the difficulty is placed under, so if you wanted to include a set of 5 difficulties that were all one saber in addition to a normal set of 5 difficulties, similar to what the OST does, you would give all of the one saber difficultyLevels a characteristic of one saber (The SerializedName of a registered Characteristic is what should be put in the map

## Characteristics Editing
__Characteristic Labels__
- As a mapper, you are able to change the Label and Icon for each given characteristic.
- Add a `_customData` field before the `_difficultyBeatmaps` array to specifcy the characteristics label.
- Both are not required if you only intend to change one.
```
"_customData" : {
"_characteristicLabel" : "30 Degree",
"_characteristicIconImageFilename" : "30Degree.png"
}
```
![image](https://github.com/ModdingPink/SongCoreLegacy/assets/62712899/aa767f0b-c06b-4dcf-b574-1d28cbc9ac10)

__Saber Count__
- You are also able to change the saber count if your map requires it.
- Re-mapping a One Saber map and need it to load properly in the Legacy Characteristic? Apply `"_oneSaber" : true` to the customData and it'll load as a One Saber map!
```
"_customData" : {
"_oneSaber" : true
}
```
- True will always make the level One Saber, false will always make the level have both sabers.

__Rotational Spawn Lines__
- If you require note spawn lines to not be shown due to rotational events within your map, you can apply `"_showRotationNoteSpawnLines" : false` to the customData.
```
"_customData" : {
"_showRotationNoteSpawnLines" : false
}
```
- True will only show the spawn lines if the map has rotational events, false will hide these spawn lines.

__All Directions Environment outside of 90/360__

- Use the v2.1.0 info.dat format to do this by setting one of the `_environmentNames` to an `allDirections` environment such as `GlassDesertEnvironment`.
- Environment Overrides from the player will apply correctly once set.
- Information about the v2.1.0 format can be found [here](https://bsmg.wiki/mapping/infodat-format.html#info-dat).

## Custom Generated Mod Characteristics
- You may encounter map leaderboards with beatmap characteristics for which the map does not contain difficulty files. These characteristics are registered by generative mods. To access and play maps with these characteristics, you need to download their source mod. Do not map to these SerializedNames as it will render your map unplayable by SongCore.

## Keyboard Shortcuts
*(Make sure Beat Saber's window is in focus when using these shortcuts)*
---
* Press Ctrl+R when in the main menu to do a full refresh. (This means removing deleted songs and updating existing songs)
* Press R when in main menu to do a quick refresh (This will only add new songs in the CustomLevels folder)

## For modders
* Extra data contained in songs that are not part of the base game, e.g. requirements, colors, custom platforms, etc. can be accessed using SongCore
```csharp
//To retrieve the data for a song
SongCore.Collections.RetrieveExtraSongData(string levelID, string loadIfNullPath = "");
//This will return the ExtraSongData for the given levelID if it finds it, and if it does not find it, it will attempt
// To load it using the loadIfNullPath if one is provided, otherwise it will return null

//You can also use the below function to specifically get the DifficultyData for a song, which contains information such as requirements that difficulty has
SongCore.Collections.RetrieveDifficultyData(IDifficultyBeatmap beatmap)
// This will attempt to retrieve the DifficultyData, and return null if it does not find one

//You can also use this function to manually load and add the ExtraSongData for a song by giving it the levelID and path which can be found in the CustomSongInfo for a song
SongCore.Collections.AddSong(string levelID, string path, bool replace = false)
// If replace is true it will update an existing ExtraSongData for that song if one is present, otherwise if one already exists it will do nothing
```
* You can add/remove capabilities to your mods for maps to be able to use by doing the following
```csharp
// To register
SongCore.Collections.RegisterCapability("Capability name");
// To remove
SongCore.Collections.DeregisterizeCapability("Capability name");

//If you make a mod that registers a capability feel free to message me on Discord ( Kyle1413#1413 ) and I will add it to the list above
```
* You can register a beatmap characteristic OnApplicationStart by doing the following **Make sure to do this before SongCore loads songs**
```csharp
SongCore.Collections.RegisterCustomCharacteristic(Sprite Icon, "Characteristic Name", "Hint Text", "SerializedName", "CompoundIdPartName");
//For the SerializedName and CompoundIdPartName, as a basic rule can just put the characteristic name without spaces or special characters
//The Characteristic Name will be what mappers put as the characteristic when labelling their difficulties
//If you make a mod that registers a characteristic feel free to message me on Discord ( Kyle1413#1413 ) and I will add it to the list above
```
* You can add a song folder entry for songcore to load songs from by doing the following as early as OnApplicationStart **Make sure to only call this once**. It will return a reference to the SeperateSongFolder it adds that your mod can use to check the levels loaded within the folder entry after SongCore loads songs.
```csharp
SongCore.Collections.AddSeperateSongFolder("Name of the Entry/Levelpack if set to be its own", "Full path to the folder songs will be stored in", Pack(Refer to folders.xml documentation), Sprite Image(Optional, if null defaults to folder icon), bool wip (Optional) )
```