search

etternagame / etterna

Advanced cross-platform rhythm game focused on keyboard play
https://etternaonline.com/
MIT License
509 stars 136 forks source link
game keyboard rhythm stepmania

readme

Etterna is a cross-platform rhythm game similar to Dance Dance Revolution. It started as a fork of StepMania 5 (v5.0.12), with a focus on keyboard players. Over time, Etterna evolved into its own game, with in-game multiplayer, the online scoreboard Etterna Online, and a community of over 4,000 players.

Table of Contents

Installing

Windows, macOS, and Linux

Head to the GitHub Releases page, and download the relevant file for your operating system.

For Windows, run the installer, and you should be ready to go.

For macOS, first follow the below instructions. After doing them, mount the DMG and copy the Etterna folder to a location of your choice. Run the executable, and you are ready to go.

For Linux, there should be no extra steps. If it does not work, try to follow the build instructions to install the necessary dependencies.

macOS

This macOS binary is not signed, so before it can be installed it must be de-quarantined by executing this command in the same directory (likely your downloads folder) as the Etterna dmg.

xattr -d com.apple.quarantine ./Etterna*.dmg

Building

All details related to building are in the Building.md file. Since Etterna is cross-platform, you should be able to build on any recent version of Windows, macOS, or Linux.

Documentation

Etterna uses Doxygen and LuaDoc. Both still need a lot of work before being having decent coverage, though we still have them hosted at the following links.

Bug Reporting

We use GitHub's issue tracker for all faults found in the game. If you would like to report a bug, please click the Issues tab at the top of this page, and use the Bug report template.

Contributing

If you want to contribute to the Etterna client, please read Building for instructions on how to get started. We have a variety of different tasks which would help the development of this game as a whole, all of which we have listed at Contributing.md. if you are more interested in helping with the in-game multiplayer, the nodejs server, along with its documentation, is hosted here. You will still need the Etterna client built and running on your system.

If there is something else you want to work on that we don't have listed here, feel free to join Etterna Dev Group, our development discord, and let us know what you want to add. The developers and contributors there would be able to give you a hand as to where you could start doing what you want to do.

License

Etterna uses the MIT License, as is required since we are derivative of StepMania 5. See LICENSE for more details.

In short, you are free to modify, sell, distribute, and sublicense this project. We ask that you include a reference to this GitHub repository in your derivative, and do not hold us liable when something breaks.

Etterna uses the MAD library and FFMPEG codecs. Those libraries, when built, use the GPL license.

Special Thanks