shiroyashik/sculptor
1
0
Fork 0
mirror of https://github.com/shiroyashik/sculptor.git synced 2025-12-06 04:51:13 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Shiroyasha 2024-06-16 20:48:41 +03:00 • committed by GitHub
parent 393127570e
commit ca6990c5b1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 15 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -1,4 +1,6 @@
## The Sculptor # The Sculptor
[![Rust](https://github.com/shiroyashik/sculptor/actions/workflows/rust.yml/badge.svg?branch=master)](https://github.com/shiroyashik/sculptor/actions/workflows/rust.yml)
Unofficial backend V2 for the Minecraft mod [Figura](https://github.com/FiguraMC/Figura). Unofficial backend V2 for the Minecraft mod [Figura](https://github.com/FiguraMC/Figura).
@ -6,7 +8,9 @@ Implements Ping transmission functionality via Websocket and full avatar upload
And also a distinctive feature is the possibility of player identification through the third-party authorization system [Ely.By](https://ely.by/) And also a distinctive feature is the possibility of player identification through the third-party authorization system [Ely.By](https://ely.by/)
### Running with Docker ## Usage
### Docker
You will need an already configured Docker with Traefik (you can use any reverse proxy) You will need an already configured Docker with Traefik (you can use any reverse proxy)
@ -16,9 +20,10 @@ You will need an already configured Docker with Traefik (you can use any reverse
4. Open docker.compose.yml and uncomment the "labels" to work with Traefik and add the container to the network with Traefik. 4. Open docker.compose.yml and uncomment the "labels" to work with Traefik and add the container to the network with Traefik.
5. `docker compose up -d` this will build and run the container with 5. `docker compose up -d` this will build and run the container with
### Just running ### Native
Running this way you won't need WSL when running on Windows, but.... Running this way you won't need WSL when running on Windows, but....
To do this, you will need to reverse proxy port 6665 to your domain with SSL To do this, you will need to reverse proxy port 6665 to your domain with SSL
1. Create avatars folder (it will store player avatars) 1. Create avatars folder (it will store player avatars)
@ -26,13 +31,17 @@ To do this, you will need to reverse proxy port 6665 to your domain with SSL
3. Set up your reverse proxy server 3. Set up your reverse proxy server
4. `cargo run` 4. `cargo run`
### Public server > [!IMPORTANT]
> NGINX requires additional configuration to work with websocket!
## Public server
[![Server status](https://up.shsr.ru/api/badge/1/status?upLabel=Online&downLabel=Offline&label=Server+status)](https://up.shsr.ru/status/pub)
I'm keeping the public server running at the moment! I'm keeping the public server running at the moment!
You can use it if running your own Sculptor instance is difficult for you. You can use it if running your own Sculptor instance is difficult for you.
> figura.shsr.ru > figura.shsr.ru
For reasons beyond my control, the server is not available in some countries. For reasons beyond my control, the server is not available in some countries.
[Check server availability](https://figura.shsr.ru/health)