Learn KeyCL
On this page, you can learn KeyCL and everything about it. Including:
- The
keyclsoundmarkup language - How to make KeyCL sounds
- How to publish KeyCL sounds
- How to use KeyCL
And more..
You can skip to a section using the sidebar.
Please note: Throughout this guide, a sound may be referred to as a song. They both mean the same thing in this sheet unless a clear difference is made (such as saying that you should use a sound instead of a long song).
The keyclsound markup language is a markup language spespifically designed for KeyCL to store sound metadata for the online sound store. It is very easy to learn, use and understand. In KeyCL v2, this lanugage will get a revamp adding more features like certain sounds for certain keys. Here is a guide on how to learn it.
The title: tag, commonly found at the top of a keyclsound file, is used to set the song's name in the online song viewer. This is recommended since otherwise, without the tag, our engine automatically shows it as "Untitled Song". You can use it like this
title: Sticky keyboard honey
The author: tag, mostly found below the title: tag, is used to show the author of the sound and give credit to them. A separate tag will be coming in v2 which will let you show who imported the song into KeyCL but for now just put a / then your (preferably github) name to show that it was in KeyCL with help from both people. An example of this tag is below and this tag is required.
author: The Sound Creator/The Sound Importer
The description: tag is not used or required currently since there is a bug where the description does not show up in the KeyCL viewer and does not change search indexing results. This will be fixed eventually (by or before v2). You use it like this
description: A sticky-like keyboard sound like the ones in those fake AI honey keyboard videos
The 'tags:` tag is used for displaying short hints of what the sound is about and what it is related to. In the online song browser it is shown next to the author. It is required and you can use it like this:
tags: sticky, honey, crisp, meme, ai
The url: tag is used to show where the song download URL is. In the future, there will be multiple download URLs when we implement different sounds for different keys. It is required and right now, you can use it like this:
url: https://mysound.url/mysound.mp3
That is not a trusted url. It is an example url. You will be at fault for going to it.
By default, to keep every keyclsound file on the repo with a unique name, we give them each a random 8 digit number. We advise you do this aswell if you are submitting a pull request to the repo with keyclsound files. Otherwise, your PR will be rejected.
You only need to make a keyclsound file if you are submitting a pull request since if you are only submitting 1-3 keyclsound files then we have a editor basically pre-made. You can see how to use it in the how to make/publish KeyCL sounds. The same goes for how to do more than 3 or how to make a keyclsound file.
Now is the time we put all of this together into a file. So first, lets make a name.
53723189.keyclsound - Ahh yes perfect for submitting a Pull Request since it is an 8 digit number followed by the keyclsound file extension!
Now, what are we going to put in our file? Oh wait! The tags we learned earlier. We will make a honey keyboard sound (although I hate them). Lets get to it!
title: Sticky keyboard honey
First we get our title tag..
author: The Sound Creator/The Sound Importer
Then our author tag..
description: A sticky-like keyboard sound like the ones in those fake AI honey keyboard videos
Then our description tag..
tags: sticky, honey, crisp, meme, ai
Then our tags.. This is going well so far!!
url: https://mysound.url/mysound.mp3
And finally our URL tag! This is perfect! Now to combine them into one file..
title: Sticky keyboard honey
author: The Sound Creator/The Sound Importer
description: A sticky-like keyboard sound like the ones in those fake AI h## oney keyboard videos
tags: sticky, honey, crisp, meme, ai
url: https://mysound.url/mysound.mp3
And you have made your file!! Well done (this one doesn't download anything)!!
This covers how to make a KeyCL sound file including what you may have to do for it.
Your sound link
You will need a link to your sound. This can be via a service such as MyInstants (Recommended)To get a sound link from MyInstants, go to your sound on MyInstants then right click on the download button and select copy link address as shown below.
(The menu pops up when right clicking the download mp3 button).
Alternatively, you can use another sound service but it must be a link to the raw file (ending with the file extension, such as .mp3, .wav, .ogg). We only support mp3s, wavs and oggs.
A GitHub Account
You will need a GitHub account if you want to put your sound on the KeyCL online library or give credit to yourself.Your sound details
You will need to know your sound's title, author, your github username, tags (you can make these up), description (only used in v2+) and raw download url as shown in the spoiler above. These details will be checked.(Hint: To open a spoiler click on the arrow to see more information)
Make sure you have a code editor or notepad. (We recommend Visual Studio Code)
Make sure you have also followed the guide on learning the language.
First, create a new file. If you are in visual studio code, open a folder then right click on your explorer on the left and click new file. Then name it an 8 digit random number followed by the .keyclsound file extension. Then just create it using the knowledge you learnt previously about the KeyCL Markup language and save it. You are done!
This section will go over everything you need to know about publishing and the 2 methods
We have (sort of) made a KeyCL editor. You can access it via creating a new issue and selecting keyclsound. Make sure to put ``` before and after your code separated by a line break. It should look like this:
`` (an extra one messes up the formatting here. add an extra one in your self when you make your submission
Your code
``
. This creates a code block, making it easier for our team to see your code. After this, just create the issue and our team will try and implement it.
To submit a large ammount of files, you have to create a pull request. This can be done by forking the repository (do it by pressing here) then making your edits on that new repository that you own. After this, go to the pull requests tab and create a new one. Make sure for it to be from the branch you are working on on your repository to this repository when you press new pull request. It should look like this.
Once you have done that, success! Your request has been sent to our team. You may get questions so please check your emails (questions are rare though).
- You need a GitHub account to publish
- You must not have any suspicious activity to publish
- All files will be checked before publishing, by us
- This repository is regularly code scanned
- Editing the python file is not allowed for publishing, it is for contributing
- All pull requests must have a valid name and description, same with issues
- If you are publishing via pull request or issue make sure it starts with
[PUB]so we know you want to publish - You can not publish and contribute in the same pull request
- You cannot submit an issue inside a issue that you are publishing from
For now.. It WILL be updated in the future. To know how to use KeyCL. Its simple. Look at the UI also if you right click the tray icon in your system tray then it opens up the KeyCL tray menu.
