actions/itgmania212121
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md, round 1

Browse Source
This commit is contained in:
Martin Natano
2022-04-03 23:00:40 +02:00
parent 724b880dfa
commit 54ddcb9df8
1 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+18 -18
View File
@@ -1,30 +1,40 @@
StepMania
=========
ITGmania
========
StepMania is an advanced cross-platform rhythm game for home and arcade use.
ITGmania is a fork of [StepMania 5.1](https://github.com/stepmania/stepmania/tree/5_1-new), an advanced cross-platform rhythm game for home and arcade use.
[![Continuous integration](https://github.com/stepmania/stepmania/workflows/Continuous%20integration/badge.svg?branch=5_1-new)](https://github.com/stepmania/stepmania/actions?query=workflow%3A%22Continuous+integration%22+branch%3A5_1-new)
[![Build Status](https://travis-ci.org/stepmania/stepmania.svg?branch=master)](https://travis-ci.org/stepmania/stepmania)
[![Build status](https://ci.appveyor.com/api/projects/status/uvoplsnyoats81r2?svg=true)](https://ci.appveyor.com/project/Nickito12/stepmania)
## Changes to StepMania 5.1
- The mine fix
- Track held misses for pad debugging
- New preference to control note render ordering
- Fixed hold note rendering
- Increased the Stats.xml file size limit to 100MB
- Changed the default binding for P2/back from hyphen to backslash
- Built-in network functionality
- Per-player visual delay and disabled timing windows
## Installation
### From Packages
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:
* 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.
* Mac OS X users need to have Mac OS X 10.6.8 or higher to run StepMania.
* Mac OS X users need to have Mac OS X 10.6.8 or higher to run ITGmania.
* Linux users should receive all they need from the package manager of their choice.
### From Source
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.
ITGmania 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.
## Resources
* Website: https://www.stepmania.com/
* IRC: irc.freenode.net/#stepmania-devs
* Lua for SM5: https://quietly-turning.github.io/Lua-For-SM5/
* Website: https://www.itgmania.com/
* Lua for ITGmania: https://itgmania.github.io/lua-for-itgmania/
* Lua API Documentation can be found in the Docs folder.
## Licensing Terms
@@ -42,13 +52,3 @@ For specific information/legalese:
* All of our source code is under the [MIT license](http://opensource.org/licenses/MIT).
* Any songs that are included within this repository are under the [<abbr title="Creative Commons Non-Commercial">CC-NC</abbr> license](https://creativecommons.org/).
* 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).
## Changes to StepMania 5.1
- The mine fix
- Track held misses for pad debugging
- New preference to control note render ordering
- Fixed hold note rendering
- Increased the Stats.xml file size limit to 100MB
- Changed the default binding for P2/back from hyphen to backslash