alecodes/fuuka
2
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions

docs: Update Readme

Browse source
This commit is contained in:
Alexander Navarro 2023-12-23 18:34:25 -03:00
parent d4be13bbcd
commit 8038c6e295
1 changed files with 23 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,10 +1,10 @@
# fuuka
# Fuuka
## Introduction
This is the web interface for [Juno](https://codeberg.org/aleidk/juno), a music player. This service is in charge of orquestrate the music playback and schedule of the player, manually and automatically.
The name comes from [Fuuka Yamagishi](https://megamitensei.fandom.com/wiki/Fuuka_Yamagishi), the navi of SEES in Persona 3, you can ask her to change the musing in tartarus.
This is the web interface for [Juno](https://codeberg.org/aleidk/juno), a music
player. This service is in charge of orquestrate the music playback and
schedule of the player, manually and automatically.
## Features:
@ -21,11 +21,28 @@ The name comes from [Fuuka Yamagishi](https://megamitensei.fandom.com/wiki/Fuuka
### Why Rust?
A core requirement is to index and handle a masive collection of music, so the project needs an efficient backend language. By the quote I read somewhere of _"un-optimized Rust code is faster than optimized Go code"_, I decided to use Rust.
A core requirement is to index and handle a masive collection of music, so the
project needs an efficient backend language. By the quote I read somewhere of
_"un-optimized Rust code is faster than optimized Go code"_, I decided to use
Rust.
### Why the name?
One of my first projects was a discord bot that acted as a frontend of MPV while also played the HTTPS stream in the voice call. I called the bot fuuka because you actually have to talk to the bot to ask for music. This is the 3rd iteration of the idea (and hopefully the definitive), so I decided to mantain the name in it's honor.
#### TLDR
The name comes from [Fuuka Yamagishi](https://megamitensei.fandom.com/wiki/Fuuka_Yamagishi), a character from Persona 3.
#### Long Version
One of my first projects was a discord bot that acted as a frontend of [MPD](https://wiki.archlinux.org/title/Music_Player_Daemon)
while also played the HTTPS stream in the voice call. I called the bot fuuka
because you actually have to talk to the bot to ask for music. This is the 3rd
iteration of the idea (and hopefully the definitive), so I decided to maintain
the name in it's honor.
The project was split into 2 though:
- [Fuuka](https://megamitensei.fandom.com/wiki/Fuuka_Yamagishi), the navi of SEES in Persona 3, you can ask her to change the musing in tartarus. It act as the frontend to interact with the player.
- [Juno](https://megamitensei.fandom.com/wiki/Juno), the persona of Fuuka that grants her the ability to communicate telepatically to her teamates. It act as the music player.
## Similar projects