Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 4.23 KB

Contributing.md

File metadata and controls

55 lines (33 loc) · 4.23 KB

Contributing

Anyone is welcome to contribute! These are the areas where help is needed the most.

C++

If you have any experience with C++ (Or even C and wanna learn a bit of C++) your help would be much appreciated! There's A LOT of things that need doing. If you don't have any specific thing you want to work on, here are some ideas:

  • GitHub Issues
  • Coverity Defects (Currently these are private, you can request access with an email, we might make this public in the future)
  • Cleaning up the codebase in general (There's a lot of things that would be nice to see done, like replacing usage of RString with std::string)
  • If you know how to use them and see a good place for them, some usage of modern C++ features like smart pointers might be good to see in the project

Lua

Lua is a fairly simple language. If you have experience in any other programming language, you'll probably be able to get the basics of its syntax in under an hour. The Lua Syntax Guide isa good place to get started.

Lua is used in Etterna for Themes and Noteskins.

Noteskins control the way the notes are drawn (Most noteskins have very similar logic and only different images, but noteskins have the power to do a lot more, and some take advantage of that).

You can think of themes as the front end of the game. The way each screen is drawn, how screen branching (Changing) happens, and other things are controlled by the theme. A theme can even create new screens from scratch, catch inputs (Both mouse and keyboard), and other things. They're fairly powerful.

Currently, there's a lack of alternative themes (To the default one, Til Death) for Etterna. Spawncamping-Wallhack is the only complete theme that supports Etterna as far as I know.

Documentation

The project is sorely lacking in documentation. The current aim is to document the Lua stuff in https://etternagame.github.io/Lua-For-Etterna/API/Lua.xml (This is forked from http://dguzek.github.io/Lua-For-SM5/API/Lua.xml, a community-made reference for SM5 Lua). We intend to get the C++ documentation done in https://etternagame.github.io/wiki/ (At first we wanted to make this page have 3 "sections": General, Lua and C++, but gave up). Then there is a general wiki with information that can be useful to end users (https://wiki.etternaonline.com/).

Translating

The Til Death theme (Default) only has one translation available. In order to make others, simply copy etterna/Themes/Til Death/Languages/en.ini and translate all the right-side words (After the =). Also, a list of the words/text/captions/things that aren't translate-able in the theme would be useful to make them(Some of the text is hard-coded so it's not possible to translate it).

A guide on this can be found in the translations document.

Packaging

A few people have complained about the lack of packages for Linux in general. If you'd like to, you can try working on a package for your favorite distro. I've already made a more-or-less functional debian package here: https://github.com/nico-abram/etterna/tree/debian/

Graphic Design

A lot of things in the game have been done in a hurry to simply provide a basic UI so things can be used. We usually mostly care about features working. Mockups for new designs, improved gfx (Images) and other ideas are incredibly welcome. This goes for both the default theme and the website, etternaonline. If you're interested, you could ask around in the etternaonline discord. Also, concepts for completely new themes would be interesting to see (In case someone who knows how to implement one decides to work on it).

Chart Making

As the content in the game is completely community-driven, new charts and packs keep the game fresh. They make old time players come back for a day. Even if it doesnt seem like much, every chart makes the game as a whole more valuable. You can get started by clicking "Editor" within the client.