LoFi Engine

Generate LoFi music on the go. You create your own atmosphere; LoFi Engine sets the mood.

Table of Contents

• Introduction
• Tech Stack
• Roadmap
• Features
• Run Locally
• Contributing
• License

Tech Stack

Roadmap

• Procedural LoFi track generation using Tone.js
• Customizable ambient tracks
• Customizable effects
• Customizable look and feel
• Keyboard shortcuts for all actions
• Offline support
• Cross-platform support (Linux, Mac, Windows)
• Browser deployment
• Purchasing a domain
• Mobile support (iOS, Android)
• More customization options and effects
• Improved procedural generation algorithms
• User feedback integration

Features

• Create your own LoFi studio with your unique music with minimal touches from this and that. Be the Artist.
• Works with major desktop platforms: Linux, Mac, and Windows.
• Doesn't require an internet connection; your experience is fully private.
• LoFi Engine's main focus is customization, accessibility, and artistic freedom.

Customization

1. Playback: If you want to listen to music or just listen to birds singing freely, you choose.
2. Look: With carefully crafted artworks from talented artists, long study sessions become a joy.
3. Ambience: A windy evening or the sound of waves crashing into the sand of a sunny beach brings peace.

Advanced Immersion (Auto DJ)

The new Immersion system (Auto DJ) automatically manages the soundscape for you. It offers different modes to suit your needs:

• Music: Focuses on the beat and chords without atmospheric effects.
• Atmosphere: Adds core weather and nature effects for a fuller sound.
• World: Incorporates specific textures like city sounds or wind for deep immersion.
• Manual: Gives you full control to mix and match sounds as you please.

Internationalization

LoFi Engine now speaks your language! We have added support for multiple languages to make the experience accessible to everyone.

• English
• French (Français)
• Spanish (Español)
• Japanese (日本語)
• Korean (한국어)
• Indonesian (Bahasa Indonesia)
• And more coming soon!

Accessibility

Any action or click you can do with the mouse has a shortcut for it with the keyboard. For playback, effects, ambient tracks, look, etc.

All information about the app and shortcuts is available in the info box accessible via the ESC key.

Procedural LoFi Track Generation

The LoFi track is now generated procedurally using Tone.js, providing a dynamic and unique listening experience every time. We are actively seeking feedback from users to refine and improve the track generation process. Your input will help us enhance the quality, variety, and customization of the generated music.

If you have suggestions or encounter any issues, please let us know by opening an issue or contributing directly to the project. Together, we can make LoFi Engine even better!

Run Locally

To run LofiEngine locally, follow these steps:

Prerequisites

• Node.js (v14 or later)
• pnpm (v6 or later)
• Rust (latest stable version)
• Tauri prerequisites (based on your operating system)

Installation

1. Clone the repository:

   git clone https://github.com/meel-hd/lofi-engine
   cd lofi-engine
   

2. Install dependencies:

   pnpm install
   

Development

To run the app in development mode:

pnpm tauri:d

This command will start both the Vite dev server for the frontend and the Tauri development process for the native shell.

Building

To build the app for production:

pnpm tauri:b

This will create a production-ready build of your application in the src-tauri/target/release directory.

Additional Commands

• pnpm dev: Run the Vite development server without Tauri
• pnpm build: Build the frontend assets without Tauri
• pnpm preview: Preview the built frontend
• pnpm check: Run Svelte type checking

Contributing

Contributions are welcome. See the Contributing Guide for details, and check the issue tracker if you want to help, report a bug, or discuss new ideas.

License

This project is licensed under the MIT License. Feel free to use, modify, and distribute this code as per the terms of the license.