|
|
||
|---|---|---|
| .changelog | ||
| .githooks | ||
| .github | ||
| Announcers | ||
| Assets | ||
| BackgroundEffects | ||
| BackgroundTransitions | ||
| BGAnimations | ||
| CMake | ||
| Data | ||
| Docs | ||
| extern | ||
| GameTools | ||
| NoteSkins | ||
| Scripts | ||
| Songs | ||
| src | ||
| Themes | ||
| .clang-format | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CMakeLists.txt | ||
| format-check.sh | ||
| format.sh | ||
| LICENSE | ||
| portable.ini | ||
| README.md | ||
| STEPMANIA.TXT | ||
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.
- Latest C++ documentation: https://etternagame.github.io/cpp-docs/
- Latest Lua documentation: https://etternagame.github.io/lua-docs/
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
- All original SM devs/contributors
- Jet Brains for giving us free licenses
- Coverity for giving us free scans