Skip to content

Commit

Permalink
Update .gitignore and README.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
jooapa committed Feb 9, 2024
1 parent 85fb6a6 commit 4fc7717
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ $RECYCLE.BIN/

_NCrunch*

jammer-Setup.exe
jammer-Setup_V1.X.X.exe
nsis-folder/jammer.exe
nsis-folder/raylib.dll
.vscode/launch.json
Expand Down
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@

![banner](https://raw.githubusercontent.com/jooapa/jammer/main/images/jammer_banner.gif)

### Usage
## Usage

```bash
jammer [song] ... [folder]
jammer https://soundcloud.com/username/track-name
jammer https://soundcloud.com/username/sets/playlist-name
jammer https://youtube.com/watch?v=video-id

jammer start opens jammer folder
jammer update checks for updates and installs
jammer playlist playlist controls
jammer selfdestruct deletes jammer
jammer start opens jammer folder
Expand All @@ -18,7 +20,9 @@ jammer -d debug mode
jammer --version show version

```

_when using soundcloud or youtube links dont forget to use `https://` at the start._

```bash
jammer playlist play <name>
jammer playlist create <name>
Expand All @@ -29,8 +33,8 @@ jammer playlist show <name>
jammer playlist list
```


### Supported formats

- **MP3:** MPEG Audio Layer III
- **OGG:** Ogg Vorbis
- **WAV:** Waveform Audio File Format
Expand Down Expand Up @@ -67,29 +71,37 @@ jammer playlist list
| `9` | goto end of the song|

### Install

Github latest [Release](https://github.com/jooapa/signal-jammer/releases/latest)

### Example usage

```bash
jammer "path/to/song.mp3" ./another/song.aac C:\Users\user\jammer\playlists\playlist.jammer "path/to/folder"
```

```bash
jammer https://soundcloud.com/angry-birds-2009-2014/haunted-hogs https://soundcloud.com/cohen-campbell-823175156/sets/angry-birds-epic
```

```bash
jammer https://www.youtube.com/watch?v=4zjFDTIROhQ
```

You can also use `-d` flag that will add logs to to local jammer folder.

### Build/Run yourself
```

```bash

dotnet run -- "path/to/song.mp3" ..
```
```

```bash
dotnet publish -r win10-x64 -c Release /p:PublishSingleFile=true
```
```

```bash
build.bat
```

Expand Down
1 change: 0 additions & 1 deletion src/Start.cs
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@ public static void Run(string[] args)
} else {
AnsiConsole.MarkupLine("[green]Jammer is up to date![/]");
}

Environment.Exit(0);
}
}
Expand Down
34 changes: 18 additions & 16 deletions src/TUI.cs
Original file line number Diff line number Diff line change
Expand Up @@ -413,22 +413,6 @@ public static void PlaylistCMD(string[] args){
}
}

static public void PlaylistHelp() {
var table = new Table();
table.AddColumn("Playlist Commands");
table.AddColumn("Description");

table.AddRow("[grey]jammer[/] [red]playlist[/] [green]play [/]<name>", "Play playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]create [/]<name>", "Create playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]delete [/]<name>", "Delete playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]add [/]<name> <song> ...", "Add songs to playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]remove [/]<name> <song> ...", "Remove songs from playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]show [/]<name>", "Show songs in playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]list [/]", "List all playlists");

AnsiConsole.Write(table);
}

public static void Help() {
var table = new Table();
table.AddColumn("Commands");
Expand All @@ -442,13 +426,31 @@ public static void Help() {
table.AddRow("[grey]jammer[/] [green]playlist[/]", "Show playlist commands");
table.AddRow("[grey]jammer[/] [green]selfdestruct[/]", "Uninstall Jammer");
table.AddRow("[grey]jammer[/] [green]start[/]", "Open Jammer folder");
table.AddRow("[grey]jammer[/] [green]update[/]", "Auto Update Jammer");
table.AddRow("[grey]jammer[/] [green]version[/]", "Show Jammer version [grey]" + Utils.version + "[/]");

AnsiConsole.Write(table);

PlaylistHelp();
}

static public void PlaylistHelp() {
var table = new Table();
table.AddColumn("Playlist Commands");
table.AddColumn("Description");

table.AddRow("[grey]jammer[/] [red]playlist[/] [green]play [/]<name>", "Play playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]create [/]<name>", "Create playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]delete [/]<name>", "Delete playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]add [/]<name> <song> ...", "Add songs to playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]remove [/]<name> <song> ...", "Remove songs from playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]show [/]<name>", "Show songs in playlist");
table.AddRow("[grey]jammer[/] [red]playlist[/] [green]list [/]", "List all playlists");

AnsiConsole.Write(table);
}


public static void Version() {
AnsiConsole.MarkupLine("[green]Jammer version " + Utils.version + "[/]");
}
Expand Down
2 changes: 1 addition & 1 deletion src/Utils.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ public struct Utils
public static string jammerPath = Environment.GetFolderPath(Environment.SpecialFolder.UserProfile) + "\\jammer\\";
public static bool isDebug = false;
public static string currentPlaylist = "";
public static string version = "1.1.7";
public static string version = "1.1.8";
}
}

0 comments on commit 4fc7717

Please sign in to comment.