README.md

Development status: Pre-Alpha ⚠️

osu!radio

Roadmap   •   Figma

What is osu!radio?

osu!radio is a music player for the songs in your osu! library!

Development Setup

Note

To use git and bun, you need to have Git, Node.js and Bun installed.

1 | Open a terminal in the directory in which you want to download osu!radio. Then run the 2 following commands,

git clone https://github.com/Team-BTMC/osu-radio.git

cd osu-radio

2 | Next, install the necessary dependencies to run osu!radio,

bun install

A | For a production (User) startup,

bun run start

B | For a hot reloading (Development) startup,

bun run dev

Warning

If you want to reset your osu!radio installation

Windows: go to %appdata% (Win + R, type in %appdata%) and remove the osu-radio directory.

Linux: go to $XDG_DATA_HOME (generally ~/.config/) and remove the osu-radio directory.

Contributing

Tip

To get started, it's recommended to make a fork of the repository.

If you're new to contributing, consider checking out How to Contribute to Open Source. This is a great guide to better understand what it means to contribute.

If you're interested in contributing towards development, we'd recommend reading Good Manners of a PR & Best Practices, as well as How to write a perfect PR.

If you're interested in contributing as a designer, check out the Figma

Remember! Contributions come in all shapes and sizes.

The Vision

Technologies:

• Electron
• SolidJS
• TypeScript

Discussion mainly happens in the BTMC TALENT SERVER, in the #prj-osu-radio channel.
We're not interested in changing tech stacks for this project for the time being. We're sticking with Electron and web tech for now.
For major code related matters (Discussions, PRs, Suggestions), contact @CaptSiro
For design related matters (UI/UX, Ideas, Suggestions), contact @Dudu