Skip to content

Commit

Permalink
update .md files
Browse files Browse the repository at this point in the history
  • Loading branch information
BeatACVR authored Dec 1, 2024
2 parents 32a3237 + 9ca9ba2 commit e2b91d8
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 9 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# Click Sounds Lite
The click sounds mod, but without the default click sound library and some other features.
To use this, you'll need to select a sound file in the mod settings, otherwise it won't work.

### About
This is Click Sounds Lite. A mod made to be a lighter version of [Click Sounds](https://github.com/clicksounds/geode-clicksound).
Lite discludes some features from the full version of Click Sounds, such as the built-in sound library.

### Contact Us
Feel free to contact developers in our [discord server](https://discord.gg/RwbRP8ADdc) or raise an [issue](https://github.com/clicksounds/geode-clicksoundslite/issues) if there are any bugs.

## Github

### General Information
[![Static Badge](https://img.shields.io/badge/status-in_development-white)]()\
[![Static Badge](https://img.shields.io/badge/version-v1.0.6-white)]()\
[![Language](https://img.shields.io/badge/languages-C++,_CMake-white)](https://isocpp.org/)

### Activity

[![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/clicksounds/geode-clicksoundslite?color=white)](https://github.com/clicksounds/geode-clicksoundslite/commits/)\
[![Last Commit](https://img.shields.io/github/last-commit/clicksounds/geode-clicksoundslite?color=white)](https://github.com/clicksounds/geode-clicksoundslite/commits/)

### Issues and PRs
[![PR](https://img.shields.io/github/issues-pr/clicksounds/geode-clicksoundslite?color=white)](https://github.com/clicksounds/geode-clicksoundslite/pulls)\
[![Issues](https://img.shields.io/github/issues/clicksounds/geode-clicksoundslite?color=white)](https://github.com/clicksounds/geode-clicksoundslite/issues)
6 changes: 3 additions & 3 deletions about.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Click Sounds Lite
## The Node IDs mod is **REQUIRED** for Click Sounds Lite to work.
The click sounds mod, but without the default click sound library and some other features.
To use this, you'll need to select a sound file in the mod settings, otherwise it won't work.
This is the click sounds mod, except without the default click sound library and some other features.\
To use this, you'll need to select a sound file in the mod settings, otherwise it won't work.\
There are many other features that can be found in the mod settings.\
6 changes: 3 additions & 3 deletions mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"id": "beat.click_sounds_lite",
"name": "Click Sounds Lite",
"developers": ["Beat", "Dwang-ML"],
"description": "A lighter version of click sounds",
"description": "A lighter version of click sounds.",
"resources": {
"files": [
"resources/**/*.ogg",
Expand All @@ -20,7 +20,7 @@
]
},
"links": {
"community": "https://discord.gg/tu98bsGA32",
"community": "https://discord.gg/tu98bsGA32",
"source": "https://github.com/clicksounds/geode-clicksoundslite"
},
"tags": [
Expand Down Expand Up @@ -85,7 +85,7 @@
},
"only-on-jump": {
"name": "Only play on jump",
"description": "Doesn't play sound on movement of platformer keys",
"description": "Doesn't play sound on movement of platformer keys.",
"type": "bool",
"default": true
},
Expand Down
2 changes: 1 addition & 1 deletion support.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Join the [discord server](https://discord.gg/RwbRP8ADdc) for support.
Join the [discord server](https://discord.gg/RwbRP8ADdc) for support.

0 comments on commit e2b91d8

Please sign in to comment.