maisim

A free and open-source, community-powered based on circular-lane-style gameplay powered by the osu!framework.

Note : project name isn't final (yet?).

Project Status

The UI and design pieces of the game are slowly getting done. Gameplay design isn't finalized yet, but we're getting there.

There are plans to develop along this a website so the game can be a whole experience by itself.

Figma designs are available at the project's wiki.

The plan and status of this project is available at GitHub project.

Contributing

Want to contribute? That's cool ! We got a lot of things to do at all scales :

• Got an idea ? Pitch it in a discussion !
• Want to improve the design ? Start a discussion about design improvements !
• Wanna contribute to implementing parts of the gameplay ? Let us know in a discussion thread !
• Found a bug or something not working as it should ? Open an issue to let us know !

Don't hesitate to make a discussion and we will try to answer as fast as we can.

You know C# ? You can try picking an issue up or pick some topic to work on from project board, make a pull request and we will review it.

Developing maisim

The following items are required to be installed on your computer in order to develop maisim:

• The .NET 6 SDK or higher
• Developing for mobile requires a Xamarin installation, which ships with Visual Studio 2022 or Visual Studio for Mac.
• The use of a C# IDE (Rider, Visual Studio) is highly recommended to browse through the codebase.

Getting started with developing maisim is as follows:

Grabbing the code from the repository

git clone https://github.com/HelloYeew/maisim
cd maisim/maisim

Running the game

cd maisim.Desktop

# restore nuget packages for the solution
dotnet restore

# run the game with the debug profile
dotnet run 

# if you ever want to run the game with the release profile
dotnet run -c:Release

Running visual tests

cd maisim.Game.Tests

# restore nuget packages for the solution
dotnet restore

# run the visual tests with the debug profile
dotnet run 

If you're using an IDE, it should be automatically picking the development profiles when opening the solution files.

Licence

This project is licensed under the MIT license. 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.