Skip to content

Commit c1b7e07

Browse files
committed
final revisions
1 parent cb5fc77 commit c1b7e07

File tree

4 files changed

+55
-32
lines changed

4 files changed

+55
-32
lines changed

wiki/mapping/map-format.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ to ensure that legacy versions of a schema will work as intended in future updat
2626
These schemas are also enforced when uploading your map to [BeatSaver](https://beatsaver.com/)
2727
in order to determine whether or not your map is appropriate for upload.
2828

29-
::: warning
29+
::: tip
3030
While legacy schemas are internally supported by the base game,
3131
it's recommended that mappers and developers prioritize support for the latest available version(s) of the schema,
3232
as **legacy schemas are not guaranteed to receive proper support or maintenance for new features or bugfixes**.
@@ -90,6 +90,16 @@ For all collections, objects use abbreviated fields to define subsequent propert
9090

9191
### v4
9292

93+
::: danger DISCLAIMER
94+
While support for this schema has been officially introduced to custom levels as of the latest update,
95+
some aspects of its implementation are still relatively unknown or have been deemed unstable
96+
based on community testing and indications from the official developers.
97+
98+
This means that any potential support or widespread adoption of the schema by mods, editors, or other services
99+
(Offical Editor, ChroMapper, BeatSaver, etc.)
100+
may either be unavailable or delayed at this time.
101+
:::
102+
93103
The "v4" schema was introduced in the **1.34.5** update,
94104
and completely reworks the serialization of all beatmap items.
95105

wiki/mapping/map-format/beatmap.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
The beatmap file defines collections and associated metadata for all _interactable_ beatmap items,
77
such as notes and obstacles.
88

9-
::: warning
9+
::: info
1010
In v4 and later,
1111
any collections for non-interactable beatmap objects are located in the corresponding [Lightshow](./lightshow.md) file.
1212
You can refer to the sample files included there
@@ -581,7 +581,7 @@ If the head of a chain matches a note's time and position,
581581
then the chain will connect with the note and alter how the note is scored.
582582

583583
::: tip
584-
In v4, the metadata for the head and tail notes are pulled from the [Color Notes](#color-notes) collection.
584+
In v4, the metadata for the head note is pulled from the [Color Notes](#color-notes) collection.
585585
:::
586586

587587
::: code-group
@@ -688,24 +688,29 @@ Indicates the direction the player should swing to successfully cut the head of
688688

689689
An integer value which represents the number of segments in the chain. The head counts as a segment.
690690

691-
- A value of `1` will create a chain with no links,
692-
but will still affect the visual look and scoring potential of the head note.
691+
::: warning
692+
A value of `1` will create a chain with no links,
693+
but will still affect the visual look and scoring potential of the head note.
694+
:::
693695

694696
### Squish Factor {#chains-squish-factor}
695697

696698
An integer value which represents the proportion of
697699
how much of the path from `(x, y)` to `(tx, ty)` is used by the chain.
698700
This does not alter the shape of the path.
699701

700-
- A value greater than `1` will extend the path beyond the specified end point.
701-
- A value of `0` will crash the game.
702+
Any value greater than `1` will extend the path beyond the specified end point.
703+
704+
::: danger
705+
A value of `0` will crash the game.
706+
:::
702707

703708
## Spawn Rotations
704709

705710
Allows you to rotate the position where interactable objects should spawn.
706711

707-
::: warning
708-
These events are assumed to be deprecated starting from v4,
712+
::: info
713+
While these events are technically available in v4, they are assumed to be deprecated
709714
in favor of a new object-level syntax for assigning lane rotations to individual objects.
710715
:::
711716

@@ -793,7 +798,7 @@ Controls the magnitude and direction of the lane rotation.
793798

794799
A negative value will turn the player counter-clockwise, and a positive value will turn clockwise.
795800

796-
::: tip
801+
::: info
797802
For v2, the magnitude is determined by an enumerated value,
798803
of which all possible values are listed in the corresponding table for [Basic Events](./lightshow.md#rotation-events-legacy-value).
799804
:::
@@ -802,7 +807,7 @@ of which all possible values are listed in the corresponding table for [Basic Ev
802807

803808
Allows you to alter the BPM of the chart at the indicated time.
804809

805-
::: warning
810+
::: info
806811
These events are deprecated in v4 or later,
807812
in favor of automated BPM calculations as determined by the [Audio](./audio.md) file.
808813
:::

wiki/mapping/map-format/info.md

+19-11
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ The artist(s) of your song.
115115

116116
## Related Files
117117

118-
::: tip
118+
::: info
119119
All filename references are assumed to be located in the same relative directory as the info file.
120120
:::
121121

@@ -361,10 +361,10 @@ which can be defined on a per-beatmap level using the same template-like index a
361361
All color properties are normalized to a range of `0-1`.
362362

363363
::: warning
364-
Any colors in the scheme that are not defined will appear as a "null" color in-game, and may cause unintended effects.
364+
Any colors in a scheme that are not defined will appear as a "null" color in-game, and may cause unintended effects.
365365
:::
366366

367-
::: warning
367+
::: danger
368368
For v4, **you must define at least one valid color scheme for your map to load properly**,
369369
regardless of whether the map explicitly sets a color scheme override.
370370
:::
@@ -514,8 +514,9 @@ organized by their [characteristic](#characteristic) and [difficulty](#difficult
514514
For v2, all beatmaps are grouped into "sets",
515515
which dictate corresponding behaviors to apply at a higher level to all beatmaps located within that set.
516516

517-
This behavior went unused in the base-game throughout the lifetime of the schema,
518-
and support was subsequently removed in v4.
517+
Support for beatmap sets was subsequently removed in v4,
518+
due to set-specific behaviors being exclusively controlled by the defined characteristic
519+
and no additional fields being introduced for beatmap sets throughout the lifetime of the schema.
519520

520521
::: code-group
521522

@@ -542,12 +543,18 @@ and support was subsequently removed in v4.
542543
The level file associated with your map.
543544
Must point to a valid JSON file.
544545

545-
::: tip
546+
::: info
546547
Starting from v4, all corresponding beatmap data will be divided into two separate files:
547548

548-
- A [Beatmap](./beatmap.md) file, for interactable objects.
549-
- A [Lightshow](./lightshow.md) file, for non-interactable objects.
550-
:::
549+
- A [Beatmap](./beatmap.md) file, for interactable objects (such as notes and obstacles).
550+
- A [Lightshow](./lightshow.md) file, for non-interactable objects (such as lighting and environment effects).
551+
552+
:::
553+
554+
::: info
555+
If a v2 or v3 beatmap file is defined, the lightshow file will subsequently be ignored,
556+
since v2 and v3 beatmap files already contain the relevant lighting objects for the beatmap.
557+
:::
551558

552559
::: code-group
553560

@@ -597,13 +604,14 @@ The list of acceptable values and their corresponding behaviors are listed below
597604

598605
<!-- markdownlint-enable MD013 -->
599606

600-
::: warning
607+
::: danger
601608
Some mods may add additional characteristics that are not supported within the base game,
602609
such as SongCore's `Lightshow` and `Lawless` characteristics.
603610

604611
When loading maps with these characteristics on un-modded versions of the game,
605612
affected maps will not be compatible with the Official Editor,
606-
and affected beatmaps may be filtered out of the available difficulties for the player to select in-game.
613+
and affected beatmaps may be filtered out of the available difficulties for the player to select in-game
614+
or fail to load correctly on un-modded instances.
607615
:::
608616

609617
::: code-group

wiki/mapping/map-format/lightshow.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Similar to the beatmap file,
99
the lightshow file defines collections and associated metadata for all _non-interactable_ beatmap items,
1010
such as environment objects and lighting effects.
1111

12-
::: warning
12+
::: info
1313
In v3 and earlier,
1414
any collections for non-interactable beatmap objects are located in the corresponding [Beatmap](./beatmap.md) file.
1515
You can refer to the sample files included there
@@ -140,7 +140,7 @@ For more information on how these events are assigned on a per-environment level
140140
[Environment Previews](../basic-lighting.md#environment-previews) section.
141141
:::
142142

143-
::: warning
143+
::: info
144144
Types `5`, `14`, `15`, and `100` are deprecated in v3 or later,
145145
in favor of more flexible data structures for the respective behaviors.
146146
:::
@@ -212,7 +212,7 @@ See [Color Boost Events](#color-boost-events) for more details.
212212
| `0` | Disable Color Boost |
213213
| `1` | Enable Color Boost |
214214

215-
::: warning
215+
::: info
216216
These events are deprecated in v3 or later, in favor of more robust implementations and data structures in future schemas.
217217
:::
218218

@@ -232,7 +232,7 @@ See [Spawn Rotations](./beatmap#spawn-rotations) for more details.
232232
| `6` | 45 Degrees Clockwise |
233233
| `7` | 60 Degrees Clockwise |
234234

235-
::: warning
235+
::: info
236236
These events are deprecated in v3 or later,
237237
in favor of an updated syntax that allows for more freedom for the available increments of lane changes.
238238
:::
@@ -248,7 +248,7 @@ A value of 0 will turn the light off.
248248

249249
#### BPM Events (Legacy) {#bpm-events-legacy-float-value}
250250

251-
The value is used to alter the BPM at the indicated beat. See [BPM Events](#bpm-events) for more details.
251+
The value is used to alter the BPM at the indicated beat. See [BPM Events](./beatmap.md#bpm-events) for more details.
252252

253253
<!-- markdownlint-enable MD013 -->
254254

@@ -312,7 +312,7 @@ Determines whether the color boost effect is enabled.
312312
Used to control the TinyTAN figures that are exclusive to the BTS environment.
313313

314314
::: tip
315-
For more detailed information on implementation, check out the following [document](https://docs.google.com/spreadsheets/d/1spW7LS-RvenLQBVXJl9w_iOwqr9r_ozxYo3JUlXq9Lc).
315+
For more detailed information on how to control the TinyTAN figures, check out the following [document](https://docs.google.com/spreadsheets/d/1spW7LS-RvenLQBVXJl9w_iOwqr9r_ozxYo3JUlXq9Lc).
316316
:::
317317

318318
::: code-group
@@ -1284,9 +1284,9 @@ This allows the event box to pull its corresponding base event data from the col
12841284
For example, setting `l` to `[0, 1]` will pull the data from the first two base events defined in the collection,
12851285
where those base events will become children of the event box.
12861286

1287-
::: warning
1288-
While this schema supports defining a collection of "integer" FX events, their implementation went unused in v3,
1289-
and support was subsequently removed in v4.
1287+
::: info
1288+
While v3 technically supports defining a collection of "integer" FX events,
1289+
their implementation went unused, and support was subsequently removed in v4.
12901290
:::
12911291

12921292
::: code-group
@@ -1438,7 +1438,7 @@ when overriding the environment to a different one than what was assigned in the
14381438
Any environments that feature event box groups will have this setting disabled by default in the Official Editor,
14391439
while use of "legacy" environments will leave this setting enabled.
14401440

1441-
::: info
1441+
::: tip
14421442
Unlike the [basic lighting system](#basic-events), the [group lighting system](#event-box-groups) does not guarantee
14431443
that group assignments will be cross-compatible with other environments,
14441444
which may cause certain lightshows to produce unintended effects and unwanted behaviors as a result.

0 commit comments

Comments
 (0)