Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mntone/shake-streamkit
Display realtime information from Salmon Run Next Wave
https://github.com/mntone/shake-streamkit
browser game nintend-switch nintendo salmonrun salmonrun-nextwave telemetry typescript websocket websocket-client
Last synced: about 2 months ago
JSON representation
Display realtime information from Salmon Run Next Wave
- Host: GitHub
- URL: https://github.com/mntone/shake-streamkit
- Owner: mntone
- License: gpl-3.0
- Created: 2024-05-31T09:33:05.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-31T09:13:31.000Z (6 months ago)
- Last Synced: 2024-11-05T13:26:37.289Z (3 months ago)
- Topics: browser, game, nintend-switch, nintendo, salmonrun, salmonrun-nextwave, telemetry, typescript, websocket, websocket-client
- Language: TypeScript
- Homepage:
- Size: 2.19 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-en.md
- License: LICENSE
Awesome Lists containing this project
README
English | [日本語](//github.com/mntone/shake-streamkit/blob/main/README.md)
# Shake StreamKit
Shake StreamKit is an overlay tool designed for streamers and video producers to display realtime information from the Salmon Run game mode in the popular Nintendo Switch video game “Splatoon 3.”
## Table of contents
* [Features](#features)
* [Installation](#installation)
* [Usage](#usage)
* [Contribution](#contribution)
* [License](#license)
* [Contact](#contact)
* [Acknowledgments](#acknowledgments)
* [Author](#author)
* [Related Projects](#related_projects)
## Features
- **Realtime Visualization**: Shake StreamKit receives telemetry via WebSocket from ShakeScouter and shows detailed information on your stream.
- **User-Friendly**: Shake StreamKit has a user-friendly UI.
## Installation
Clone the project repository and install dependencies.
```bash
git lfs clone https://github.com/mntone/shake-streamkit.git
cd shake-streamkit
npm install
```
## Usage
Start the development server to run the project.
```bash
npm start
```
Access the tool in your browser at:
```
http://localhost:5173
```
## Contribution
Contributions are welcome! Feel free to submit bug reports, feature requests, and pull requests.
1. Fork the project: https://github.com/mntone/shake-streamkit/fork
2. Create your feature branch.
`git checkout -b feature/your-new-feature`
3. Commit your changes.
`git commit -m 'Adds feat with your new features'`
4. Push to the branch.
5. Open a pull request.
## License
This project is licensed under the GPLv3 license - see the [LICENSE](//github.com/mntone/shake-streamkit/blob/main/LICENSE) file for details.
## Contact
If you have any questions or need support, please contact me.
- Mastodon: https://mstdn.jp/@mntone
## Acknowledgments
- My heartfelt thanks go out to the creators of the original game, “Splatoon 3.”
- I would like to express my gratitude to [erudot](https://x.com/erudot). He provided me with the opportunity to play Salmon Run Next Wave and became the catalyst for reaching Eggsecutive VP 999.
- Also, I would like to express my heartfelt gratitude to ChatGPT for its support in the development of this software.
## Author
- mntone - Initial work.
## Related Projects
- [ShakeScouter](//github.com/mntone/ShakeScouter): Analyze "Salmon Run Next Wave" and generate telemetry