Skip to content

Commit

Permalink
updated README to be more to the point
Browse files Browse the repository at this point in the history
  • Loading branch information
achimmihca committed May 1, 2021
1 parent 05e9b45 commit f0a7e07
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,31 @@
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5eeefc3773e8405aac7332ce0e57ec86)](https://www.codacy.com/app/UltraStar-Deluxe/Play?utm_source=github.com&utm_medium=referral&utm_content=UltraStar-Deluxe/Play&utm_campaign=Badge_Grade)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/UltraStar-Deluxe/Play/blob/master/LICENSE)
[![Join the chat at https://gitter.im/UltraStar-Deluxe/Play](https://badges.gitter.im/UltraStar-Deluxe/Play.svg)](https://gitter.im/UltraStar-Deluxe/Play?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Sponsor this project](https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/achimmihca)

### 1. About
UltraStar Play is a free and open source karaoke singing game for Windows, Linux, Android, Xbox, PlayStation and other modern platforms. The game plays the audio file, displays singing lyrics, notes and optionally a background video or picture, while the singers sing the songs and thus try to hit the notes to get points depending on how close they get to the perfect pitches.
The game uses the Unity 2D framework and mostly c# (mono/.Net) as software development language.

### 2. Minimal Game Requirements
- Windows 7 SP1+, macOS 10.12+, Ubuntu 16.04+
- Graphics card with DX10 (shader model 4.0) capabilities.
- iOS player requires iOS 9.0 or higher.
- Android: OS 4.1 or later; ARMv7 CPU with NEON support or Atom CPU; OpenGL ES 2.0 or later.
- Speakers, USB microphones (or similar)

### 3. Development Requirements
- See [Unity system requirements](https://unity3d.com/unity/system-requirements)
- Plenty of free time

### 4. Documentation
- See [the project wiki](https://github.com/UltraStar-Deluxe/Play/wiki)

### 5. How to contribute
- See [CONTRIBUTING.md](https://github.com/UltraStar-Deluxe/Play/blob/master/CONTRIBUTING.md) and also [How to Compile the Game](https://github.com/UltraStar-Deluxe/Play/wiki/Compiling-the-game)
- See [How to Compile the Game](https://github.com/UltraStar-Deluxe/Play/wiki/Compiling-the-game)

### 6. Support
- If you just want to play sing-along karaoke, please use [UltraStar Deluxe](https://github.com/UltraStar-Deluxe/USDX) or [Performous](https://github.com/performous/performous) or [Vocaluxe](https://github.com/Vocaluxe/Vocaluxe) instead.
- See documentation sources mentioned above
- [Issue Tracker](https://github.com/UltraStar-Deluxe/Play/issues)
- "The code is documentation enough" << sorry, this project just started, there will be more places for support later on
UltraStar Play is a free and open source singing game.
The game plays an audio file, displays lyrics, notes, and optionally a background video or image, while the players sing along to earn points.

UltraStar Play is built with the [Unity](https://unity.com/) game engine and mostly C# as programming language.
Builds are available for [desktop and mobile](https://github.com/UltraStar-Deluxe/Play/releases).
Even more platforms (e.g. PlayStation, XBox) might be added in the future.

See [the project wiki](https://github.com/UltraStar-Deluxe/Play/wiki/First-Steps) to get started.

### 2. Minimal System Requirements
- Windows 7 SP1+, macOS 10.13+, Ubuntu 18.04+, Android 4.4 (API 19)+, iOS 11+ (to be released)
- For more details, see the [Unity documentation](https://docs.unity3d.com/Manual/system-requirements.html#player)
- Speakers and microphones (e.g. headset, USB mic, [UltraStar Play Companion App](https://github.com/UltraStar-Deluxe/PlayCompanion/releases), [WO Mic](https://wolicheng.com/womic), etc.)

### 3. How to Contribute
You can support this project by

- becoming a [GitHub Sponsor](https://github.com/sponsors/achimmihca) or
- getting involved with the development
- See the [contribution guide](https://github.com/UltraStar-Deluxe/Play/blob/master/CONTRIBUTING.md) and [how to compile the game](https://github.com/UltraStar-Deluxe/Play/wiki/Compiling-the-game).

### 4. Support
If you need help or found a bug, then visit the [chat](https://gitter.im/UltraStar-Deluxe/Play) or [issue tracker](https://github.com/UltraStar-Deluxe/Play/issues)

You might also be interested in the more stable [UltraStar Deluxe](https://github.com/UltraStar-Deluxe/USDX) or similar projects such as [Performous](https://github.com/performous/performous) or [Vocaluxe](https://github.com/Vocaluxe/Vocaluxe).

0 comments on commit f0a7e07

Please sign in to comment.