Skip to content

README.md

Latest commit

 

History

History
32 lines (27 loc) · 1.28 KB

README.md

File metadata and controls

32 lines (27 loc) · 1.28 KB

AyuScript Client

This is a script aimed to enhance the experience of game florr.io with zero injection to canvas APIs.

How to use

For users

Requirement

Tampermonkey installed on your browser

Install

You should install our script from official website to get a best experience.

For developers

Requirement

  • Node.js 18 or newer
  • Yarn
  • protoc

Develop

  • Run yarn run proto:generate to compile the protocol buffers.
  • Run yarn run dev to start the development server.
  • Don't forget to run a server from this GitHub repository or write one by yourself, or only partial functionalities can be enabled.

Build

  • Create a .env.production file, with the same format as .env.development
  • Run yarn run proto:generate to compile the protocol buffers.
  • Run yarn run build to build the script.

Contributions

Contributions are welcome! Whether you are fixing bugs, suggesting new features, or even refactoring, we appreciate your help.

To ensure quality of this project, we do not accept pull requests or issues generated by Large Language Models.

License

This project is licensed under the AGPL-3.0 License. Specially, the license of electron/ is MIT License.