Skip to content

Commit e362fe6

Browse files
authored
Fresh new README file with licensing details
1 parent 6f2366f commit e362fe6

File tree

1 file changed

+91
-1
lines changed

1 file changed

+91
-1
lines changed

README.md

Lines changed: 91 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,92 @@
11
# ArrowVortex
2-
Stepmania .sm/.ssc file development tool
2+
3+
ArrowVortex is a simfile editor for Windows. It can be used to create or edit stepfiles for various rhythm games, such as StepMania, ITG, osu!, and other games which support DDR-style and/or PIU-style panel layouts.
4+
5+
This is a continuation of the original project by Bram 'Fietsemaker' van de Wetering. He has graciously allowed for the open sourcing of this code so that development can continue.
6+
7+
See the [About this project](#about-this-project) section below for more information about this repository.
8+
9+
## Features
10+
11+
Some of the features that ArrowVortex has to offer include:
12+
13+
- Automatic BPM/offset detection
14+
- Automatic stream generation
15+
- Automatic difficulty estimation
16+
- Full editing history with undo/redo
17+
- Dancing Bot: plays your charts using two virtual feet
18+
- Powerful editing tools: copy/paste/mirror/expand/compress/etc.
19+
- Scrollable minimap with chart preview, for easy navigation
20+
- Supports Ogg Vorbis conversion for MP3/WAV files
21+
- requires any version of `oggenc2.exe`, available from [RareWares](https://www.rarewares.org/ogg-oggenc.php)
22+
- Fully customizable shortcuts
23+
- Customizable game styles and noteskins
24+
25+
The following features are exclusive to the newer versions of ArrowVortex provided here:
26+
27+
- Support for Fake and Lift note types
28+
- New "Convert" menu options for converting to Fakes or Lifts
29+
- Timestamps can be copied and pasted
30+
- Support for custom snaps
31+
- Non-destructive paste option (Shift+Ctrl+V)
32+
- New visual sync feature, inspired by DDreamStudio (sub-beat placement)
33+
- Wider range and finer granularity in zooming
34+
- Replaced the fixed Mini options with a slider
35+
36+
## Supported formats
37+
38+
Audio formats:
39+
- Ogg Vorbis (.ogg)
40+
- MPEG-1 Audio Layer III (.mp3)
41+
- Waveform Audio File Format (.wav)
42+
43+
Simfile formats:
44+
45+
- StepMania/ITG (.sm)
46+
- StepMania 5 (.ssc)
47+
- Dance With Intensity (.dwi)
48+
- osu! (.osu)
49+
50+
Game styles:
51+
52+
- Dance Single
53+
- Dance Double
54+
- Dance Couple
55+
- Dance Routine
56+
- Dance Solo
57+
- Pump Single
58+
- Pump Halfdouble
59+
- Pump Double
60+
- Pump Couple
61+
62+
## About this project
63+
64+
Unfortunately, the source code for the most recent version of ArrowVortex has been lost to time. The only surviving archive of source code was a development snapshot from 2016. A small group of volunteer developers put a lot of time and effort into restoring the full functionality of the latest release of ArrowVortex, released on 2017-02-25.
65+
66+
Some new features were introduced as well when preparing this release.
67+
68+
## License
69+
70+
ArrowVortex is provided under the GPLv3 license, or at your option, any later version.
71+
72+
The original author (Fietsemaker) provided the volunteer developers with an archive of the source code, which did not include a formal license. The original author explicitly requested that any new code developed by the volunteer developers be released under a license which prevents the code from being used in closed source software. The volunteer developers, as a separate party, have acted in good faith to comply with this request and bear no liability for the licensing status of the original code as provided to them.
73+
74+
Additionally, code from the following projects is included in this repository:
75+
- [freetype](https://freetype.org/license.html), using the FreeType License, which is compatible with GPLv3
76+
- [libogg & libvorbis](https://gitlab.xiph.org/xiph), using its BSD-style license, which is compatible with GPLv3
77+
- [libmad](https://www.underbit.com/products/mad/), using the GPL license (libmad allows for GPLv2 or any later version)
78+
- [lua](https://www.lua.org/license.html), using its GPLv3-compatible permissive license
79+
80+
Please see inside the `lib/` directory for more specific licensing details regarding these libraries.
81+
82+
## Contributors
83+
84+
Original author:
85+
- Bram 'Fietsemaker' van de Wetering (original author)
86+
87+
The following people helped prepare the initial public release of the open sourced ArrowVortex:
88+
- @uvcat7
89+
- @sukibaby
90+
- @Psycast
91+
- @DeltaEpsilon7787
92+
- @DolphinChips

0 commit comments

Comments
 (0)