Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
VixidDev committed Jun 17, 2024
1 parent d2676af commit 70109a8
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<h1 align="center">VSM</h1>
<h3 align="center">Vixid's Skyblock Mod</h3>

<div align="center">
<a href="https://github.com/VixidDev/VSM/releases/latest">
<img src="https://img.shields.io/github/v/release/VixidDev/VSM?color=informational&include_prereleases&label=release&logo=github&logoColor=white" alt="release">
</a>
<a href="LICENSE" target="_blank">
<img src="https://img.shields.io/github/license/VixidDev/VSM?color=informational" alt="license">
</a>
</div>

VSM is a personal Minecraft mod of mine with the purpose of adding QOL features that I
want, that don't really fit in any widely distributed mod.

This mod was not made with the intention of other people using it, and its existence
on GitHub is solely for hosting the project somewhere and using version control.
However, if you find this mod adds a feature / features that you also want from a mod,
you are welcome to download and use the mod yourself.

Currently, there exists a 1.8.9 Forge version and a 1.20.6 Fabric version. The same
features should exist in both version unless some limitation arises that causes a
feature to not be worth implementing in one of the versions.

## Features

<details>
<summary>Spotify Display</summary>

Works by reading the window title of the Spotify desktop client
* Shows the current song artist and title in game
* Can control the song using keybinds set in the config
* Posts a chat message whenever a song changes
> Currently uses powershell commands to query the window title so this will only work
on Windows devices
</details>

0 comments on commit 70109a8

Please sign in to comment.