How to use the converter? - Corne2Plum3/fnf2osumania GitHub Wiki

How to use the converter?

To see how to run the program, check this section.

1. Fill the inputs

This is the window with a lot of inputs: files, entries, numbers. You need to fill all of them (excpect the ones with '(optional)').

usage_example

Metadata

Some data about the song, and the mapset in general.

Song title

The title of the song. (what you excepted...)

Song artist (optional)

The artist of the song. If you don't know, let this entry empty, and in the generated .osz, the artist will be repaced by "Unknown".

The song artist of the official weeks 1-7 is Kawai Sprite btw.

Username (optional)

Because an osu! mapset is linked to 1 creator, put your osu! username on it.

Audio settings

Audio related settings. Note that FnF usually uses 2 audio files, so be sure to pick both of them if they're both used.

Audio file 1

The audio file 1. Must be an .ogg file.

In this kind of input, you have an entry where you can type the full path to the file, or you can click on the 'Set' button to open the file explorer and pick the file from it. The entry will be automatically filled.

Audio file 2 (optional)

The second audio file (if used but it's very common). Must be an .ogg file.

Volume audio 1

Value in % of the audio 1's volume.

With some mods you can change the volume of instruments and voices. Be sure to know what you're doing before changing it.

Volume audio 2

Same than audio 1 but with the audio 2.

To avoid the audio quiet, we strongly recommanded to keep at least one of the 2 volume at 100%.

Advanced settings

Complicated settings...

Audio offset

If you think the audio and the notes aren't perfectly sync, try to adjust this value by moving the audio. The audio's move is in milliseconds.

Meter

The meter of the song. The converter allows you to set only 1 meter for the whole song. The value must be in the format "n/4" where n is a number between 1 and 7 included. You can use the arrows at the right to change this value too.

This setting doesn't affects the gameplay, unless you play with Nightcore mods (which add beat sounds), where you will hear a different beat sound every n beats.

Unique BPM value

If you are sure that the song doesn't include tempo changes, it's highly recommended to check this option, because looking directly at the .json file may generate wrong or duplicate BPM timing points in the osu file.

If this option is enabled, the .osu will include only 1 timing points, placed the earlier possible in the song. It's cleaner, ngl.

Then you have to set the value of the BPM with the number input below. If you know the BPM of the song, type it here. You can also click the 'auto' button to get the BPM automatically (at least trying, but it works well in most of cases...)

This setting doesn't affects the gameplay (because notes are based with the time, not with the BPM), unless you play with Nightcore mods (which add beat sounds), where you will hear unsync beat sounds if the BPM is wrong.

Difficulties

At the top right of the window, you can see the list of all difficulties that will be created.

Note: you need at least 1 difficulty to be able to export the mapset.

You can add one by clicking the 'Add difficulty' button. Then you will have a window like this:

new_diff

Each difficulty have 3 settings:

  • Difficulty name: name of the difficulty. It must be unique and can't be similar to another difficulty.
  • Map type: see Map types. Just don't let the 'Choose an option' value.
  • JSON file: the full path to the FnF chart file (a .json file) of the difficulty you want. You can click the 'Set JSON file' button to open the file explorer and pick a file.

Sometimes, when you use the 'Set JSON file' button, sometimes the windows disappears. Don't worry, the window was moved behind the main window. Move this window until you see the New Difficulty window again.

Selected difficuly

In this section below the difficulty list, you can still edit the difficulty. To do that, choose a difficulty from the list, its settings will appears here.

The options are similar than the New Difficulty Window, with the 'Set JSON file' button, but:

  • To save your modifications of the selected difficulty, press 'Apply'. To discard your modifications, press 'Discard'. DON'T select another difficulty from the list BEFORE you pressed 'Apply', because your modifications will be discarded if you do that.
  • You can also delete the selected difficulty with the red 'Delete' button. Caution: a deleted difficulty can't be restored.

Export settings

A few settings that will affects only the future generated .osz file. There is also the 'Export .osz' button here.

Background (optional)

Choose a background for the whole mapset. Must be a .jpg file.

2. Exporting as .osz

Once you filled all inputs like above, now you can create the .osz file that you will import to your osu! game.

Just press 'Export .osz'.

Before starting the export, the program will check if all inputs are valid, and if there is at least 1 error, you will get a error message (note that it shows only the 1st problem found).

If the check is passed, a small window like this will appears. Now you just have to wait. The duration may varies (~30-60 seconds with a potato). The .osz will be in the same folder than the main.py script. Important: if you're using the .exe file (Windows executable), some black windows called ffmpeg.exe will spawn and dissapear after a short time. DO NOT CLOSE THEM MANUALLY, else the program will crash.

If you want to stop the export, close that window or press the red 'Cancel' button. The generated files will be deleted.

Note that stopping the export may take a few seconds. Just wait.

3. Importing the song in osu!

Just drag the .osz file into osu! or open the .osz with osu!.

After that, enjoy :)

screenshot639

4. Fix timing (optional)

Sometimes, the BPM is wrong and the notes aren't perfectly sync (the eventually issues are from the files, I can't do anything from that). To fix that, we will use the osu! editor. Guide: Fix the timing