chore: update README to archived
This commit is contained in:
44
README.md
44
README.md
@@ -1,43 +1,9 @@
|
|||||||
# Tetri5 - Multiplayer Websocket Backend
|
# tetri5-backend (ARCHIVED)
|
||||||
[](https://lgtm.com/projects/g/gio101046/tetri5-backend/alerts/)
|
|
||||||
[](https://lgtm.com/projects/g/gio101046/tetri5-backend/context:python)
|
|
||||||
|
|
||||||
This repository is the backend of the multiplayer portion of the [Tetri5](https://github.com/gio101046/tetri5) game client. It uses the python `websockets` library to allow game clients to connect and communicate in real time.
|
🚨 **This repository has been moved and merged into a new repository.** 🚨
|
||||||
|
|
||||||
## Run Locally
|
The backend code for `tetri5` now lives in the unified [tetri5 repository](https://gitea.redturtle.foo/crayonix/tetri5).
|
||||||
|
|
||||||
Use [pip](https://pip.pypa.io/en/stable/) package manager to install the required dependencies:
|
Please refer to that repository for the latest code, development, and issue tracking.
|
||||||
|
|
||||||
```bash
|
This repository is no longer maintained and is preserved for historical reference only.
|
||||||
pip install -r requirements.txt
|
|
||||||
```
|
|
||||||
|
|
||||||
From your terminal move to the root of the project and run the following line:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python main.py
|
|
||||||
```
|
|
||||||
|
|
||||||
In some systems you may need to run this instead:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python3 main.py
|
|
||||||
```
|
|
||||||
|
|
||||||
## Deploy
|
|
||||||
|
|
||||||
This backend can be deployed using Heroku. Download and install the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-command-line) and run the following commands:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
> heroku login
|
|
||||||
> heroku create
|
|
||||||
> git push heroku main
|
|
||||||
> heroku ps:scale web=1
|
|
||||||
> heroku open
|
|
||||||
```
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
|
||||||
|
|
||||||
## License
|
|
||||||
[MIT](https://choosealicense.com/licenses/mit/)
|
|
||||||
|
|||||||
Reference in New Issue
Block a user