Git Product home page Git Product logo

etterna's Introduction

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 and macOS

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, mount the DMG and copy the Etterna folder to a location of your choice. Run the executable, and you are ready to go.

macOS

macOS has protection software called Gatekeeper. It ensures only trusted applications (code-signed apps) can be run on your system. Since we are an open-source project, we don't have the means to code-sign Etterna. If you have any trouble when opening Etterna on your system, please try to control-click the app, choose Open from the menu, and in the dialog that appears, click Open. Enter your admin name and password when prompted, and it should allow you to run the game.

Linux

Currently, the only supported way to play Etterna on a Linux based operating system is to install from source. Please follow the instructions in Building to get started.

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.

etterna's People

Contributors

aldomx avatar caiohsr14 avatar djpohly avatar dtinth avatar freem avatar hanubeki avatar henke37 avatar jameskr97 avatar jobn avatar johnreactor avatar jousway avatar kyzentun avatar martensm avatar midiman avatar minaciousgrace avatar misterkister avatar nico-abram avatar poco0317 avatar quietly-turning avatar roothorick avatar shakesoda avatar shenjoku avatar shujito avatar sigatrev avatar spacegorilla avatar tertu-m avatar theropfather avatar vyhd avatar wolfman2000 avatar xwidghet avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.