https://github.com/BlossomiShymae/Needlework

🪡 A helper development tool for the LCU!
https://github.com/BlossomiShymae/Needlework

lcu lcu-api

Last synced: 3 months ago
JSON representation

🪡 A helper development tool for the LCU!

• Host: GitHub
• URL: https://github.com/BlossomiShymae/Needlework
• Owner: BlossomiShymae
• License: mit
• Created: 2023-06-21T01:01:46.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-02T00:10:55.000Z (3 months ago)
• Last Synced: 2024-04-03T01:04:25.082Z (3 months ago)
• Topics: lcu, lcu-api
• Language: Vue
• Homepage:
• Size: 9.78 MB
• Stars: 17
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-league - Needlework - A helper development tool and explorer for the LCU. (Developer Tools)

README

        
# Needlework

Needlework is an open-source helper tool for the LCU that provides documented endpoints and can send requests without any code setup. Created using Nuxt and Tauri! 🌠

## Download

[Needlework can be downloaded from the latest release! Currently for Windows only.](https://github.com/BlossomiShymae/Needlework/releases)

## Contributors



  



## Preview

![App preview](app-preview.gif)

## Development

Rust for tauri depends on nightly toolchain.

Install packages:

`npm i`

Run tauri in development:

`npm run tauri dev`

Compile installer:

`npm run tauri build`

## Limitations

- WebSocket viewer cannot reconnect to the League client if the client is restarted. The Restart Application button can be used as a workaround for now. c:

## Credits

### irelia

An LCU binding crate created by AlsoSylv. This application wouldn't be possible without her work as it made development totes easier. Thank you once again! 💜

- [Repository](https://github.com/AlsoSylv/Irelia)

- [crates.io](https://crates.io/crates/irelia)

### LCU Explorer

This project was inspired by LCU Explorer, an application created by the HextechDocs team! 💚

- [Repository](https://github.com/HextechDocs/lcu-explorer)

### hasagi-types

Endpoints and schemas are provided by dysolix's [generated OpenAPI file.](https://raw.githubusercontent.com/dysolix/hasagi-types/main/swagger.json) Thank you!

- [Repository](https://github.com/dysolix/hasagi-types)

## Disclaimer

THE PROGRAM IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGMENT, OR OF FITNESS FOR A PARTICULAR PURPOSE. LICENSOR DOES NOT WARRANT THAT THE FUNCTIONS CONTAINED IN THE PROGRAM WILL MEET YOUR REQUIREMENTS OR THAT OPERATION WILL BE UNINTERRUPTED OR ERROR FREE. LICENSOR MAKES NO WARRANTIES RESPECTING ANY HARM THAT MAY BE CAUSED BY MALICIOUS USE OF THIS SOFTWARE. LICENSOR FURTHER EXPRESSLY DISCLAIMS ANY WARRANTY OR REPRESENTATION TO AUTHORIZED USERS OR TO ANY THIRD PARTY.

Needlework isn't endorsed by Riot Games and doesn't

reflect the views or opinions of Riot Games or anyone officially

involved in producing or managing Riot Games properties. Riot Games,

and all associated properties are trademarks or registered

trademarks of Riot Games, Inc.