# VALORANT kill sounds
An API for VALORANT's skin custom kill sound.
## Installation
Install valorant-killsound with pip
```bash
pip install valorant-killsound
```
## Usage
To use the API, you will need to import the `qing762` class from the module and create an instance of the class.
```python
import valorant-killsound
from valorant-killsound import qing762 as val
h = val()
```
## Features
The qing762 class includes the following function:
`Return_Successive_Kill(skinname)`: Retrieves the custom successive kill sound link for the specified skin.
`Return_1_Kill(skinname)`: Retrieves the custom first kill sound link for the specified skin.
`Return_2_Kill(skinname)`: Retrieves the custom second kill sound link for the specified skin.
`Return_3_Kill(skinname)`: Retrieves the custom third kill sound link for the specified skin.
`Return_4_Kill(skinname)`: Retrieves the custom fourth kill sound link for the specified skin.
`Return_5_Kill(skinname)`: Retrieves the custom fifth kill sound link for the specified skin.
`Return_6_Kill(skinname)`: Retrieves the custom sixth kill sound link for the specified skin.
`Return_All_Kill(skinname, type)`: Retrieves all of the custom kill sound links for the specified skin, including the successive kill sound.
### Here is a detailed information of some of the functions in it:
#### Return_Successive_Kill(skinname: str)
The Return_Succesive_Kill is a function is a tool that retrieves the custom successive kill sound link for a given skin name. The function accepts a single parameter, "skinname," which should be a string representing the name of the desired skin. The function is case-insensitive, meaning that it will treat "SKINNAME" and "skinname" as equivalent.
Upon execution, the function will return a link to the successive kill sound for the specified skin. If the skin does not exist or does not have a custom kill sound, the function will return "None" instead.
Here is an example of how to use the "Return_Successive_Kill" function:
```python
# Import the qing762 class from the ValorantKillSounds module
from valorant-killsound import qing762 as val
# Create an instance of the qing762 class
h = val()
# Retrieve the link for the custom kill sound (successive) of the Sovereign skin
output = h.Return_Successive_Kill("Sovereign")
# Print the output
print(output)
```
#### Return_1_Kill(skinname: str)
The Return_1_Kill is a function that retrieves the custom first kill sound link for a given skin name. The function takes a single parameter, skinname, which is the name of the skin for which you want to retrieve the custom first kill sound link. The skin name should be a string and is case-insensitive.
It would returns a link for the first kill sound of the particular skin. If the skin does not exist or it doesn't have a custom kill sound, it would return None instead.
Here is an example of how you can use the Return_1_Kill function:
```python
# Import the qing762 class from the ValorantKillSounds module
from valorant-killsound import qing762 as val
# Create an instance of the qing762 class
h = val()
# Retrieve the link for the custom kill sound (1 kill) of the Sovereign skin
output = h.Return_1_kill("Sovereign")
# Print the output
print(output)
```
The concept of "Return_1_Kill" to "Return_6_Kill" works the same.
#### Return_All_Kill(skinname: str, type: str)
This function allows you to retrieve the links for all of the custom kill sounds of a particular skin in Valorant. The function accepts a skinname parameter, which specifies the name of the skin for which you want to retrieve the links. It also accepts an optional type parameter, which specifies the format in which you want the output to be returned. If the type parameter is not specified, the default output format is a JSON object.
The function returns a JSON object containing the links for all of the custom kill sounds, including the successive kill sound effect. The keys of the dictionary are successive_kill, 1_kill, 2_kill, 3_kill, 4_kill, 5_kill, and 6_kill, which correspond to the successive kill sound and six of the kill sounds, respectively. If the skin was not found or the skin doesn't have a custom kill sound, the value for that particular sound will be None.
If the type parameter is set to `string` or `str`, the function will return the output as a string.
For example, you can call the function as follows:
Simple mode:
```python
# Import the qing762 class from the ValorantKillSounds module
from valorant-killsound import qing762 as val
# Create an instance of the qing762 class
h = val()
# Retrieve the link for the custom kill sound (1 kill) of the Sovereign skin
output = h.Return_All_Kill("Sovereign")
# Print the output
print(output)
```
Advanced mode:
```python
# Import the qing762 class from the ValorantKillSounds module
from valorant-killsound import qing762 as val
# Create an instance of the qing762 class
h = val()
# Retrieve the link for the custom kill sound (1 kill) of the Sovereign skin
output = h.Return_All_Kill("Sovereign", type="str")
# Print the output
print(output)
```
## Roadmap
The API development roadmap includes the following tasks:
- [ ] Implement an API that returns all of the results in a JSON object, similar to the Honor of Kings API
- [ ] Add additional functions to the API
- [ ] Integrate [Valorant-API](https://valorant-api.com/) into the current API development roadmap
## Usage
Here is a sample list that you can use the module as a starting point:
- Discord bot development
- Web development
- App development
You are free to use the module as you wish, but please remember to adhere to the terms of the [MIT License](https://github.com/qing762/valorant_killsound/blob/main/LICENSE).
## FAQ
#### Q: Is the API free to use?
Yes, the API is free to use.
#### Q: Can I use the API for commercial purposes?
Yes, you can use the API for commercial purposes as long as you follow the terms of the [MIT License](https://github.com/qing762/valorant_killsound/blob/main/LICENSE).
#### Q: How do I report a bug or request a feature?
You can report a bug or request a feature by [opening an issue on the GitHub repository](https://github.com/qing762/valorant_killsound/issues).
#### Q: How do I contribute to the project?
You can fork the project and open a pull request.
#### Q: Can I use the API offline?
No, the API requires an active Internet connection to function. It makes HTTP requests to retrieve the skin kill sound links.
## Acknowledgements
I would like to thank the following individuals or organizations for their contribution to the project:
- [Valorant Wiki](https://valorant.fandom.com/) for providing the audios files for every weapon skins.
## License
This API is licensed under the MIT License. See [LICENSE](https://github.com/qing762/valorant_killsound/blob/main/LICENSE) for more information.
## Authors
- [@qing762](https://www.github.com/qing762)
Raw data
{
"_id": null,
"home_page": "https://github.com/qing762/valorant_killsound",
"name": "valorant-killsound",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,api,python wrapper,valorant,valorant-api,valorant api,piu piu game,sound effects,reaver,sovereign,ion,prime,kill sound,valorant gun skins",
"author": "qing762",
"author_email": "threatedblade@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/8a/00/c848660cd28f2468e6797731c36f023804f10782409410254a46a646624b/valorant-killsound-0.0.3.tar.gz",
"platform": null,
"description": "\r\n\r\n\r\n# VALORANT kill sounds\r\n\r\n\r\n\r\nAn API for VALORANT's skin custom kill sound.\r\n\r\n\r\n\r\n\r\n\r\n## Installation\r\n\r\n\r\n\r\nInstall valorant-killsound with pip\r\n\r\n\r\n\r\n```bash\r\n\r\n pip install valorant-killsound\r\n\r\n```\r\n\r\n \r\n\r\n## Usage\r\n\r\n\r\n\r\nTo use the API, you will need to import the `qing762` class from the module and create an instance of the class.\r\n\r\n\r\n\r\n```python\r\n\r\nimport valorant-killsound\r\n\r\nfrom valorant-killsound import qing762 as val\r\n\r\n\r\n\r\nh = val()\r\n\r\n```\r\n\r\n\r\n\r\n\r\n\r\n## Features\r\n\r\n\r\n\r\nThe qing762 class includes the following function:\r\n\r\n\r\n\r\n`Return_Successive_Kill(skinname)`: Retrieves the custom successive kill sound link for the specified skin.\r\n\r\n\r\n\r\n`Return_1_Kill(skinname)`: Retrieves the custom first kill sound link for the specified skin.\r\n\r\n\r\n\r\n`Return_2_Kill(skinname)`: Retrieves the custom second kill sound link for the specified skin.\r\n\r\n\r\n\r\n`Return_3_Kill(skinname)`: Retrieves the custom third kill sound link for the specified skin.\r\n\r\n\r\n\r\n`Return_4_Kill(skinname)`: Retrieves the custom fourth kill sound link for the specified skin.\r\n\r\n\r\n\r\n`Return_5_Kill(skinname)`: Retrieves the custom fifth kill sound link for the specified skin.\r\n\r\n\r\n\r\n`Return_6_Kill(skinname)`: Retrieves the custom sixth kill sound link for the specified skin.\r\n\r\n\r\n\r\n`Return_All_Kill(skinname, type)`: Retrieves all of the custom kill sound links for the specified skin, including the successive kill sound.\r\n\r\n\r\n\r\n\r\n\r\n### Here is a detailed information of some of the functions in it:\r\n\r\n#### Return_Successive_Kill(skinname: str)\r\n\r\nThe Return_Succesive_Kill is a function is a tool that retrieves the custom successive kill sound link for a given skin name. The function accepts a single parameter, \"skinname,\" which should be a string representing the name of the desired skin. The function is case-insensitive, meaning that it will treat \"SKINNAME\" and \"skinname\" as equivalent.\r\n\r\n\r\n\r\nUpon execution, the function will return a link to the successive kill sound for the specified skin. If the skin does not exist or does not have a custom kill sound, the function will return \"None\" instead.\r\n\r\n\r\n\r\nHere is an example of how to use the \"Return_Successive_Kill\" function:\r\n\r\n```python\r\n\r\n# Import the qing762 class from the ValorantKillSounds module\r\n\r\nfrom valorant-killsound import qing762 as val\r\n\r\n\r\n\r\n# Create an instance of the qing762 class\r\n\r\nh = val()\r\n\r\n\r\n\r\n# Retrieve the link for the custom kill sound (successive) of the Sovereign skin\r\n\r\noutput = h.Return_Successive_Kill(\"Sovereign\")\r\n\r\n\r\n\r\n# Print the output\r\n\r\nprint(output)\r\n\r\n```\r\n\r\n\r\n\r\n#### Return_1_Kill(skinname: str)\r\n\r\nThe Return_1_Kill is a function that retrieves the custom first kill sound link for a given skin name. The function takes a single parameter, skinname, which is the name of the skin for which you want to retrieve the custom first kill sound link. The skin name should be a string and is case-insensitive.\r\n\r\n\r\n\r\nIt would returns a link for the first kill sound of the particular skin. If the skin does not exist or it doesn't have a custom kill sound, it would return None instead.\r\n\r\n\r\n\r\nHere is an example of how you can use the Return_1_Kill function:\r\n\r\n\r\n\r\n```python\r\n\r\n# Import the qing762 class from the ValorantKillSounds module\r\n\r\nfrom valorant-killsound import qing762 as val\r\n\r\n\r\n\r\n# Create an instance of the qing762 class\r\n\r\nh = val()\r\n\r\n\r\n\r\n# Retrieve the link for the custom kill sound (1 kill) of the Sovereign skin\r\n\r\noutput = h.Return_1_kill(\"Sovereign\")\r\n\r\n\r\n\r\n# Print the output\r\n\r\nprint(output)\r\n\r\n```\r\n\r\nThe concept of \"Return_1_Kill\" to \"Return_6_Kill\" works the same.\r\n\r\n\r\n\r\n#### Return_All_Kill(skinname: str, type: str)\r\n\r\nThis function allows you to retrieve the links for all of the custom kill sounds of a particular skin in Valorant. The function accepts a skinname parameter, which specifies the name of the skin for which you want to retrieve the links. It also accepts an optional type parameter, which specifies the format in which you want the output to be returned. If the type parameter is not specified, the default output format is a JSON object.\r\n\r\n\r\n\r\nThe function returns a JSON object containing the links for all of the custom kill sounds, including the successive kill sound effect. The keys of the dictionary are successive_kill, 1_kill, 2_kill, 3_kill, 4_kill, 5_kill, and 6_kill, which correspond to the successive kill sound and six of the kill sounds, respectively. If the skin was not found or the skin doesn't have a custom kill sound, the value for that particular sound will be None.\r\n\r\n\r\n\r\nIf the type parameter is set to `string` or `str`, the function will return the output as a string.\r\n\r\n\r\n\r\nFor example, you can call the function as follows:\r\n\r\n\r\n\r\nSimple mode:\r\n\r\n```python\r\n\r\n# Import the qing762 class from the ValorantKillSounds module\r\n\r\nfrom valorant-killsound import qing762 as val\r\n\r\n\r\n\r\n# Create an instance of the qing762 class\r\n\r\nh = val()\r\n\r\n\r\n\r\n# Retrieve the link for the custom kill sound (1 kill) of the Sovereign skin\r\n\r\noutput = h.Return_All_Kill(\"Sovereign\")\r\n\r\n\r\n\r\n# Print the output\r\n\r\nprint(output)\r\n\r\n```\r\n\r\n\r\n\r\nAdvanced mode:\r\n\r\n```python\r\n\r\n# Import the qing762 class from the ValorantKillSounds module\r\n\r\nfrom valorant-killsound import qing762 as val\r\n\r\n\r\n\r\n# Create an instance of the qing762 class\r\n\r\nh = val()\r\n\r\n\r\n\r\n# Retrieve the link for the custom kill sound (1 kill) of the Sovereign skin\r\n\r\noutput = h.Return_All_Kill(\"Sovereign\", type=\"str\")\r\n\r\n\r\n\r\n# Print the output\r\n\r\nprint(output)\r\n\r\n```\r\n\r\n## Roadmap\r\n\r\n\r\n\r\nThe API development roadmap includes the following tasks:\r\n\r\n\r\n\r\n- [ ] Implement an API that returns all of the results in a JSON object, similar to the Honor of Kings API\r\n\r\n\r\n\r\n- [ ] Add additional functions to the API\r\n\r\n\r\n\r\n- [ ] Integrate [Valorant-API](https://valorant-api.com/) into the current API development roadmap\r\n\r\n\r\n\r\n\r\n\r\n## Usage\r\n\r\n\r\n\r\nHere is a sample list that you can use the module as a starting point:\r\n\r\n\r\n\r\n- Discord bot development\r\n\r\n- Web development\r\n\r\n- App development\r\n\r\n\r\n\r\nYou are free to use the module as you wish, but please remember to adhere to the terms of the [MIT License](https://github.com/qing762/valorant_killsound/blob/main/LICENSE).\r\n\r\n\r\n\r\n## FAQ\r\n\r\n\r\n\r\n#### Q: Is the API free to use?\r\n\r\n\r\n\r\nYes, the API is free to use.\r\n\r\n\r\n\r\n#### Q: Can I use the API for commercial purposes?\r\n\r\n\r\n\r\nYes, you can use the API for commercial purposes as long as you follow the terms of the [MIT License](https://github.com/qing762/valorant_killsound/blob/main/LICENSE).\r\n\r\n\r\n\r\n#### Q: How do I report a bug or request a feature?\r\n\r\nYou can report a bug or request a feature by [opening an issue on the GitHub repository](https://github.com/qing762/valorant_killsound/issues).\r\n\r\n\r\n\r\n#### Q: How do I contribute to the project?\r\n\r\nYou can fork the project and open a pull request.\r\n\r\n\r\n\r\n#### Q: Can I use the API offline?\r\n\r\nNo, the API requires an active Internet connection to function. It makes HTTP requests to retrieve the skin kill sound links.\r\n\r\n## Acknowledgements\r\n\r\n\r\n\r\nI would like to thank the following individuals or organizations for their contribution to the project:\r\n\r\n\r\n\r\n - [Valorant Wiki](https://valorant.fandom.com/) for providing the audios files for every weapon skins.\r\n\r\n\r\n\r\n\r\n\r\n## License\r\n\r\n\r\n\r\nThis API is licensed under the MIT License. See [LICENSE](https://github.com/qing762/valorant_killsound/blob/main/LICENSE) for more information.\r\n\r\n\r\n\r\n\r\n\r\n## Authors\r\n\r\n\r\n\r\n- [@qing762](https://www.github.com/qing762)\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "An API for piu piu game.",
"version": "0.0.3",
"split_keywords": [
"python",
"api",
"python wrapper",
"valorant",
"valorant-api",
"valorant api",
"piu piu game",
"sound effects",
"reaver",
"sovereign",
"ion",
"prime",
"kill sound",
"valorant gun skins"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "3e0f8925836876676c7bc75d42c559a7",
"sha256": "a5d0f93cbda5926dea075d3267e6ad6586c64ea33b839d7255804a8b4c49e6cd"
},
"downloads": -1,
"filename": "valorant_killsound-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e0f8925836876676c7bc75d42c559a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8988,
"upload_time": "2022-12-28T16:53:39",
"upload_time_iso_8601": "2022-12-28T16:53:39.079207Z",
"url": "https://files.pythonhosted.org/packages/e0/35/f3a9e8c2efc554e61701a1a1d2a4a08ea09c636f34cff24908513162ffa4/valorant_killsound-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "70246cf19ddfc2e04fae48043f3f099c",
"sha256": "17b91a0818766e93204f9ea18eedc1a39c0e002ae959963b04582116a1db0716"
},
"downloads": -1,
"filename": "valorant-killsound-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "70246cf19ddfc2e04fae48043f3f099c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6221,
"upload_time": "2022-12-28T16:53:41",
"upload_time_iso_8601": "2022-12-28T16:53:41.163589Z",
"url": "https://files.pythonhosted.org/packages/8a/00/c848660cd28f2468e6797731c36f023804f10782409410254a46a646624b/valorant-killsound-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-28 16:53:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "qing762",
"github_project": "valorant_killsound",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "valorant-killsound"
}
JSON
