/sentakki

An attempt to recreate maimai gameplay within osu!lazer

Primary LanguageC#MIT LicenseMIT

sentakki


.NET Core CodeFactor Crowdin Discord Shield

ko-fi

sentakki is a recreation of maimaiDX for use within osu, taking advantage of the longevity and the osu ecosystem for features such as multiplayer, beatmap listing, and leaderboards.

Status

All the essential note types have been implemented. Features like editor is being developed on the side, since lazer doesn't support third party ruleset editors yet. PP/diff calc haven't been given considered yet, and it is currently open to ideas.

Demo

Gameplay.Demo.mp4

Trying the ruleset

Prebuilt binaries are provided for users who doesn't want to create a development environment. Releases are guaranteed to work with the latest version of lazer at the time of release.

Releases
Installation Guide
Sentakki wiki

Debugging and Developing

Some prerequisites are required before attempting to debug or develop:

  • A desktop platform with the .NET 8 SDK or higher installed.
  • An IDE with support for C#, providing auto completion and syntax highlighting. I recommend using Visual Studio 2019 or Visual Studio Code.
  • Other requirements are shared with osu!lazer and osu!framework

Downloading the source code

Clone the repository:

git clone https://github.com/lumpbloom7/sentakki
cd sentakki

To update the source code to the latest commit, run the following command inside the osu directory:

git pull

Building

Using the Build command from your IDE should generate a DLL file within the output directory. If you're debugging or developing, it is a bit more convenient to run the VisualTests project instead since that'll remove the need to copy the dll to your lazer directory.

You can also build sentakki from the command-line with a single command:

dotnet build osu.Game.Rulesets.Sentakki

Contributing

There are a few ways one can look to contribute to sentakki.

Code contributions

If you are interested in implementing new features or improving current features, you can fork the repository and develop the feature/improvement on a topic branch of your fork before PR'ing the changes to this repository.

Localization contributions

Want to see Sentakki display text in your language? You can help localize Sentakki via the project's crowdin page.

Feedback / bug reports

Notice a problem during gameplay? Feel free to leave an issue/suggestion over at GitHub issues.

Licence

Sentakki is licensed under the MIT licence. Please see the licence file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.

Do take note that project dependencies may not share the same license.