README.md

growtopia.py

Warning

Growtopia.py is still unfinished and is not ready for proper-project use. It is advised to not expect any stability from this project until it reaches a stable release (>=v0.1.6)

A simple asynchronous API for Growtopia, capable of creating servers, clients, and more!

Installation

Requirements

• Python 3.8 or above
• PyENet (If installing growtopia.py from PyPI)

Installing from source

1. Clone the repository.
2. Open a terminal in the repository's directory
3. Install it using pip.

git clone https://github.com/kaJob-dev/growtopia.py.git
cd growtopia.py

pip(3) install -U .

Installing from PyPI

Please do note that installing growtopia.py from PyPI will require you to install PyENet yourself, as PyPI does not support direct dependencies. This'll be resolved in the future by simply having PyENet available in PyPI too.

pip(3) install growtopia.py

---

Contributing

All contributions are welcome! If you'd like to contribute, please make a pull request.

Please make sure that your code is formatted correctly before making a new pull request. This project is formatted using black and isort to sort imports. Read through open and closed pull requests and ensure that no one else has already made a similar pull request.

To install and format your code using black and isort, run the following commands:

pip(3) install black
pip(3) install isort

black ./growtopia
isort ./growtopia

License

This project is licensed under the MIT License - see the LICENSE file for details.

Thanks to

• RebillionXX - For their open-source Growtopia server, which helped with the development of this project.