Skip to content

Commit

Permalink
[MED] ALPHA 1.6
Browse files Browse the repository at this point in the history
  • Loading branch information
nots1dd committed Jan 12, 2025
1 parent 061f6d0 commit e7b8bab
Show file tree
Hide file tree
Showing 16 changed files with 3,856 additions and 344 deletions.
2,975 changes: 2,975 additions & 0 deletions .Doxyfile

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .github/workflows/codeql-inLimbo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
with:
languages: ${{ matrix.language }}

- name: Build inLimbo in Ubuntu
- name: Build inLimbo in Ubuntu (x86 arch - GCC)
run: |
# Ensure any dependencies are installed before building
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ src/network/*.pem
src/parser/*.out
src/parser/toml.hpp
src/music/miniaudio.h
docs/
59 changes: 45 additions & 14 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ This CHANGELOG follows the below format:

Overally pretty buggy, but integration was smoother than expected.

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits

-> Fix emscripten build by introducing TagLib's web-assembly build

Expand Down Expand Up @@ -140,7 +140,7 @@ Overally pretty buggy, but integration was smoother than expected.

Commit was clean but status bar components took a hit and are not rendering properly

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits

-> Fix emscripten build by introducing TagLib's web-assembly build

Expand Down Expand Up @@ -174,7 +174,7 @@ Commit was clean but status bar components took a hit and are not rendering prop

Commit is decently sized however now that integration is completed it is time to refactor and move to other goals

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
**NIL**

---
Expand Down Expand Up @@ -205,7 +205,7 @@ Commit is decently sized however now that integration is completed it is time to

Commit is decently sized however now that integration is completed it is time to refactor and move to other goals

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
**NIL**

---
Expand Down Expand Up @@ -234,7 +234,7 @@ Commit is decently sized however now that integration is completed it is time to

Commit is medium sized with decent changes to UI and configs.

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
- Backward seek

- Scrolling of lyrics
Expand All @@ -261,7 +261,7 @@ Commit is medium sized with decent changes to UI and configs.

Commit is small but damn worth it. Fixed a very big issue and has solid optimisations

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
- Backward seek

- Scrolling of lyrics
Expand Down Expand Up @@ -290,7 +290,7 @@ Commit is small but damn worth it. Fixed a very big issue and has solid optimisa

Very small commit but noteworthy as it fixes two bugs which were quite annoying

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
- Scrolling of lyrics

---
Expand Down Expand Up @@ -320,7 +320,7 @@ Very small commit but noteworthy as it fixes two bugs which were quite annoying

Decently sized commit but the issue of songs changing just by traversal is fixed now thanks to Song queue. This also is step forward to adding more keybinds to add song to queue, remove song from queue so on..

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
- Scrolling of lyrics

---
Expand Down Expand Up @@ -351,7 +351,7 @@ Decently sized commit but the issue of songs changing just by traversal is fixed

Medium sized commit that adds quite a few features and implementation but more work needs to be done.

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
- Scrolling of lyrics

---
Expand All @@ -378,7 +378,7 @@ Medium sized commit that adds quite a few features and implementation but more w

Commit that proceeds to add queue features and fix issues (regarding threads) along the way

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
- Scrolling of lyrics

---
Expand Down Expand Up @@ -421,7 +421,7 @@ Commit that proceeds to add queue features and fix issues (regarding threads) al

Very big commit in dev branch that is to be merged with main after some sanity checks

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
- Scrolling of lyrics and sone menu

- Runtime errors with respect to `PlayCurrentSong()` that may be due to detaching the audio thread
Expand Down Expand Up @@ -450,7 +450,7 @@ Very big commit in dev branch that is to be merged with main after some sanity c

Decent commit with more to come, refactor TBD else its gonna be trouble

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
- Scrolling of lyrics and sone menu

- Runtime errors with respect to `PlayCurrentSong()` that may be due to detaching the audio thread
Expand Down Expand Up @@ -493,7 +493,7 @@ Decent commit with more to come, refactor TBD else its gonna be trouble

Pretty big commit that added a lot of changes, hopefully shifting toward refactoring in the next immediate commits

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
- Scrolling of lyrics and song menu (lyrics is almost done)

- Runtime errors with respect to `PlayCurrentSong()` that may be due to detaching the audio thread
Expand Down Expand Up @@ -522,7 +522,38 @@ Pretty big commit that added a lot of changes, hopefully shifting toward refacto

Minor commit that somehow added a pretty neat feature. Will continue to work on setting up implementations (if needed)

## Known Issues to fix in immediate commits
### Known Issues to fix in immediate commits
- Scrolling of lyrics and song menu (lyrics is almost done)

- Runtime errors with respect to `PlayCurrentSong()` that may be due to detaching the audio thread

---

## [ALPHA 1.6] --- 13-01-2025

### Added
- Doxygen documentation setup `.Doxyfile`

- New resized logo for Doxygen

- Landing page basic html file

- Changes to all markdown files for doxygen docs

### Changed
- Comments to most headers to add Doxygen documentation

- Added `add_artists_songs_to_queue` and `play_this_song_next` fields to `config.toml` with subsequent integration

### Fixed
- Issue with RenderQueueScreen's menu disappearing when removing song from queue

### Removed
**NIL**

Weird commit that sets up for better and more transparent way of understanding the project thanks to doxygen

### Known Issues to fix in immediate commits
- Scrolling of lyrics and song menu (lyrics is almost done)

- Runtime errors with respect to `PlayCurrentSong()` that may be due to detaching the audio thread
Expand Down
4 changes: 3 additions & 1 deletion COLORS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# inLimbo Colors - Color Schema Documentation
# COLORS inLimbo

Color Schema Documentation for inLimbo

This document explains the color schema used in [**inLimbo**](https://github.com/nots1dd/inLimbo), including all available colors, their respective RGB values, and how to configure them in the `config.toml` file.

Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,19 @@ make
> ```
>
## DOCUMENTATION
Currently I am setting up a Doxygen documentation page that should really make it easy to understand the flow of the project
Man page is also under progress
To generate and view doxygen documentation locally:
```bash
doxygen .Doxyfile # ensure that you have doxygen installed first
firefox docs/html/index.html # or any web browser (xdg-open also works)
```
## CREDITS

**LOGO**:
Expand Down
Binary file added assets/logo/inLimbo-doxygen.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
134 changes: 134 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>inLimbo - TUI Music Player Documentation</title>
<link rel="stylesheet" href="style.css">
<style>
body {
font-family: Arial, sans-serif;
background-color: #f5f5f5;
color: #333;
margin: 0;
padding: 0;
}
header {
background-color: #2b3e50;
color: white;
padding: 20px 0;
text-align: center;
}
header h1 {
margin: 0;
font-size: 2.5em;
}
.container {
width: 80%;
margin: 0 auto;
padding: 20px;
}
.section {
margin: 40px 0;
}
.features ul {
list-style-type: none;
padding-left: 0;
}
.features li {
margin-bottom: 10px;
}
.features li::before {
content: "✔️ ";
}
footer {
text-align: center;
padding: 20px;
background-color: #2b3e50;
color: white;
}
.logo {
width: 120px;
margin: 20px 0;
}
.images {
display: flex;
justify-content: space-around;
margin-top: 30px;
}
.images img {
width: 30%;
height: auto;
}
.button-container {
text-align: center;
margin-top: 40px;
}
.button-container a {
padding: 15px 25px;
background-color: #2b3e50;
color: white;
font-size: 1.1em;
text-decoration: none;
border-radius: 5px;
transition: background-color 0.3s ease;
}
.button-container a:hover {
background-color: #1f2a37;
}
</style>
</head>
<body>

<header>
<h1>inLimbo - TUI Music Player</h1>
<p>A TUI-based music player for seamless audio playback and control with efficient metadata extraction and viewing</p>
</header>

<div class="container">
<section class="section about">
<h2>About</h2>
<p><strong>inLimbo</strong> is a terminal-based music player that provides an immersive experience for managing your music library. Built using C++, it allows you to control music playback, view metadata, and organize your songs all from within a sleek text-based interface.</p>
</section>

<section class="section features">
<h2>Features</h2>
<ul>
<li>Seamless audio playback and control</li>
<li>Efficient metadata extraction and viewing</li>
<li>Intuitive keyboard shortcuts for ease of use</li>
<li>Support for local and streaming music sources</li>
<li>Customizable user interface with theming options</li>
<li>Lightweight and responsive performance</li>
</ul>
</section>

<section class="section images">
<img src="../gifs/inLimbo-1.gif" alt="inLimbo Screenshot 1">
<img src="../gifs/inLimboColors.gif" alt="inLimbo Screenshot 2">
<img src="image3.jpg" alt="inLimbo Screenshot 3">
</section>

<section class="section licensing">
<h2>Licensing</h2>
<p>inLimbo is licensed under the GNU GPL v3 License. See the <a href="../../LICENSE">LICENSE</a> file for more details.</p>
</section>

<section class="section author">
<h2>Author</h2>
<p>This project is maintained by <strong>Siddharth Karanam (nots1dd)</strong>. Feel free to reach out for any contributions, questions, or comments.</p>
</section>

<!-- Button to Doxygen Documentation -->
<div class="button-container">
<a href="../../docs/html/index.html" target="_blank">Visit the Doxygen Documentation</a>
</div>
</div>

<footer>
<p>&copy; 2025 inLimbo. All rights reserved.</p>
</footer>

</body>
</html>
Loading

0 comments on commit e7b8bab

Please sign in to comment.