2014-02-08 13:19:46 -08:00
StepMania
2013-12-01 14:37:41 -08:00
=========
2014-10-17 21:23:00 -04:00
StepMania is an advanced cross-platform rhythm game for home and arcade use.
2014-02-08 13:19:46 -08:00
Advanced cross-platform rhythm game for home and arcade use.
2020-06-14 16:46:15 +02:00
[](https://github.com/stepmania/stepmania/actions?query=workflow%3A%22Continuous+integration%22+branch%3A5_1-new)
2015-12-20 19:14:52 -08:00
[](https://travis-ci.org/stepmania/stepmania)
2019-10-05 22:30:28 +08:00
[](https://ci.appveyor.com/project/Nickito12/stepmania)
2015-12-20 19:14:52 -08:00
## Installation
### From Packages
2015-10-25 13:52:35 -04:00
For those that do not wish to compile the game on their own and use a binary right away, be aware of the following issues:
2019-10-26 10:42:54 +08:00
* Windows users are expected to have installed the [Microsoft Visual C++ x86 Redistributable for Visual Studio 2015 ](http://www.microsoft.com/en-us/download/details.aspx?id=48145 ) prior to running the game. For those on a 64-bit operating system, grab the x64 redistributable as well. Windows 7 is the minimum supported version.
2015-10-25 13:52:35 -04:00
* Mac OS X users need to have Mac OS X 10.6.8 or higher to run StepMania.
* Linux users should receive all they need from the package manager of their choice.
2015-12-20 19:14:52 -08:00
### From Source
2014-10-17 21:23:00 -04:00
2015-06-02 11:28:36 -04:00
StepMania can be compiled using [CMake ](http://www.cmake.org/ ). More information about using CMake can be found in both the `Build` directory and CMake's documentation.
2014-10-17 21:23:00 -04:00
2015-12-20 19:14:52 -08:00
## Resources
2014-02-08 13:19:46 -08:00
2019-12-31 23:19:03 +08:00
* Website: https://www.stepmania.com/
2014-02-08 15:41:14 -06:00
* IRC: irc.freenode.net/#stepmania -devs
2019-12-31 23:19:03 +08:00
* Lua for SM5: https://quietly-turning.github.io/Lua-For-SM5/
2015-12-28 22:45:35 -08:00
* Lua API Documentation can be found in the Docs folder.
2014-10-17 21:23:00 -04:00
2015-12-20 19:14:52 -08:00
## Licensing Terms
2014-10-17 21:23:00 -04:00
2015-12-26 19:05:37 -08:00
In short- you can do anything you like with the game (including sell products made with it), provided you *do not* :
2015-12-26 18:53:21 -08:00
1. Sell the game *with the included songs*
2. Claim to have created the engine yourself or remove the credits
3. Not provide source code for any build which differs from any official release which includes MP3 support.
2015-12-26 19:05:37 -08:00
(It's not required, but we would also appreciate it if you link back to http://www.stepmania.com/)
2015-12-26 18:53:21 -08:00
For specific information/legalese:
2019-09-04 01:22:57 -04:00
* All of our source code is under the [MIT license ](http://opensource.org/licenses/MIT ).
2014-10-17 21:23:00 -04:00
* Any songs that are included within this repository are under the [<abbr title="Creative Commons Non-Commercial">CC-NC</abbr> license ](https://creativecommons.org/ ).
2015-06-02 11:28:36 -04:00
* The [MAD library ](http://www.underbit.com/products/mad/ ) and [FFmpeg codecs ](https://www.ffmpeg.org/ ) when built with our code use the [GPL license ](http://www.gnu.org ).