Skip to content

potatoTeto/fur2uge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fur2uge

Convert Furnace .fur modules into hUGETracker .uge modules

fur2uge is a conversion tool for Furnace .uge modules to hUGETracker .uge. The tool is designed to allow Furnace users to convert their project files to hUGETracker project files, so that they can be exported for homebrew use (including GB Studio).

Download

https://github.com/potatoTeto/fur2uge/releases

Features

  • Automatic volume column->effect conversion (If an effect is also on the row, the volume will get overwritten)
  • All .uge effects supported, minus Callback Routines and Global Volume
  • Note that this is not a perfect conversion tool: It is designed to convert at least 90% of the work; some adjustments may be expected to get it to sound ideal. To ensure reliable debugging/accuracy, please remember to test your music in the bgb emulator!

Usage

Casual Usage

Place all of your prepared .fur files in the /input/ folder, located at the same location that the program is. Double-click on convert.bat to get the files in the /output/ folder.

Terminal Usage

fur2Uge --i <input>.fur --o <output>.uge

Command Line Arguments

--d <DPath> - Output the zlib-decompressed .fur file, too. If <DPath> is not specified, the program will output the decompressed .fur to the output .uge file's directory.

--pan <channelNumber> - Pan Macros will only work on the channel specified by (0-3). By default, it only works on Pulse 1.

--v <0 or 1> - If Disabled (0), a new instrument will not be made when considering the .fur's volume column. Please keep in mind that .uge limits users to 15 instruments per channel type (Duty/Wave/Noise). By default, this is Enabled (1).

--u <VersionNum 0-6> - Specify the output .uge Version. (Versions <=5 do not support Sub-patterns/Furnace macros!)

Caveats

  • All patterns must have 64 rows. They cannot be increased or decreased. However, cutting the pattern short with Dxx and Bxx is allowed.
  • No more than 15 different unique instruments may be played per channel (Pulse 1 & 2 combined may only have 15 instruments). A single instrument playing on all 4 channels will count as 3 instruments (Pulse, Wave, Noise).
  • Only up to 16 waveforms are allowed. They must be exactly 32 blocks in length, with a height of 16 (0-F)
  • Only hardware envelopes are allowed for Pulse 1, Pulse 2, and Noise. “Initialize Envelope on Every Note” must be enabled.
  • Hardware sequence is allowed, but only on Pulse 1, and only for one tick (do not add more than one–the rest will be ignored!)
  • The effect column may not be expanded for any channel: Only one effect is allowed at any given time.
  • No subsongs are allowed.
  • Messing with Virtual Tempo/Base Tempo is not considered. Only use Speed (For now… Unless I figure out the song speed/tempo math between both trackers)
  • Volume may only be defined if an effect is not on the same row for the channel. Axy (Volume Slide) is an exception. Both Volume and Axy may only be used whenever a note is played. This is to ensure that audio output is converted accurately and as expected.
  • I did a few hacks to make the volume column work: hUGETracker does not natively have a volume column, so I made the program automatically create instruments if the context requires a lower/higher volume that hasn't been defined yet... Don't go crazy w/the volume column, or you may hit the 15-instrument limit very quickly!

Macros are partially supported, with a few more things to note:

  • Wave Macros may be utilized for setting the waveform on the Wavetable channel. Please note that the program will prioritize the first value in the macro. Alternatively, you can employ the Wave Sequencer for the same purpose, but it will only recognize the initial wave, devoid of any modulation, speed adjustment, or waveform morphing.
  • All macros must either A) share the same length and loop point as all the other macros in the instrument, or B) Except for the longest macro within the instrument, all other macros must have loop points shorter than the longest one. This is crucial as the program heavily utilizes Subpatterns to enable macro support. While the program will adhere to the user's specifications, deviating from this restriction may yield unexpected auditory outcomes.
  • Due to driver/design limitations, Panning Macros will only work if the entire song is mono whenever the instrument with a pan macro is used. It will also only work on Pulse 1. If you need it on a different channel, pass the --pan <ChannelNumber 0-3> argument into the program.

Supported Furnace Effects:

  • 00xy - Arpeggio
  • 01xx - Portamento Up
  • 02xx - Portamento Down
  • 03xx - Tone Portamento
  • 04xx - Vibrato
  • 08xx - Set Pan (Hardware)
  • 0Axy - Volume Slide
  • 0Bxx - Position Jump
  • 0Dxx - Pattern Break
  • 0Fxx - Set Speed
  • 12xx - Set Duty Cycle
  • 80xx - Set Pan (Software)
  • ECxx - Note Cut
  • EDxx - Note Delay

FFxx (Stop song) is not supported. If you want the song to stop, create another row and loop it forever with 0Bxx.

Building

There are no dependencies required, beyond .NET and C#: Clone the project and build in your favorite IDE (e.g. Visual Studio)

License

fur2uge Source Code - MIT

All demo songs - CC BY-NC 4.0