Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Work-in-Progress Mapping Guide #37

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,5 @@ App Store Submission/Archived Builds



.vs/*
.vs/*
.idea/*
48 changes: 48 additions & 0 deletions MAPPING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Mapping for osu!stream

Mapping for osu!stream is quite a bit more involved as there is no built in Editor for Beatmaps to be made, this guide will walk you through how to create maps for osu!stream.

This guide assumes you know how to get osu!stream to build, at least for Desktop.

## Map Structure

Maps in osu!stream are structured a little differently when it comes to spread. There are 4 difficulty levels:
* Easy
* Normal
* Hard
* Extreme

Easy and Extreme are self explanatory, Normal and Hard are both for the **Stream** difficulty, the Lower Stream is the Normal difficulty, this is also the starting difficulty in Stream Mode. Hard difficulty is then the higher stream.

When those switches occur is entirely up to the Mapper to decide and is something we'll touch on later.

Your map also ***has*** to have a audio file named audio.m4a in its map directory.

### Regarding Difficulty Names

Important to mention is that your Beatmap **has** to adhere to those difficulty names, otherwise you will not be able to Package the Beatmap and play it in osu!stream.
So your Beatmap has to have all those difficulties with those exact names.

### Consequences for not adhering

Not having a difficulty will either lock you out from playing your Beatmap in a certain Difficulty Level (for example, when you're missing the Easy or Expert difficulty, you will not be able to play either of those Modes) or in Stream mode the higher stream won't be accessible.

# Mapping workflow

For the most part, you will be using the osu! Editor you most likely are familiar with, alongside BeatmapCombinator and StreamTester

### BeatmapCombinator

BeatmapCombinator is the program which you use to Package your Beatmaps into .osz2 files which osu!stream deals with

**Usage:**

Drag and Drop your Beatmap folder with all your .osu files which should all have the earlier specified Difficulty names and the audio.m4a file inside. After that it should give you back a .osz2 file which you can use for osu!stream

### StreamTester

StreamTester is a convinient little program for quickly Test-playing maps,

<p align="center">
<img src="Readme Pictures/StreamTester.png">
</p>
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ While contributions are welcomed I likely won’t have time to review anything t
- Bringing the `arcade` branch up-to-date and potentially merging changes back into master.
- Documentation of any kind.
- Code quality improvements of any kind (as long as they can easily be reviewed and are guaranteed to not change behaviour). Keep individual PRs under 200 lines of change, optimally.
- Adding full android support (there's a wip branch but it's so outdated I think starting from zero would be easier). Note that this should not degrade the quality of existing code as much as possible, so above tasks may need to come first.

## Running

Expand Down
Binary file added Readme Pictures/StreamTester.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion osu!stream/Main.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
using osum.Audio;
using osum.Graphics;
using osum.Support.Android;

#if ANDROID
using osum.Support.Android;
using Android.App;
using Android.OS;
using Android.Support.V7.App;
Expand Down